This is TheLogtalkHandbook-3.100.1.info, produced by makeinfo version
7.3 from TheLogtalkHandbook-3.100.1.texi.

     The Logtalk Handbook v3.100.1, May 16, 2026

     Paulo Moura

     Copyright © 1998-2026, Paulo Moura

INFO-DIR-SECTION Programming Languages
START-INFO-DIR-ENTRY
* The Logtalk Handbook: (TheLogtalkHandbook-3.100.1.info). Declarative object-oriented logic programming
                        language.
END-INFO-DIR-ENTRY


   Generated by Sphinx 7.4.7.


File: TheLogtalkHandbook-3.100.1.info,  Node: Top,  Next: User Manual,  Up: (dir)

The Logtalk Handbook
********************

     The Logtalk Handbook v3.100.1, May 16, 2026

     Paulo Moura

     Copyright © 1998-2026, Paulo Moura

* Menu:

* User Manual::
* Reference Manual::
* Tutorial::
* FAQ::
* Developer Tools::
* Libraries::
* Ports::
* Contributions::
* Glossary::
* Index: Index<2>.
* Index::

 -- The Detailed Node Listing --

User Manual

* Declarative object-oriented programming::
* Main features::
* Nomenclature::
* Messages::
* Objects::
* Protocols::
* Categories::
* Predicates::
* Inheritance::
* Event-driven programming::
* Multi-threading programming::
* Error handling::
* Reflection::
* Writing and running applications::
* Printing messages and asking questions::
* Term and goal expansion::
* Documenting::
* Debugging::
* Performance: Performance<2>.
* Installing Logtalk::
* Prolog integration and migration::

Main features

* Integration of logic and object-oriented programming::
* Integration of event-driven and object-oriented programming::
* Support for component-based programming::
* Support for both prototype and class-based systems::
* Support for multiple object hierarchies::
* Separation between interface and implementation::
* Private, protected and public inheritance: Private protected and public inheritance.
* Private, protected and public object predicates: Private protected and public object predicates.
* Parametric objects::
* High level multi-threading programming support::
* Smooth learning curve::
* Compatibility with most Prolog systems and the ISO standard::
* Performance::
* Logtalk scope::

Nomenclature

* Prolog nomenclature::
* Smalltalk nomenclature::
* C++ nomenclature::
* Java nomenclature::
* Python nomenclature::

Messages

* Operators used in message-sending::
* Sending a message to an object::
* Delegating a message to an object::
* Sending a message to self::
* Broadcasting::
* Calling imported and inherited predicates::
* Message sending and event generation::
* Sending a message from a module::
* Message sending performance::

Objects

* Objects, prototypes, classes, and instances: Objects prototypes classes and instances.
* Defining a new object::
* Parametric objects: Parametric objects<2>.
* Finding defined objects::
* Creating a new object at runtime::
* Abolishing an existing object::
* Object directives::
* Object relationships::
* Object properties::
* Built-in objects::
* Multi-threading applications::

Objects, prototypes, classes, and instances

* Prototypes::
* Classes::

Parametric objects

* Accessing object parameters::
* Parametric object proxies::

Object directives

* Object initialization::
* Dynamic objects::
* Object documentation::
* Loading files into an object::
* Declaring object aliases::

Built-in objects

* The built-in pseudo-object user::
* The built-in object logtalk::

Protocols

* Defining a new protocol::
* Finding defined protocols::
* Creating a new protocol at runtime::
* Abolishing an existing protocol::
* Protocol directives::
* Protocol relationships::
* Protocol properties::
* Implementing protocols::
* Built-in protocols::
* Multi-threading applications: Multi-threading applications<2>.

Protocol directives

* Dynamic protocols::
* Protocol documentation::
* Loading files into a protocol::

Built-in protocols

* The built-in protocol expanding::
* The built-in protocol monitoring::
* The built-in protocol forwarding::

Categories

* Defining a new category::
* Hot patching::
* Finding defined categories::
* Creating a new category at runtime::
* Abolishing an existing category::
* Category directives::
* Category relationships::
* Category properties::
* Importing categories::
* Calling category predicates::
* Parametric categories::
* Built-in categories::
* Multi-threading applications: Multi-threading applications<3>.

Category directives

* Dynamic categories::
* Category documentation::
* Loading files into a category::
* Declaring object aliases: Declaring object aliases<2>.

Built-in categories

* The built-in category core_messages::

Predicates

* Reserved predicate names::
* Declaring predicates::
* Defining predicates::
* Definite clause grammar rules::
* Built-in methods::
* Predicate properties::
* Finding declared predicates::
* Calling Prolog predicates::
* Defining Prolog multifile predicates::
* Asserting and retracting Prolog predicates::

Declaring predicates

* Scope directives::
* Mode directive::
* Meta-predicate directive::
* Discontiguous directive::
* Dynamic directive::
* Operator directive::
* Uses directive::
* Alias directive::
* Documenting directive::
* Multifile directive::
* Coinductive directive::
* Synchronized directive::

Defining predicates

* Object predicates::
* Category predicates::
* Meta-predicates::
* Lambda expressions::
* Redefining built-in predicates::

Built-in methods

* Logic and control methods::
* Execution context methods::
* Error handling and throwing methods::
* Database methods::
* Meta-call methods::
* All solutions methods::
* Reflection methods::
* Definite clause grammar parsing methods and non-terminals::

Calling Prolog predicates

* Calling Prolog built-in predicates::
* Calling Prolog non-standard built-in meta-predicates::
* Calling Prolog foreign predicates::
* Calling Prolog user-defined plain predicates::
* Calling Prolog module predicates::
* Calling Prolog module meta-predicates::

Inheritance

* Protocol inheritance::
* Implementation inheritance::
* Public, protected, and private inheritance: Public protected and private inheritance.
* Multiple inheritance::
* Composition versus multiple inheritance::

Protocol inheritance

* Lookup order for prototype hierarchies::
* Lookup order for class hierarchies::

Implementation inheritance

* Lookup order for prototype hierarchies: Lookup order for prototype hierarchies<2>.
* Lookup order for class hierarchies: Lookup order for class hierarchies<2>.
* Redefining inherited predicate definitions::
* Specializing inherited predicate definitions::
* Union of inherited and local predicate definitions::
* Selective inheritance of predicate definitions::

Event-driven programming

* Definitions::
* Event generation::
* Communicating events to monitors::
* Performance concerns::
* Monitor semantics::
* Activation order of monitors::
* Event handling::

Definitions

* Event::
* Monitor::

Event handling

* Defining new events::
* Abolishing defined events::
* Finding defined events::
* Defining event handlers::

Multi-threading programming

* Enabling multi-threading support::
* Enabling objects to make multi-threading calls::
* Multi-threading built-in predicates::
* One-way asynchronous calls::
* Asynchronous calls and synchronized predicates::
* Synchronizing threads through notifications::
* Threaded engines::
* Multi-threading performance::

Multi-threading built-in predicates

* Proving goals concurrently using threads::
* Proving goals asynchronously using threads::

Error handling

* Raising Exceptions::
* Type-checking::
* Expected terms::
* Compiler warnings and errors::
* Runtime errors::

Compiler warnings and errors

* Unknown entities::
* Singleton variables::
* Redefinition of Prolog built-in predicates::
* Redefinition of Logtalk built-in predicates::
* Redefinition of Logtalk built-in methods::
* Misspell calls of local predicates::
* Portability warnings::
* Deprecated elements::
* Missing directives::
* Duplicated directives::
* Duplicated clauses::
* Goals that are always true or false::
* Trivial fails::
* Suspicious calls::
* Lambda variables::
* Redefinition of predicates declared in uses/2 or use_module/2 directives::
* Other warnings and errors::

Runtime errors

* Logtalk built-in predicates::
* Logtalk built-in methods::
* Message sending::

Reflection

* Structural reflection::
* Behavioral reflection::

Structural reflection

* Transparent-box view::
* Black-box view::

Writing and running applications

* Starting Logtalk::
* Running parallel Logtalk processes::
* Source files::
* Multi-pass compiler::
* Compiling and loading your applications::
* Compiler errors, warnings, and comments: Compiler errors warnings and comments.
* Loader files::
* Libraries of source files::
* Settings files::
* Compiler linter::
* Compiler flags::
* Reloading source files::
* Batch processing::
* Optimizing performance::
* Portable applications::
* Conditional compilation::
* Avoiding common errors::
* Coding style guidelines::

Source files

* Naming conventions::
* Source file text encoding::

Compiler flags

* Read-only flags::
* Version flags::
* Lint flags::
* Optional features compilation flags::
* Backend Prolog compiler and loader flags::
* Other flags::
* User-defined flags::

Printing messages and asking questions

* Printing messages::
* Message tokenization::
* Meta-messages::
* Defining message prefixes and output streams::
* Defining message prefixes and output files::
* Intercepting messages::
* Asking questions::
* Intercepting questions::
* Multi-threading applications: Multi-threading applications<4>.

Term and goal expansion

* Defining expansions::
* Expanding grammar rules::
* Bypassing expansions::
* Hook objects::
* Virtual source file terms and loading context::
* Default compiler expansion workflow::
* User defined expansion workflows::
* Using Prolog defined expansions::
* Debugging expansions::

Documenting

* Entity documenting directives::
* Predicate documenting directives::
* Describing predicates::
* Documenting predicate exceptions::
* Processing and viewing documenting files::
* Inline formatting in comments text::
* Diagrams::

Debugging

* Compiling source files in debug mode::
* Procedure box model::
* Activating the debugger::
* Defining breakpoints::
* Defining log points::
* Tracing program execution::
* Debugging using breakpoints::
* Debugging commands::
* Customizing term writing::
* Context-switching calls::
* Debugging messages::
* Using the term-expansion mechanism for debugging::
* Ports profiling::
* Debug and trace events::
* Source-level debugger::

Defining breakpoints

* Defining predicate and clause breakpoints::
* Defining conditional breakpoints::
* Defining hit count breakpoints::
* Defining triggered breakpoints::
* Defining context breakpoints::
* Removing all breakpoints::

Customizing term writing

* Term write depth::
* Custom term writing::

Debugging messages

* Meta-messages: Meta-messages<2>.
* Selective printing of debug messages::

Performance

* Source code compilation modes::
* Source code compilation order::
* Local predicate calls::
* Calls to imported or inherited predicates::
* Calls to module predicates::
* Messages: Messages<2>.
* Automatic expansion of built-in meta-predicates::
* Inlining::
* Generated code simplification and optimizations::
* Size of the generated code::
* Circular references::
* Debug mode overhead::
* Other considerations::

Installing Logtalk

* Hardware and software requirements::
* Logtalk installers::
* Source distribution::
* Distribution overview::

Hardware and software requirements

* Computer and operating system::
* Prolog compiler::

Distribution overview

* Adapter files::
* Compiler and runtime::
* Library::
* Examples::
* Logtalk source files::

Prolog integration and migration

* Source files with both Prolog code and Logtalk code::
* Encapsulating plain Prolog code in objects::
* Converting Prolog modules into objects::
* Compiling Prolog modules as objects::
* Dealing with proprietary Prolog directives and predicates::
* Calling Prolog module predicates: Calling Prolog module predicates<2>.
* Loading converted Prolog applications::

Encapsulating plain Prolog code in objects

* Prolog multifile predicates::

Compiling Prolog modules as objects

* Supported module directives::
* Unsupported module directives::
* Modules using a term-expansion mechanism::
* File search paths::

Reference Manual

* Grammar::
* Control constructs::
* Directives: Directives<2>.
* Built-in predicates::
* Built-in methods: Built-in methods<2>.

Grammar

* Entities::
* Object definition::
* Category definition::
* Protocol definition::
* Entity relations::
* Entity identifiers::
* Source files: Source files<2>.
* Source file names::
* Terms::
* Directives::
* Clauses and goals::
* Lambda expressions: Lambda expressions<2>.
* Entity properties::
* Predicate properties: Predicate properties<2>.
* Compiler flags: Compiler flags<2>.

Entity relations

* Implemented protocols::
* Extended protocols::
* Imported categories::
* Extended objects::
* Extended categories::
* Instantiated objects::
* Specialized objects::
* Complemented objects::
* Entity and predicate scope::

Entity identifiers

* Object identifiers::
* Category identifiers::
* Protocol identifiers::
* Module identifiers::

Terms

* Object terms::
* Category terms::

Directives

* Source file directives::
* Conditional compilation directives::
* Object directives: Object directives<2>.
* Category directives: Category directives<2>.
* Protocol directives: Protocol directives<2>.
* Predicate directives::

Control constructs

* Message sending: Message sending<2>.
* Message delegation::
* Calling imported and inherited predicates: Calling imported and inherited predicates<2>.
* Calling predicates in this::
* Calling external predicates::
* Context switching calls::

Message sending

* (;;)/2: /2.
* (;;)/1: /1.

(::)/2

* Description::
* Modes and number of proofs::
* Errors::
* Examples: Examples<2>.

(::)/1

* Description: Description<2>.
* Modes and number of proofs: Modes and number of proofs<2>.
* Errors: Errors<2>.
* Examples: Examples<3>.

Message delegation

* []/1::

[]/1

* Description: Description<3>.
* Modes and number of proofs: Modes and number of proofs<3>.
* Errors: Errors<3>.
* Examples: Examples<4>.

Calling imported and inherited predicates

* (^^)/1: ^^ /1.

(^^)/1

* Description: Description<4>.
* Modes and number of proofs: Modes and number of proofs<4>.
* Errors: Errors<4>.
* Examples: Examples<5>.

Calling predicates in this

* (@)/1: @ /1.

(@)/1

* Description: Description<5>.
* Modes and number of proofs: Modes and number of proofs<5>.
* Errors: Errors<5>.
* Examples: Examples<6>.

Calling external predicates

* {}/1::

{}/1

* Description: Description<6>.
* Modes and number of proofs: Modes and number of proofs<6>.
* Errors: Errors<6>.
* Examples: Examples<7>.

Context switching calls

* (<<)/2: << /2.

(<<)/2

* Description: Description<7>.
* Modes and number of proofs: Modes and number of proofs<7>.
* Errors: Errors<7>.
* Examples: Examples<8>.

Directives

* Source file directives: Source file directives<2>.
* Conditional compilation directives: Conditional compilation directives<2>.
* Entity directives::
* Predicate directives: Predicate directives<2>.

Source file directives

* encoding/1::
* include/1::
* initialization/1::
* op/3::
* set_logtalk_flag/2::

encoding/1

* Description: Description<8>.
* Template and modes::
* Examples: Examples<9>.

include/1

* Description: Description<9>.
* Template and modes: Template and modes<2>.
* Examples: Examples<10>.

initialization/1

* Description: Description<10>.
* Template and modes: Template and modes<3>.
* Examples: Examples<11>.

op/3

* Description: Description<11>.
* Template and modes: Template and modes<4>.
* Examples: Examples<12>.

set_logtalk_flag/2

* Description: Description<12>.
* Template and modes: Template and modes<5>.
* Errors: Errors<8>.
* Examples: Examples<13>.

Conditional compilation directives

* if/1::
* elif/1::
* else/0::
* endif/0::

if/1

* Description: Description<13>.
* Template and modes: Template and modes<6>.
* Examples: Examples<14>.

elif/1

* Description: Description<14>.
* Template and modes: Template and modes<7>.
* Examples: Examples<15>.

else/0

* Description: Description<15>.
* Template and modes: Template and modes<8>.
* Examples: Examples<16>.

endif/0

* Description: Description<16>.
* Template and modes: Template and modes<9>.
* Examples: Examples<17>.

Entity directives

* built_in/0::
* category/1-4::
* dynamic/0::
* end_category/0::
* end_object/0::
* end_protocol/0::
* info/1::
* object/1-5::
* protocol/1-2::
* threaded/0::
* uses/1::
* use_module/1::

built_in/0

* Description: Description<17>.
* Template and modes: Template and modes<10>.
* Examples: Examples<18>.

category/1-4

* Description: Description<18>.
* Template and modes: Template and modes<11>.
* Examples: Examples<19>.

dynamic/0

* Description: Description<19>.
* Template and modes: Template and modes<12>.
* Examples: Examples<20>.

end_category/0

* Description: Description<20>.
* Template and modes: Template and modes<13>.
* Examples: Examples<21>.

end_object/0

* Description: Description<21>.
* Template and modes: Template and modes<14>.
* Examples: Examples<22>.

end_protocol/0

* Description: Description<22>.
* Template and modes: Template and modes<15>.
* Examples: Examples<23>.

info/1

* Description: Description<23>.
* Template and modes: Template and modes<16>.
* Examples: Examples<24>.

object/1-5

* Description: Description<24>.
* Template and modes: Template and modes<17>.
* Examples: Examples<25>.

protocol/1-2

* Description: Description<25>.
* Template and modes: Template and modes<18>.
* Examples: Examples<26>.

threaded/0

* Description: Description<26>.
* Template and modes: Template and modes<19>.
* Examples: Examples<27>.

uses/1

* Description: Description<27>.
* Template and modes: Template and modes<20>.
* Examples: Examples<28>.

use_module/1

* Description: Description<28>.
* Template and modes: Template and modes<21>.
* Examples: Examples<29>.

Predicate directives

* alias/2::
* coinductive/1::
* discontiguous/1::
* dynamic/1::
* info/2::
* meta_predicate/1::
* meta_non_terminal/1::
* mode/2::
* mode_non_terminal/2::
* multifile/1::
* private/1::
* protected/1::
* public/1::
* synchronized/1::
* uses/2::
* use_module/2::

alias/2

* Description: Description<29>.
* Template and modes: Template and modes<22>.
* Examples: Examples<30>.

coinductive/1

* Description: Description<30>.
* Template and modes: Template and modes<23>.
* Examples: Examples<31>.

discontiguous/1

* Description: Description<31>.
* Template and modes: Template and modes<24>.
* Examples: Examples<32>.

dynamic/1

* Description: Description<32>.
* Template and modes: Template and modes<25>.
* Examples: Examples<33>.

info/2

* Description: Description<33>.
* Template and modes: Template and modes<26>.
* Examples: Examples<34>.

meta_predicate/1

* Description: Description<34>.
* Template and modes: Template and modes<27>.
* Examples: Examples<35>.

meta_non_terminal/1

* Description: Description<35>.
* Template and modes: Template and modes<28>.
* Examples: Examples<36>.

mode/2

* Description: Description<36>.
* Template and modes: Template and modes<29>.
* Examples: Examples<37>.

mode_non_terminal/2

* Description: Description<37>.
* Template and modes: Template and modes<30>.
* Examples: Examples<38>.

multifile/1

* Description: Description<38>.
* Template and modes: Template and modes<31>.
* Examples: Examples<39>.

private/1

* Description: Description<39>.
* Template and modes: Template and modes<32>.
* Examples: Examples<40>.

protected/1

* Description: Description<40>.
* Template and modes: Template and modes<33>.
* Examples: Examples<41>.

public/1

* Description: Description<41>.
* Template and modes: Template and modes<34>.
* Examples: Examples<42>.

synchronized/1

* Description: Description<42>.
* Template and modes: Template and modes<35>.
* Examples: Examples<43>.

uses/2

* Description: Description<43>.
* Template and modes: Template and modes<36>.
* Examples: Examples<44>.

use_module/2

* Description: Description<44>.
* Template and modes: Template and modes<37>.
* Examples: Examples<45>.

Built-in predicates

* Enumerating objects, categories and protocols: Enumerating objects categories and protocols.
* Enumerating objects, categories and protocols properties: Enumerating objects categories and protocols properties.
* Creating new objects, categories and protocols: Creating new objects categories and protocols.
* Abolishing objects, categories and protocols: Abolishing objects categories and protocols.
* Objects, categories, and protocols relations: Objects categories and protocols relations.
* Event handling: Event handling<2>.
* Multi-threading::
* Multi-threading engines::
* Compiling and loading source files::
* Flags::
* Linter::

Enumerating objects, categories and protocols

* current_category/1::
* current_object/1::
* current_protocol/1::

current_category/1

* Description: Description<45>.
* Modes and number of proofs: Modes and number of proofs<8>.
* Errors: Errors<9>.
* Examples: Examples<46>.

current_object/1

* Description: Description<46>.
* Modes and number of proofs: Modes and number of proofs<9>.
* Errors: Errors<10>.
* Examples: Examples<47>.

current_protocol/1

* Description: Description<47>.
* Modes and number of proofs: Modes and number of proofs<10>.
* Errors: Errors<11>.
* Examples: Examples<48>.

Enumerating objects, categories and protocols properties

* category_property/2::
* object_property/2::
* protocol_property/2::

category_property/2

* Description: Description<48>.
* Modes and number of proofs: Modes and number of proofs<11>.
* Errors: Errors<12>.
* Examples: Examples<49>.

object_property/2

* Description: Description<49>.
* Modes and number of proofs: Modes and number of proofs<12>.
* Errors: Errors<13>.
* Examples: Examples<50>.

protocol_property/2

* Description: Description<50>.
* Modes and number of proofs: Modes and number of proofs<13>.
* Errors: Errors<14>.
* Examples: Examples<51>.

Creating new objects, categories and protocols

* create_category/4::
* create_object/4::
* create_protocol/3::

create_category/4

* Description: Description<51>.
* Modes and number of proofs: Modes and number of proofs<14>.
* Errors: Errors<15>.
* Examples: Examples<52>.

create_object/4

* Description: Description<52>.
* Modes and number of proofs: Modes and number of proofs<15>.
* Errors: Errors<16>.
* Examples: Examples<53>.

create_protocol/3

* Description: Description<53>.
* Modes and number of proofs: Modes and number of proofs<16>.
* Errors: Errors<17>.
* Examples: Examples<54>.

Abolishing objects, categories and protocols

* abolish_category/1::
* abolish_object/1::
* abolish_protocol/1::

abolish_category/1

* Description: Description<54>.
* Modes and number of proofs: Modes and number of proofs<17>.
* Errors: Errors<18>.
* Examples: Examples<55>.

abolish_object/1

* Description: Description<55>.
* Modes and number of proofs: Modes and number of proofs<18>.
* Errors: Errors<19>.
* Examples: Examples<56>.

abolish_protocol/1

* Description: Description<56>.
* Modes and number of proofs: Modes and number of proofs<19>.
* Errors: Errors<20>.
* Examples: Examples<57>.

Objects, categories, and protocols relations

* extends_object/2-3::
* extends_protocol/2-3::
* extends_category/2-3::
* implements_protocol/2-3::
* conforms_to_protocol/2-3::
* complements_object/2::
* imports_category/2-3::
* instantiates_class/2-3::
* specializes_class/2-3::

extends_object/2-3

* Description: Description<57>.
* Modes and number of proofs: Modes and number of proofs<20>.
* Errors: Errors<21>.
* Examples: Examples<58>.

extends_protocol/2-3

* Description: Description<58>.
* Modes and number of proofs: Modes and number of proofs<21>.
* Errors: Errors<22>.
* Examples: Examples<59>.

extends_category/2-3

* Description: Description<59>.
* Modes and number of proofs: Modes and number of proofs<22>.
* Errors: Errors<23>.
* Examples: Examples<60>.

implements_protocol/2-3

* Description: Description<60>.
* Modes and number of proofs: Modes and number of proofs<23>.
* Errors: Errors<24>.
* Examples: Examples<61>.

conforms_to_protocol/2-3

* Description: Description<61>.
* Modes and number of proofs: Modes and number of proofs<24>.
* Errors: Errors<25>.
* Examples: Examples<62>.

complements_object/2

* Description: Description<62>.
* Modes and number of proofs: Modes and number of proofs<25>.
* Errors: Errors<26>.
* Examples: Examples<63>.

imports_category/2-3

* Description: Description<63>.
* Modes and number of proofs: Modes and number of proofs<26>.
* Errors: Errors<27>.
* Examples: Examples<64>.

instantiates_class/2-3

* Description: Description<64>.
* Modes and number of proofs: Modes and number of proofs<27>.
* Errors: Errors<28>.
* Examples: Examples<65>.

specializes_class/2-3

* Description: Description<65>.
* Modes and number of proofs: Modes and number of proofs<28>.
* Errors: Errors<29>.
* Examples: Examples<66>.

Event handling

* abolish_events/5::
* current_event/5::
* define_events/5::

abolish_events/5

* Description: Description<66>.
* Modes and number of proofs: Modes and number of proofs<29>.
* Errors: Errors<30>.
* Examples: Examples<67>.

current_event/5

* Description: Description<67>.
* Modes and number of proofs: Modes and number of proofs<30>.
* Errors: Errors<31>.
* Examples: Examples<68>.

define_events/5

* Description: Description<68>.
* Modes and number of proofs: Modes and number of proofs<31>.
* Errors: Errors<32>.
* Examples: Examples<69>.

Multi-threading

* threaded/1::
* threaded_call/1-2::
* threaded_once/1-2::
* threaded_ignore/1::
* threaded_exit/1-2::
* threaded_peek/1-2::
* threaded_cancel/1::
* threaded_wait/1::
* threaded_notify/1::

threaded/1

* Description: Description<69>.
* Meta-predicate template::
* Modes and number of proofs: Modes and number of proofs<32>.
* Errors: Errors<33>.
* Examples: Examples<70>.

threaded_call/1-2

* Description: Description<70>.
* Meta-predicate template: Meta-predicate template<2>.
* Modes and number of proofs: Modes and number of proofs<33>.
* Errors: Errors<34>.
* Examples: Examples<71>.

threaded_once/1-2

* Description: Description<71>.
* Meta-predicate template: Meta-predicate template<3>.
* Modes and number of proofs: Modes and number of proofs<34>.
* Errors: Errors<35>.
* Examples: Examples<72>.

threaded_ignore/1

* Description: Description<72>.
* Meta-predicate template: Meta-predicate template<4>.
* Modes and number of proofs: Modes and number of proofs<35>.
* Errors: Errors<36>.
* Examples: Examples<73>.

threaded_exit/1-2

* Description: Description<73>.
* Modes and number of proofs: Modes and number of proofs<36>.
* Errors: Errors<37>.
* Examples: Examples<74>.

threaded_peek/1-2

* Description: Description<74>.
* Modes and number of proofs: Modes and number of proofs<37>.
* Errors: Errors<38>.
* Examples: Examples<75>.

threaded_cancel/1

* Description: Description<75>.
* Modes and number of proofs: Modes and number of proofs<38>.
* Errors: Errors<39>.
* Examples: Examples<76>.

threaded_wait/1

* Description: Description<76>.
* Modes and number of proofs: Modes and number of proofs<39>.
* Errors: Errors<40>.
* Examples: Examples<77>.

threaded_notify/1

* Description: Description<77>.
* Modes and number of proofs: Modes and number of proofs<40>.
* Errors: Errors<41>.
* Examples: Examples<78>.

Multi-threading engines

* threaded_engine_create/3::
* threaded_engine_destroy/1::
* threaded_engine/1::
* threaded_engine_self/1::
* threaded_engine_next/2::
* threaded_engine_next_reified/2::
* threaded_engine_yield/1::
* threaded_engine_post/2::
* threaded_engine_fetch/1::

threaded_engine_create/3

* Description: Description<78>.
* Meta-predicate template: Meta-predicate template<5>.
* Modes and number of proofs: Modes and number of proofs<41>.
* Errors: Errors<42>.
* Examples: Examples<79>.

threaded_engine_destroy/1

* Description: Description<79>.
* Modes and number of proofs: Modes and number of proofs<42>.
* Errors: Errors<43>.
* Examples: Examples<80>.

threaded_engine/1

* Description: Description<80>.
* Modes and number of proofs: Modes and number of proofs<43>.
* Errors: Errors<44>.
* Examples: Examples<81>.

threaded_engine_self/1

* Description: Description<81>.
* Modes and number of proofs: Modes and number of proofs<44>.
* Errors: Errors<45>.
* Examples: Examples<82>.

threaded_engine_next/2

* Description: Description<82>.
* Modes and number of proofs: Modes and number of proofs<45>.
* Errors: Errors<46>.
* Examples: Examples<83>.

threaded_engine_next_reified/2

* Description: Description<83>.
* Modes and number of proofs: Modes and number of proofs<46>.
* Errors: Errors<47>.
* Examples: Examples<84>.

threaded_engine_yield/1

* Description: Description<84>.
* Modes and number of proofs: Modes and number of proofs<47>.
* Errors: Errors<48>.
* Examples: Examples<85>.

threaded_engine_post/2

* Description: Description<85>.
* Modes and number of proofs: Modes and number of proofs<48>.
* Errors: Errors<49>.
* Examples: Examples<86>.

threaded_engine_fetch/1

* Description: Description<86>.
* Modes and number of proofs: Modes and number of proofs<49>.
* Errors: Errors<50>.
* Examples: Examples<87>.

Compiling and loading source files

* logtalk_compile/1::
* logtalk_compile/2::
* logtalk_load/1::
* logtalk_load/2::
* logtalk_make/0::
* logtalk_make/1::
* logtalk_make_target_action/1::
* logtalk_library_path/2::
* logtalk_load_context/2::

logtalk_compile/1

* Description: Description<87>.
* Modes and number of proofs: Modes and number of proofs<50>.
* Errors: Errors<51>.
* Examples: Examples<88>.

logtalk_compile/2

* Description: Description<88>.
* Modes and number of proofs: Modes and number of proofs<51>.
* Errors: Errors<52>.
* Examples: Examples<89>.

logtalk_load/1

* Description: Description<89>.
* Modes and number of proofs: Modes and number of proofs<52>.
* Errors: Errors<53>.
* Examples: Examples<90>.

logtalk_load/2

* Description: Description<90>.
* Modes and number of proofs: Modes and number of proofs<53>.
* Errors: Errors<54>.
* Examples: Examples<91>.

logtalk_make/0

* Description: Description<91>.
* Modes and number of proofs: Modes and number of proofs<54>.
* Errors: Errors<55>.
* Examples: Examples<92>.

logtalk_make/1

* Description: Description<92>.
* Modes and number of proofs: Modes and number of proofs<55>.
* Errors: Errors<56>.
* Examples: Examples<93>.

logtalk_make_target_action/1

* Description: Description<93>.
* Modes and number of proofs: Modes and number of proofs<56>.
* Errors: Errors<57>.
* Examples: Examples<94>.

logtalk_library_path/2

* Description: Description<94>.
* Modes and number of proofs: Modes and number of proofs<57>.
* Errors: Errors<58>.
* Examples: Examples<95>.

logtalk_load_context/2

* Description: Description<95>.
* Modes and number of proofs: Modes and number of proofs<58>.
* Errors: Errors<59>.
* Examples: Examples<96>.

Flags

* current_logtalk_flag/2::
* set_logtalk_flag/2: set_logtalk_flag/2<2>.
* create_logtalk_flag/3::

current_logtalk_flag/2

* Description: Description<96>.
* Modes and number of proofs: Modes and number of proofs<59>.
* Errors: Errors<60>.
* Examples: Examples<97>.

set_logtalk_flag/2

* Description: Description<97>.
* Modes and number of proofs: Modes and number of proofs<60>.
* Errors: Errors<61>.
* Examples: Examples<98>.

create_logtalk_flag/3

* Description: Description<98>.
* Modes and number of proofs: Modes and number of proofs<61>.
* Errors: Errors<62>.
* Examples: Examples<99>.

Linter

* logtalk_linter_hook/7::

logtalk_linter_hook/7

* Description: Description<99>.
* Modes and number of proofs: Modes and number of proofs<62>.
* Errors: Errors<63>.
* Examples: Examples<100>.

Built-in methods

* Logic and control::
* Execution context::
* Reflection: Reflection<2>.
* Database::
* Meta-calls::
* Error handling: Error handling<2>.
* All solutions::
* Event handling: Event handling<3>.
* Message forwarding::
* Definite clause grammar rules: Definite clause grammar rules<2>.
* Term and goal expansion: Term and goal expansion<2>.
* Coinduction hooks::
* Message printing::
* Question asking::

Logic and control

* !/0::
* true/0::
* fail/0::
* false/0::
* repeat/0::

!/0

* Description: Description<100>.
* Modes and number of proofs: Modes and number of proofs<63>.
* Errors: Errors<64>.
* Examples: Examples<101>.

true/0

* Description: Description<101>.
* Modes and number of proofs: Modes and number of proofs<64>.
* Errors: Errors<65>.
* Examples: Examples<102>.

fail/0

* Description: Description<102>.
* Modes and number of proofs: Modes and number of proofs<65>.
* Errors: Errors<66>.
* Examples: Examples<103>.

false/0

* Description: Description<103>.
* Modes and number of proofs: Modes and number of proofs<66>.
* Errors: Errors<67>.
* Examples: Examples<104>.

repeat/0

* Description: Description<104>.
* Modes and number of proofs: Modes and number of proofs<67>.
* Errors: Errors<68>.
* Examples: Examples<105>.

Execution context

* context/1::
* parameter/2::
* self/1::
* sender/1::
* this/1::

context/1

* Description: Description<105>.
* Modes and number of proofs: Modes and number of proofs<68>.
* Errors: Errors<69>.
* Examples: Examples<106>.

parameter/2

* Description: Description<106>.
* Modes and number of proofs: Modes and number of proofs<69>.
* Errors: Errors<70>.
* Examples: Examples<107>.

self/1

* Description: Description<107>.
* Modes and number of proofs: Modes and number of proofs<70>.
* Errors: Errors<71>.
* Examples: Examples<108>.

sender/1

* Description: Description<108>.
* Modes and number of proofs: Modes and number of proofs<71>.
* Errors: Errors<72>.
* Examples: Examples<109>.

this/1

* Description: Description<109>.
* Modes and number of proofs: Modes and number of proofs<72>.
* Errors: Errors<73>.
* Examples: Examples<110>.

Reflection

* current_op/3::
* current_predicate/1::
* predicate_property/2::

current_op/3

* Description: Description<110>.
* Modes and number of proofs: Modes and number of proofs<73>.
* Errors: Errors<74>.
* Examples: Examples<111>.

current_predicate/1

* Description: Description<111>.
* Modes and number of proofs: Modes and number of proofs<74>.
* Errors: Errors<75>.
* Examples: Examples<112>.

predicate_property/2

* Description: Description<112>.
* Modes and number of proofs: Modes and number of proofs<75>.
* Errors: Errors<76>.
* Examples: Examples<113>.

Database

* abolish/1::
* asserta/1::
* assertz/1::
* clause/2::
* retract/1::
* retractall/1::

abolish/1

* Description: Description<113>.
* Modes and number of proofs: Modes and number of proofs<76>.
* Errors: Errors<77>.
* Examples: Examples<114>.

asserta/1

* Description: Description<114>.
* Modes and number of proofs: Modes and number of proofs<77>.
* Errors: Errors<78>.
* Examples: Examples<115>.

assertz/1

* Description: Description<115>.
* Modes and number of proofs: Modes and number of proofs<78>.
* Errors: Errors<79>.
* Examples: Examples<116>.

clause/2

* Description: Description<116>.
* Modes and number of proofs: Modes and number of proofs<79>.
* Errors: Errors<80>.
* Examples: Examples<117>.

retract/1

* Description: Description<117>.
* Modes and number of proofs: Modes and number of proofs<80>.
* Errors: Errors<81>.
* Examples: Examples<118>.

retractall/1

* Description: Description<118>.
* Modes and number of proofs: Modes and number of proofs<81>.
* Errors: Errors<82>.
* Examples: Examples<119>.

Meta-calls

* call/1-N::
* ignore/1::
* once/1::
* (\+)/1: \+ /1.

call/1-N

* Description: Description<119>.
* Meta-predicate template: Meta-predicate template<6>.
* Modes and number of proofs: Modes and number of proofs<82>.
* Errors: Errors<83>.
* Examples: Examples<120>.

ignore/1

* Description: Description<120>.
* Meta-predicate template: Meta-predicate template<7>.
* Modes and number of proofs: Modes and number of proofs<83>.
* Errors: Errors<84>.
* Examples: Examples<121>.

once/1

* Description: Description<121>.
* Meta-predicate template: Meta-predicate template<8>.
* Modes and number of proofs: Modes and number of proofs<84>.
* Errors: Errors<85>.
* Examples: Examples<122>.

(\+)/1

* Description: Description<122>.
* Meta-predicate template: Meta-predicate template<9>.
* Modes and number of proofs: Modes and number of proofs<85>.
* Errors: Errors<86>.
* Examples: Examples<123>.

Error handling

* catch/3::
* throw/1::
* instantiation_error/0::
* uninstantiation_error/1::
* type_error/2::
* domain_error/2::
* consistency_error/3::
* existence_error/2::
* permission_error/3::
* representation_error/1::
* evaluation_error/1::
* resource_error/1::
* syntax_error/1::
* system_error/0::

catch/3

* Description: Description<123>.
* Modes and number of proofs: Modes and number of proofs<86>.
* Errors: Errors<87>.
* Examples: Examples<124>.

throw/1

* Description: Description<124>.
* Modes and number of proofs: Modes and number of proofs<87>.
* Errors: Errors<88>.
* Examples: Examples<125>.

instantiation_error/0

* Description: Description<125>.
* Modes and number of proofs: Modes and number of proofs<88>.
* Errors: Errors<89>.
* Examples: Examples<126>.

uninstantiation_error/1

* Description: Description<126>.
* Modes and number of proofs: Modes and number of proofs<89>.
* Errors: Errors<90>.
* Examples: Examples<127>.

type_error/2

* Description: Description<127>.
* Modes and number of proofs: Modes and number of proofs<90>.
* Errors: Errors<91>.
* Examples: Examples<128>.

domain_error/2

* Description: Description<128>.
* Modes and number of proofs: Modes and number of proofs<91>.
* Errors: Errors<92>.
* Examples: Examples<129>.

consistency_error/3

* Description: Description<129>.
* Modes and number of proofs: Modes and number of proofs<92>.
* Errors: Errors<93>.
* Examples: Examples<130>.

existence_error/2

* Description: Description<130>.
* Modes and number of proofs: Modes and number of proofs<93>.
* Errors: Errors<94>.
* Examples: Examples<131>.

permission_error/3

* Description: Description<131>.
* Modes and number of proofs: Modes and number of proofs<94>.
* Errors: Errors<95>.
* Examples: Examples<132>.

representation_error/1

* Description: Description<132>.
* Modes and number of proofs: Modes and number of proofs<95>.
* Errors: Errors<96>.
* Examples: Examples<133>.

evaluation_error/1

* Description: Description<133>.
* Modes and number of proofs: Modes and number of proofs<96>.
* Errors: Errors<97>.
* Examples: Examples<134>.

resource_error/1

* Description: Description<134>.
* Modes and number of proofs: Modes and number of proofs<97>.
* Errors: Errors<98>.
* Examples: Examples<135>.

syntax_error/1

* Description: Description<135>.
* Modes and number of proofs: Modes and number of proofs<98>.
* Errors: Errors<99>.
* Examples: Examples<136>.

system_error/0

* Description: Description<136>.
* Modes and number of proofs: Modes and number of proofs<99>.
* Errors: Errors<100>.
* Examples: Examples<137>.

All solutions

* bagof/3::
* findall/3::
* findall/4::
* forall/2::
* setof/3::

bagof/3

* Description: Description<137>.
* Meta-predicate template: Meta-predicate template<10>.
* Modes and number of proofs: Modes and number of proofs<100>.
* Errors: Errors<101>.
* Examples: Examples<138>.

findall/3

* Description: Description<138>.
* Meta-predicate template: Meta-predicate template<11>.
* Modes and number of proofs: Modes and number of proofs<101>.
* Errors: Errors<102>.
* Examples: Examples<139>.

findall/4

* Description: Description<139>.
* Meta-predicate template: Meta-predicate template<12>.
* Modes and number of proofs: Modes and number of proofs<102>.
* Errors: Errors<103>.
* Examples: Examples<140>.

forall/2

* Description: Description<140>.
* Meta-predicate template: Meta-predicate template<13>.
* Modes and number of proofs: Modes and number of proofs<103>.
* Errors: Errors<104>.
* Examples: Examples<141>.

setof/3

* Description: Description<141>.
* Meta-predicate template: Meta-predicate template<14>.
* Modes and number of proofs: Modes and number of proofs<104>.
* Errors: Errors<105>.
* Examples: Examples<142>.

Event handling

* before/3::
* after/3::

before/3

* Description: Description<142>.
* Modes and number of proofs: Modes and number of proofs<105>.
* Errors: Errors<106>.
* Examples: Examples<143>.

after/3

* Description: Description<143>.
* Modes and number of proofs: Modes and number of proofs<106>.
* Errors: Errors<107>.
* Examples: Examples<144>.

Message forwarding

* forward/1::

forward/1

* Description: Description<144>.
* Modes and number of proofs: Modes and number of proofs<107>.
* Errors: Errors<108>.
* Examples: Examples<145>.

Definite clause grammar rules

* call//1-N::
* eos//0::
* phrase//1::
* phrase/2::
* phrase/3::

call//1-N

* Description: Description<145>.
* Meta-non-terminal template::
* Modes and number of proofs: Modes and number of proofs<108>.
* Errors: Errors<109>.
* Examples: Examples<146>.

eos//0

* Description: Description<146>.
* Modes and number of proofs: Modes and number of proofs<109>.
* Errors: Errors<110>.
* Examples: Examples<147>.

phrase//1

* Description: Description<147>.
* Meta-non-terminal template: Meta-non-terminal template<2>.
* Modes and number of proofs: Modes and number of proofs<110>.
* Errors: Errors<111>.
* Examples: Examples<148>.

phrase/2

* Description: Description<148>.
* Meta-predicate template: Meta-predicate template<15>.
* Modes and number of proofs: Modes and number of proofs<111>.
* Errors: Errors<112>.
* Examples: Examples<149>.

phrase/3

* Description: Description<149>.
* Meta-predicate template: Meta-predicate template<16>.
* Modes and number of proofs: Modes and number of proofs<112>.
* Errors: Errors<113>.
* Examples: Examples<150>.

Term and goal expansion

* expand_term/2::
* term_expansion/2::
* expand_goal/2::
* goal_expansion/2::

expand_term/2

* Description: Description<150>.
* Modes and number of proofs: Modes and number of proofs<113>.
* Errors: Errors<114>.
* Examples: Examples<151>.

term_expansion/2

* Description: Description<151>.
* Modes and number of proofs: Modes and number of proofs<114>.
* Errors: Errors<115>.
* Examples: Examples<152>.

expand_goal/2

* Description: Description<152>.
* Modes and number of proofs: Modes and number of proofs<115>.
* Errors: Errors<116>.
* Examples: Examples<153>.

goal_expansion/2

* Description: Description<153>.
* Modes and number of proofs: Modes and number of proofs<116>.
* Errors: Errors<117>.
* Examples: Examples<154>.

Coinduction hooks

* coinductive_success_hook/1-2::

coinductive_success_hook/1-2

* Description: Description<154>.
* Modes and number of proofs: Modes and number of proofs<117>.
* Errors: Errors<118>.
* Examples: Examples<155>.

Message printing

* print_message/3::
* message_tokens//2::
* message_hook/4::
* message_prefix_stream/4::
* message_prefix_file/6::
* print_message_tokens/3::
* print_message_token/4::

print_message/3

* Description: Description<155>.
* Modes and number of proofs: Modes and number of proofs<118>.
* Errors: Errors<119>.
* Examples: Examples<156>.

message_tokens//2

* Description: Description<156>.
* Modes and number of proofs: Modes and number of proofs<119>.
* Errors: Errors<120>.
* Examples: Examples<157>.

message_hook/4

* Description: Description<157>.
* Modes and number of proofs: Modes and number of proofs<120>.
* Errors: Errors<121>.
* Examples: Examples<158>.

message_prefix_stream/4

* Description: Description<158>.
* Modes and number of proofs: Modes and number of proofs<121>.
* Errors: Errors<122>.
* Examples: Examples<159>.

message_prefix_file/6

* Description: Description<159>.
* Modes and number of proofs: Modes and number of proofs<122>.
* Errors: Errors<123>.
* Examples: Examples<160>.

print_message_tokens/3

* Description: Description<160>.
* Modes and number of proofs: Modes and number of proofs<123>.
* Errors: Errors<124>.
* Examples: Examples<161>.

print_message_token/4

* Description: Description<161>.
* Modes and number of proofs: Modes and number of proofs<124>.
* Errors: Errors<125>.
* Examples: Examples<162>.

Question asking

* ask_question/5::
* question_hook/6::
* question_prompt_stream/4::

ask_question/5

* Description: Description<162>.
* Modes and number of proofs: Modes and number of proofs<125>.
* Meta-predicate template: Meta-predicate template<17>.
* Errors: Errors<126>.
* Examples: Examples<163>.

question_hook/6

* Description: Description<163>.
* Modes and number of proofs: Modes and number of proofs<126>.
* Meta-predicate template: Meta-predicate template<18>.
* Errors: Errors<127>.
* Examples: Examples<164>.

question_prompt_stream/4

* Description: Description<164>.
* Modes and number of proofs: Modes and number of proofs<127>.
* Errors: Errors<128>.
* Examples: Examples<165>.

Tutorial

* List predicates::
* Dynamic object attributes::
* A reflective class-based system::
* Profiling programs::

List predicates

* Defining a list object::
* Defining a list protocol::
* Summary::

Dynamic object attributes

* Defining a category::
* Importing the category::
* Summary: Summary<2>.

A reflective class-based system

* Defining the base classes::
* Summary: Summary<3>.

Profiling programs

* Messages as events::
* Profilers as monitors::
* Summary: Summary<4>.

FAQ

* General::
* Compatibility::
* Installation::
* Portability::
* Programming::
* Troubleshooting::
* Usability::
* Deployment::
* Performance: Performance<3>.
* Licensing::
* Support::

General

* Why are all versions of Logtalk numbered 2.x or 3.x?: Why are all versions of Logtalk numbered 2 x or 3 x?.
* Why do I need a Prolog compiler to use Logtalk?::
* Is the Logtalk implementation based on Prolog modules?::
* Does the Logtalk implementation use term-expansion?::

Compatibility

* What are the backend Prolog compiler requirements to run Logtalk?::
* Can I use constraint-based packages with Logtalk?::
* Can I use Logtalk objects and Prolog modules at the same time?::

Installation

* The integration scripts/shortcuts are not working!::
* I get errors when starting up Logtalk after upgrading to the latest version!::

Portability

* Are my Logtalk applications portable across Prolog compilers?::
* Are my Logtalk applications portable across operating systems?::

Programming

* Should I use prototypes or classes in my application?::
* Can I use both classes and prototypes in the same application?::
* Can I mix classes and prototypes in the same hierarchy?::
* Can I use a protocol or a category with both prototypes and classes?::
* What support is provided in Logtalk for defining and using components?::
* What support is provided in Logtalk for reflective programming?::

Troubleshooting

* Using compiler options on calls to the Logtalk compiling and loading predicates does not work!::
* Gecko-based browsers (e.g., Firefox) show non-rendered HTML entities when browsing XML documenting files!: Gecko-based browsers e g Firefox show non-rendered HTML entities when browsing XML documenting files!.
* Compiling a source file results in errors or warnings but the Logtalk compiler reports a successful compilation with zero errors and zero warnings!::

Usability

* Is there a shortcut for compiling and loading source files?::
* Is there an equivalent directive to the ensure_loaded/1 Prolog directive?::
* Are there shortcuts for the make functionality?::

Deployment

* Can I create standalone applications with Logtalk?::

Performance

* Is Logtalk implemented as a meta-interpreter?::
* What kind of code Logtalk generates when compiling objects? Dynamic code? Static code?::
* How about message-sending performance? Does Logtalk use static binding or dynamic binding?::
* Which Prolog-dependent factors are most crucial for good Logtalk performance?::
* How does Logtalk performance compare with plain Prolog and with Prolog modules?::

Licensing

* What’s the Logtalk distribution license?::
* Can Logtalk be used in commercial applications?::
* What’s the final license for a combination of Logtalk with a Prolog compiler?::

Support

* Are there professional consulting, training and supporting services?: Are there professional consulting training and supporting services?.

Developer Tools

* Overview::
* asdf::
* assertions::
* code_metrics::
* dead_code_scanner::
* debug_messages::
* debugger::
* diagrams::
* doclet::
* help::
* issue_creator::
* lgtdoc::
* lgtunit::
* linter::
* linter_reporter::
* make::
* mutation_testing::
* packs::
* ports_profiler::
* profiler::
* sarif::
* sbom::
* tool_diagnostics::
* tutor::
* wrapper::

Overview

* Loading the developer tools::
* Tools documentation::
* Tools common flags::
* Tools requirements::

Tools requirements

* Tool dependencies for full functionality::
* Python dependencies (all operating-systems): Python dependencies all operating-systems.
* macOS - MacPorts::
* macOS - Homebrew::
* Ubuntu::
* RedHat::
* Windows - Chocolatey::
* Installers::
* Windows - PowerShell add-ons::

assertions

* API documentation::
* Loading::
* Testing::
* Adding assertions to your source code::
* Automatically adding file and line context information to assertions::
* Suppressing assertion calls from source code::
* Redirecting assertion failure messages::
* Converting assertion failures into errors::

code_metrics

* API documentation: API documentation<2>.
* Loading: Loading<2>.
* Testing: Testing<2>.
* Available metrics::
* Coupling metrics::
* Lack of cohesion metric::
* WMC metric::
* RFC metric::
* Cognitive complexity metric::
* Lines metric::
* Maintainability index metric::
* Halstead metric::
* UPN metric::
* Cyclomatic complexity metric::
* Usage::
* Excluding code from analysis::
* Defining new metrics::
* Third-party tools::
* Applying metrics to Prolog modules::
* Applying metrics to plain Prolog code::

dead_code_scanner

* API documentation: API documentation<3>.
* Loading: Loading<3>.
* Testing: Testing<3>.
* Usage: Usage<2>.
* Excluding code from analysis: Excluding code from analysis<2>.
* Machine-readable summaries::
* Machine-readable preflight warnings::
* Finding classes and confidence::
* SARIF reports::
* Integration with the make tool::
* Caveats::
* Scanning Prolog modules::
* Scanning plain Prolog files::
* Known issues::

debug_messages

* API documentation: API documentation<4>.
* Loading: Loading<4>.
* Testing: Testing<4>.
* Usage: Usage<3>.

debugger

* API documentation: API documentation<5>.
* Loading: Loading<5>.
* Testing: Testing<5>.
* Usage: Usage<4>.
* Alternative debugger tools::
* Known issues: Known issues<2>.

diagrams

* Requirements::
* API documentation: API documentation<6>.
* Loading: Loading<6>.
* Testing: Testing<6>.
* Supported diagrams::
* Graph elements::
* Supported graph languages::
* Customization::
* Linking diagrams::
* Creating diagrams for Prolog module applications::
* Creating diagrams for plain Prolog files::
* Other notes::

Requirements

* macOS - MacPorts: macOS - MacPorts<2>.
* macOS - Homebrew: macOS - Homebrew<2>.
* Windows - Chocolatey: Windows - Chocolatey<2>.
* Installers: Installers<2>.

doclet

* API documentation: API documentation<7>.
* Loading: Loading<7>.
* Automating running doclets::
* Integration with the make tool: Integration with the make tool<2>.

help

* Requirements: Requirements<2>.
* Customization: Customization<2>.
* API documentation: API documentation<8>.
* Loading: Loading<8>.
* Testing: Testing<7>.
* Supported operating-systems::
* Usage: Usage<5>.
* Known issues: Known issues<3>.

issue_creator

* Requirements: Requirements<3>.
* Loading: Loading<9>.
* Usage: Usage<6>.
* Known issues: Known issues<4>.

lgtdoc

* Requirements: Requirements<4>.
* API documentation: API documentation<9>.
* Loading: Loading<10>.
* Testing: Testing<8>.
* Documenting source code::
* Generating documentation::
* Documentation linter checks::

lgtunit

* Main files::
* API documentation: API documentation<10>.
* Loading: Loading<11>.
* Testing: Testing<9>.
* Writing and running tests::
* Automating running tests::
* Parametric test objects::
* Test dialects::
* User-defined test dialects::
* QuickCheck::
* Skipping tests::
* Selecting tests::
* Checking test goal results::
* Testing local predicates::
* Testing non-deterministic predicates::
* Testing generators::
* Testing input/output predicates::
* Suppressing tested predicates output::
* Tests with timeout limits::
* Setup and cleanup goals::
* Test annotations::
* Test execution times and memory usage::
* Working with test data files::
* Flaky tests::
* Mocking::
* Debugging messages in tests::
* Debugging failed tests::
* Code coverage::
* Utility predicates::
* Exporting test results::
* Generating Allure reports::
* Exporting code coverage results::
* Automatically creating bug reports at issue trackers::
* Minimizing test results output::
* Help with warnings::
* Known issues: Known issues<5>.

Exporting test results

* xUnit XML format::
* TAP output format::
* CTRF JSON format::
* Subunit formats::

Exporting code coverage results

* Simple XML format::
* Cobertura XML format::
* LCOV format::

linter

* Main linter checks::
* Help on linter warnings::
* Extending the linter::
* Linting Prolog modules::
* Linting plain Prolog files::

linter_reporter

* API documentation: API documentation<11>.
* Loading: Loading<12>.
* Testing: Testing<10>.
* Usage: Usage<7>.
* Options::

make

* API documentation: API documentation<12>.
* Help with warnings: Help with warnings<2>.
* Known issues: Known issues<6>.

mutation_testing

* API documentation: API documentation<13>.
* Loading: Loading<13>.
* Testing: Testing<11>.
* Features::
* Default mutators::
* Usage: Usage<8>.
* Limitations::
* Options: Options<2>.
* Sampling semantics::
* Defining new mutators::

Sampling semantics

* Sampling modes::
* Sampling usage in practice::

packs

* Requirements: Requirements<5>.
* API documentation: API documentation<14>.
* Loading: Loading<14>.
* Testing: Testing<12>.
* Usage: Usage<9>.
* Programmatic query API::
* Registries and packs storage::
* Virtual environments::
* Lock files::
* Registry specification::
* Registry handling::
* Registry development::
* Pack specification::
* Encrypted packs::
* Signed packs::
* Pack URLs and Single Sign-On::
* Multiple pack versions::
* Pack dependencies::
* Pack portability::
* Pack development::
* Pack handling::
* Pack documentation::
* Pinning registries and packs::
* Testing packs::
* Security considerations::
* Best practices::
* Installing Prolog packs::
* Help with warnings: Help with warnings<3>.
* Known issues: Known issues<7>.

ports_profiler

* API documentation: API documentation<15>.
* Loading: Loading<15>.
* Testing: Testing<13>.
* Compiling source files for port profiling::
* Generating profiling data::
* Printing profiling data reports::
* Interpreting profiling data::
* Profiling Prolog modules::
* Profiling plain Prolog code::
* Known issues: Known issues<8>.

profiler

* Loading: Loading<16>.
* Testing: Testing<14>.
* Supported backend Prolog compilers::
* Compiling source code for profiling::

sarif

* API documentation: API documentation<16>.
* Loading: Loading<17>.
* Testing: Testing<15>.
* Usage: Usage<10>.

sbom

* API documentation: API documentation<17>.
* Loading: Loading<18>.
* Testing: Testing<16>.
* Usage: Usage<11>.
* Known issues: Known issues<9>.

tool_diagnostics

* API documentation: API documentation<18>.
* Loading: Loading<19>.
* Protocol overview::
* Term conventions::
* Usage: Usage<12>.

tutor

* API documentation: API documentation<19>.
* Loading: Loading<20>.
* Usage: Usage<13>.

wrapper

* API documentation: API documentation<20>.
* Loading: Loading<21>.
* Workflows::
* Customization: Customization<3>.
* Current limitations::

Libraries

* Overview: Overview<2>.
* adaptive_boosting_classifier::
* agglomerative_clusterer::
* amqp::
* anomaly_detection_protocols::
* application::
* apriori_pattern_miner::
* arbitrary::
* arrangements::
* assignvars::
* avro::
* base32::
* base58::
* base64::
* base85::
* basic_types::
* bayesian_ridge_regression::
* borda_ranker::
* bradley_terry_ranker::
* c45_classifier::
* cartesian_products::
* cbor::
* character_sets::
* ccsds_frames::
* ccsds_link_profiles::
* ccsds_packet_services::
* ccsds_packetization::
* ccsds_packets::
* ccsds_tc_services::
* ccsds_time_codes::
* ccsds_time_fields::
* classification_protocols::
* clo_span_pattern_miner::
* clustering_protocols::
* colley_ranker::
* combinations::
* command_line_options::
* core::
* copeland_ranker::
* coroutining::
* crs_projections::
* csv::
* cuid2::
* cusum_anomaly_detector::
* datalog::
* dates::
* dates_tz::
* dbscan_clusterer::
* dependents::
* deques::
* derangements::
* dictionaries::
* dif::
* dimension_reduction_protocols::
* eclat_pattern_miner::
* edcg::
* elastic_net_regression::
* elo_ranker::
* events::
* ewma_anomaly_detector::
* expand_library_alias_paths::
* expecteds::
* format::
* fp_growth_pattern_miner::
* frequent_pattern_mining_protocols::
* gaussian_mixture_clusterer::
* gaussian_process_regression::
* genint::
* gensym::
* geojson::
* geospatial::
* git::
* glicko2_ranker::
* glicko2_periodic_ranker::
* gradient_boosting_classifier::
* gradient_boosting_regression::
* grammars::
* graphs::
* gsp_pattern_miner::
* hashes::
* hdbscan_clusterer::
* heaps::
* hierarchical_clustering::
* hierarchies::
* hmac::
* hodge_rank::
* hook_flows::
* hook_objects::
* html::
* ica_projection::
* ids::
* ieee_754::
* intervals::
* iqr_anomaly_detector::
* iso_639::
* iso_3166::
* iso_4217::
* iso_9362::
* iso_13616::
* isolation_forest_anomaly_detector::
* java::
* json::
* json_ld::
* json_lines::
* json_pointer::
* json_rpc::
* json_schema::
* kcenters_clusterer::
* kemeny_young_ranker::
* kernel_svm_classifier::
* kernel_pca_projection::
* kmeans_clusterer::
* kmedians_clusterer::
* kmedoids_clusterer::
* kmodes_clusterer::
* knn_classifier::
* knn_distance_anomaly_detector::
* knn_regression::
* kprototypes_clusterer::
* ksuid::
* lasso_regression::
* lda_classifier::
* lda_projection::
* linda::
* linear_algebra::
* linear_regression::
* linear_svm_classifier::
* listing::
* lof_anomaly_detector::
* logging::
* logistic_regression_classifier::
* loops::
* massey_ranker::
* mcp_server::
* memcached::
* message_pack::
* meta::
* meta_compiler::
* mime_types::
* modified_z_score_anomaly_detector::
* mutations::
* multisets::
* nanoid::
* naive_bayes_classifier::
* nearest_centroid_classifier::
* nested_dictionaries::
* Raw Sentence Representation::
* Typed data/2 Results::
* Date Rule::
* Current Scope::
* nmf_projection::
* optics_clusterer::
* optionals::
* options::
* os::
* partitions::
* pattern_mining_protocols::
* pca_projection::
* permutations::
* plackett_luce_ranker::
* plackett_luce_last_ranker::
* pls_projection::
* prefix_span_pattern_miner::
* probabilistic_pca_projection::
* process::
* protobuf::
* qda_classifier::
* queues::
* random::
* random_forest_classifier::
* random_forest_regression::
* random_projection::
* rank_centrality::
* ranked_pairs::
* ranking_protocols::
* reader::
* recorded_database::
* redis::
* regression_protocols::
* regression_tree::
* regularized_bradley_terry_ranker::
* ridge_regression::
* schulze_ranker::
* sequential_pattern_mining_protocols::
* sets::
* sgd_classifier::
* snowflakeid::
* sockets::
* spade_pattern_miner::
* simulated_annealing::
* statistics::
* stemming::
* stomp::
* string_distance::
* strings::
* subsequences::
* term_io::
* thurstone_mosteller_ranker::
* time_scales::
* timeout::
* tle_orbits::
* toml::
* toon::
* truncated_svd_projection::
* tsv::
* types::
* tzif::
* ulid::
* unicode_data::
* union_find::
* url::
* uuid::
* validations::
* wkt_wkb::
* yaml::
* z_score_anomaly_detector::
* zippers::

Overview

* Library documentation::
* Loading libraries::
* Testing libraries::
* Credits::
* Other notes: Other notes<2>.

adaptive_boosting_classifier

* API documentation: API documentation<21>.
* Loading: Loading<22>.
* Testing: Testing<17>.
* Features: Features<2>.
* Options: Options<3>.
* Classifier representation::
* References::
* Usage: Usage<14>.

Usage

* Learning a Classifier::
* Making Predictions::
* Exporting the Classifier::
* Using a Saved Classifier::
* Printing the Classifier::

agglomerative_clusterer

* API documentation: API documentation<22>.
* Loading: Loading<23>.
* Testing: Testing<18>.
* Features: Features<3>.
* Options: Options<4>.
* Clusterer representation::
* Diagnostics::

amqp

* API documentation: API documentation<23>.
* Loading: Loading<24>.
* Testing: Testing<19>.
* Features: Features<4>.
* Usage: Usage<15>.
* Connection Pooling::
* Binary Frame Encoding::
* Data Types::
* Float/Double Encoding/Decoding::
* Error Handling::
* Comparison with STOMP::
* Future Work::
* Known Limitations and Issues::
* AMQP 1.0 vs AMQP 0-9-1: AMQP 1 0 vs AMQP 0-9-1.

Usage

* Connecting to an AMQP server::
* Opening a channel::
* Declaring exchanges and queues::
* Publishing messages::
* Consuming messages::
* Synchronous get::
* Quality of Service::
* Transactions::
* Publisher Confirms (RabbitMQ extension): Publisher Confirms RabbitMQ extension.
* Closing connections::

Connection Pooling

* Defining a pool::
* Initializing the pool::
* Acquiring and releasing connections::
* Using with_connection/1::
* Pool statistics::
* Resizing the pool::
* Destroying the pool::
* Creating pools dynamically::

Binary Frame Encoding

* Frame structure::
* Encoding/decoding frames::

anomaly_detection_protocols

* Export header format::
* API documentation: API documentation<24>.
* Loading: Loading<25>.
* Testing: Testing<20>.
* Test datasets::

application

* API documentation: API documentation<25>.
* Loading: Loading<26>.
* Testing: Testing<21>.
* Usage: Usage<16>.

apriori_pattern_miner

* API documentation: API documentation<26>.
* Loading: Loading<27>.
* Testing: Testing<22>.
* Features: Features<5>.
* Options: Options<5>.
* Pattern miner representation::
* References: References<2>.

arbitrary

* API documentation: API documentation<27>.
* Loading: Loading<28>.
* Testing: Testing<23>.
* Pre-defined types::
* Usage: Usage<17>.
* Defining new generators and shrinkers::
* Scoped generators and shrinkers::
* Reproducing sequences of arbitrary terms::
* Default size of generated terms::
* Known issues: Known issues<10>.

arrangements

* API documentation: API documentation<28>.
* Loading: Loading<29>.
* Testing: Testing<24>.

assignvars

* API documentation: API documentation<29>.
* Loading: Loading<30>.
* Testing: Testing<25>.

avro

* API documentation: API documentation<30>.
* Loading: Loading<31>.
* Testing: Testing<26>.
* Schema representation::
* Data representation::
* Schema Examples::
* Encoding::
* Decoding::

base32

* API documentation: API documentation<31>.
* Loading: Loading<32>.
* Testing: Testing<27>.
* Encoding: Encoding<2>.
* Decoding: Decoding<2>.

base58

* API documentation: API documentation<32>.
* Loading: Loading<33>.
* Testing: Testing<28>.
* Encoding: Encoding<3>.
* Decoding: Decoding<3>.

base64

* API documentation: API documentation<33>.
* Loading: Loading<34>.
* Testing: Testing<29>.
* Encoding: Encoding<4>.
* Decoding: Decoding<4>.

base85

* API documentation: API documentation<34>.
* Loading: Loading<35>.
* Testing: Testing<30>.
* Encoding: Encoding<5>.
* Decoding: Decoding<5>.

basic_types

* API documentation: API documentation<35>.
* Loading: Loading<36>.
* Testing: Testing<31>.

bayesian_ridge_regression

* API documentation: API documentation<36>.
* Loading: Loading<37>.
* Testing: Testing<32>.
* Features: Features<6>.
* Regressor representation::
* Diagnostics syntax::
* Options: Options<6>.

borda_ranker

* API documentation: API documentation<37>.
* Loading: Loading<38>.
* Testing: Testing<33>.
* Features: Features<7>.
* Scoring semantics::
* Usage: Usage<18>.
* Diagnostics syntax: Diagnostics syntax<2>.
* Options: Options<7>.
* Ranker representation::
* References: References<3>.

Usage

* Learning a ranker::
* Inspecting diagnostics::
* Ranking candidate items::
* Exporting the ranker::

bradley_terry_ranker

* API documentation: API documentation<38>.
* Loading: Loading<39>.
* Testing: Testing<34>.
* Features: Features<8>.
* Dataset requirements::
* Usage: Usage<19>.
* Diagnostics syntax: Diagnostics syntax<3>.
* Options: Options<8>.
* Ranker representation: Ranker representation<2>.
* References: References<4>.

Usage

* Learning a ranker: Learning a ranker<2>.
* Inspecting diagnostics: Inspecting diagnostics<2>.

Diagnostics syntax

* Ranking candidate items: Ranking candidate items<2>.
* Exporting the ranker: Exporting the ranker<2>.

c45_classifier

* API documentation: API documentation<39>.
* Loading: Loading<40>.
* Testing: Testing<35>.
* Implemented features::
* Learned tree representation::
* Limitations: Limitations<2>.
* References: References<5>.
* Usage: Usage<20>.

cartesian_products

* API documentation: API documentation<40>.
* Loading: Loading<41>.
* Testing: Testing<36>.

cbor

* Representation::
* Encoding: Encoding<6>.
* Decoding: Decoding<6>.
* API documentation: API documentation<41>.
* Loading: Loading<42>.
* Testing: Testing<37>.

character_sets

* API documentation: API documentation<42>.
* Loading: Loading<43>.
* Testing: Testing<38>.
* Usage: Usage<21>.

ccsds_frames

* Available entities::
* Representation: Representation<2>.
* Parsing and generating::
* Types::
* Facade helpers::
* API documentation: API documentation<43>.
* Loading: Loading<44>.
* Testing: Testing<39>.

ccsds_link_profiles

* Representation: Representation<3>.
* Public API::
* Parsing and generating: Parsing and generating<2>.
* Packet helpers::
* API documentation: API documentation<44>.
* Loading: Loading<45>.
* Testing: Testing<40>.

ccsds_packet_services

* Representation: Representation<4>.
* Packet-zone helpers::
* Telemetry transfer frame helpers::
* Advanced orbiting systems helpers::
* Cross-frame packet reassembly::
* Scope::
* API documentation: API documentation<45>.
* Loading: Loading<46>.
* Testing: Testing<41>.

ccsds_packetization

* Representation: Representation<5>.
* Packetization::
* Events::
* Idle packets::
* API documentation: API documentation<46>.
* Loading: Loading<47>.
* Testing: Testing<42>.

ccsds_packets

* Packet Structure::
* Representation: Representation<6>.
* Parsing::
* Generating::
* Accessor Predicates::
* Types and arbitrary generators::
* API documentation: API documentation<47>.
* Loading: Loading<48>.
* Testing: Testing<43>.

ccsds_tc_services

* Representation: Representation<7>.
* Scope: Scope<2>.
* Examples: Examples<166>.
* API documentation: API documentation<48>.
* Loading: Loading<49>.
* Testing: Testing<44>.

ccsds_time_codes

* Available entities: Available entities<2>.
* Representation: Representation<8>.
* Parsing and generating: Parsing and generating<3>.
* Unix time conversion::
* Types and arbitrary generators: Types and arbitrary generators<2>.
* API documentation: API documentation<49>.
* Loading: Loading<50>.
* Testing: Testing<45>.

ccsds_time_fields

* Representation: Representation<9>.
* Parsing and generating: Parsing and generating<4>.
* Descriptor helpers::
* API documentation: API documentation<50>.
* Loading: Loading<51>.
* Testing: Testing<46>.

classification_protocols

* Shared category::
* Diagnostics: Diagnostics<2>.
* Export header format: Export header format<2>.
* API documentation: API documentation<51>.
* Loading: Loading<52>.
* Testing: Testing<47>.
* Test datasets: Test datasets<2>.

clo_span_pattern_miner

* API documentation: API documentation<52>.
* Loading: Loading<53>.
* Testing: Testing<48>.
* Features: Features<9>.
* Options: Options<9>.
* Pattern miner representation: Pattern miner representation<2>.
* References: References<6>.

clustering_protocols

* API documentation: API documentation<53>.
* Loading: Loading<54>.
* Testing: Testing<49>.
* Test datasets: Test datasets<3>.

colley_ranker

* API documentation: API documentation<54>.
* Loading: Loading<55>.
* Testing: Testing<50>.
* Features: Features<10>.
* Scoring semantics: Scoring semantics<2>.
* Usage: Usage<22>.
* Diagnostics syntax: Diagnostics syntax<4>.
* Ranker representation: Ranker representation<3>.
* References: References<7>.

Usage

* Learning a ranker: Learning a ranker<3>.
* Inspecting diagnostics: Inspecting diagnostics<3>.
* Ranking candidate items: Ranking candidate items<3>.
* Exporting the ranker: Exporting the ranker<3>.

combinations

* API documentation: API documentation<55>.
* Loading: Loading<56>.
* Testing: Testing<51>.

command_line_options

* API documentation: API documentation<56>.
* Loading: Loading<57>.
* Testing: Testing<52>.
* Terminology::
* Defining option objects::
* Validating option definitions::
* Example option objects::
* Parsing command-line arguments::
* Generating help text::
* Help options::
* Parse options::
* Notes and tips::

core

* API documentation: API documentation<57>.
* Loading: Loading<58>.
* Testing: Testing<53>.

copeland_ranker

* API documentation: API documentation<58>.
* Loading: Loading<59>.
* Testing: Testing<54>.
* Features: Features<11>.
* Scoring semantics: Scoring semantics<3>.
* Usage: Usage<23>.
* Diagnostics syntax: Diagnostics syntax<5>.
* Options: Options<10>.
* Ranker representation: Ranker representation<4>.
* References: References<8>.

Usage

* Learning a ranker: Learning a ranker<4>.
* Inspecting diagnostics: Inspecting diagnostics<4>.
* Ranking candidate items: Ranking candidate items<4>.
* Exporting the ranker: Exporting the ranker<4>.

coroutining

* API documentation: API documentation<59>.
* Loading: Loading<60>.
* Testing: Testing<55>.
* Usage: Usage<24>.

crs_projections

* API documentation: API documentation<60>.
* Loading: Loading<61>.
* Testing: Testing<56>.
* Supported coordinate reference systems::
* Usage: Usage<25>.
* Notes::

csv

* API documentation: API documentation<61>.
* Loading: Loading<62>.
* Testing: Testing<57>.
* Usage: Usage<26>.

cuid2

* API documentation: API documentation<62>.
* Loading: Loading<63>.
* Testing: Testing<58>.
* Usage: Usage<27>.

cusum_anomaly_detector

* API documentation: API documentation<63>.
* Loading: Loading<64>.
* Testing: Testing<59>.
* Features: Features<12>.
* Options: Options<11>.
* Detector representation::
* Notes: Notes<2>.

datalog

* API documentation: API documentation<64>.
* Loading: Loading<65>.
* Testing: Testing<60>.
* Scope: Scope<3>.
* Public API overview::
* Basic usage::
* Limitations: Limitations<3>.

dates

* API documentation: API documentation<65>.
* Loading: Loading<66>.
* Testing: Testing<61>.

dates_tz

* API documentation: API documentation<66>.
* Loading: Loading<67>.
* Testing: Testing<62>.
* Usage: Usage<28>.
* Examples: Examples<167>.
* Notes: Notes<3>.

dbscan_clusterer

* API documentation: API documentation<67>.
* Loading: Loading<68>.
* Testing: Testing<63>.
* Features: Features<13>.
* Options: Options<12>.
* Clusterer representation: Clusterer representation<2>.
* References: References<9>.

dependents

* API documentation: API documentation<68>.
* Loading: Loading<69>.

deques

* API documentation: API documentation<69>.
* Loading: Loading<70>.
* Testing: Testing<64>.
* Usage: Usage<29>.

derangements

* API documentation: API documentation<70>.
* Loading: Loading<71>.
* Testing: Testing<65>.

dictionaries

* API documentation: API documentation<71>.
* Loading: Loading<72>.
* Testing: Testing<66>.
* Usage: Usage<30>.
* Credits: Credits<2>.

dif

* API documentation: API documentation<72>.
* Loading: Loading<73>.
* Testing: Testing<67>.
* Usage: Usage<31>.

dimension_reduction_protocols

* API documentation: API documentation<73>.
* Loading: Loading<74>.
* Common options::
* Testing: Testing<68>.
* Test datasets: Test datasets<4>.

eclat_pattern_miner

* API documentation: API documentation<74>.
* Loading: Loading<75>.
* Testing: Testing<69>.
* Features: Features<14>.
* Options: Options<13>.
* Pattern miner representation: Pattern miner representation<3>.
* References: References<10>.

edcg

* API documentation: API documentation<75>.
* Loading: Loading<76>.
* Testing: Testing<70>.
* Usage: Usage<32>.
* Introduction::
* Syntax::
* Declaration of Predicates::
* Declaration of Accumulators::
* Declaration of Passed Arguments::
* Additional documentation::

elastic_net_regression

* API documentation: API documentation<76>.
* Loading: Loading<77>.
* Testing: Testing<71>.
* Features: Features<15>.
* Regressor representation: Regressor representation<2>.
* Diagnostics syntax: Diagnostics syntax<6>.
* Options: Options<14>.

elo_ranker

* API documentation: API documentation<77>.
* Loading: Loading<78>.
* Testing: Testing<72>.
* Features: Features<16>.
* Rating semantics::
* Usage: Usage<33>.
* Options: Options<15>.
* Ranker representation: Ranker representation<5>.
* References: References<11>.

Usage

* Learning a ranker: Learning a ranker<5>.
* Inspecting diagnostics: Inspecting diagnostics<5>.
* Ranking candidate items: Ranking candidate items<5>.
* Exporting the ranker: Exporting the ranker<5>.

events

* API documentation: API documentation<78>.
* Loading: Loading<79>.

ewma_anomaly_detector

* API documentation: API documentation<79>.
* Loading: Loading<80>.
* Testing: Testing<73>.
* Features: Features<17>.
* Options: Options<16>.
* Detector representation: Detector representation<2>.
* Notes: Notes<4>.

expand_library_alias_paths

* API documentation: API documentation<80>.
* Loading: Loading<81>.
* Usage: Usage<34>.

expecteds

* API documentation: API documentation<81>.
* Loading: Loading<82>.
* Testing: Testing<74>.
* Usage: Usage<35>.
* See also::

format

* API documentation: API documentation<82>.
* Loading: Loading<83>.
* Testing: Testing<75>.
* Usage: Usage<36>.
* Portability: Portability<2>.

fp_growth_pattern_miner

* API documentation: API documentation<83>.
* Loading: Loading<84>.
* Testing: Testing<76>.
* Features: Features<18>.
* Options: Options<17>.
* Pattern miner representation: Pattern miner representation<4>.
* References: References<12>.

frequent_pattern_mining_protocols

* API documentation: API documentation<84>.
* Loading: Loading<85>.
* Testing: Testing<77>.
* Test datasets: Test datasets<5>.

gaussian_mixture_clusterer

* API documentation: API documentation<85>.
* Loading: Loading<86>.
* Testing: Testing<78>.
* Features: Features<19>.
* Gaussian-Mixture-Specific Prediction API::
* Options: Options<18>.
* Clusterer representation: Clusterer representation<3>.

gaussian_process_regression

* API documentation: API documentation<86>.
* Loading: Loading<87>.
* Testing: Testing<79>.
* Features: Features<20>.
* Regressor representation: Regressor representation<3>.
* Prediction API::
* Diagnostics syntax: Diagnostics syntax<7>.
* Options: Options<19>.

genint

* API documentation: API documentation<87>.
* Loading: Loading<88>.
* Testing: Testing<80>.
* Usage: Usage<37>.

gensym

* API documentation: API documentation<88>.
* Loading: Loading<89>.
* Testing: Testing<81>.
* Usage: Usage<38>.

geojson

* API documentation: API documentation<89>.
* Loading: Loading<90>.
* Testing: Testing<82>.
* Representation: Representation<10>.
* Examples: Examples<168>.
* Notes: Notes<5>.

geospatial

* API documentation: API documentation<90>.
* Loading: Loading<91>.
* Testing: Testing<83>.
* Available predicates::
* Notes: Notes<6>.
* Usage: Usage<39>.

git

* API documentation: API documentation<91>.
* Loading: Loading<92>.
* Testing: Testing<84>.
* Usage: Usage<40>.

glicko2_ranker

* API documentation: API documentation<92>.
* Loading: Loading<93>.
* Testing: Testing<85>.
* Features: Features<21>.
* Rating semantics: Rating semantics<2>.
* Usage: Usage<41>.
* Options: Options<20>.
* Diagnostics syntax: Diagnostics syntax<8>.
* Ranker representation: Ranker representation<6>.
* References: References<13>.

Usage

* Learning a ranker: Learning a ranker<6>.
* Inspecting diagnostics: Inspecting diagnostics<6>.
* Ranking candidate items: Ranking candidate items<6>.
* Exporting the ranker: Exporting the ranker<6>.

glicko2_periodic_ranker

* API documentation: API documentation<93>.
* Loading: Loading<94>.
* Testing: Testing<86>.
* Features: Features<22>.
* Rating semantics: Rating semantics<3>.
* Usage: Usage<42>.
* Options: Options<21>.
* Diagnostics syntax: Diagnostics syntax<9>.
* Ranker representation: Ranker representation<7>.
* References: References<14>.

Usage

* Learning a ranker: Learning a ranker<7>.
* Inspecting diagnostics: Inspecting diagnostics<7>.
* Ranking candidate items: Ranking candidate items<7>.
* Exporting the ranker: Exporting the ranker<7>.

gradient_boosting_classifier

* API documentation: API documentation<94>.
* Loading: Loading<95>.
* Testing: Testing<87>.
* Features: Features<23>.
* Options: Options<22>.
* Usage: Usage<43>.
* Classifier representation: Classifier representation<2>.
* References: References<15>.

Usage

* Learning a classifier::
* Making predictions::
* Exporting the classifier::

gradient_boosting_regression

* API documentation: API documentation<95>.
* Loading: Loading<96>.
* Testing: Testing<88>.
* Features: Features<24>.
* Regressor representation: Regressor representation<4>.
* Diagnostics syntax: Diagnostics syntax<10>.
* Options: Options<23>.

grammars

* API documentation: API documentation<96>.
* Loading: Loading<97>.
* Testing: Testing<89>.
* Usage: Usage<44>.

graphs

* API documentation: API documentation<97>.
* Loading: Loading<98>.
* Testing: Testing<90>.
* Usage: Usage<45>.

Usage

* Graph types::
* Creating graphs::
* Querying graphs::
* Undirected graphs::

gsp_pattern_miner

* API documentation: API documentation<98>.
* Loading: Loading<99>.
* Testing: Testing<91>.
* Features: Features<25>.
* Options: Options<24>.
* Pattern miner representation: Pattern miner representation<5>.
* References: References<16>.

hashes

* API documentation: API documentation<99>.
* Loading: Loading<100>.
* Testing: Testing<92>.
* Examples: Examples<169>.

hdbscan_clusterer

* API documentation: API documentation<100>.
* Loading: Loading<101>.
* Testing: Testing<93>.
* Features: Features<26>.
* Options: Options<25>.
* Clusterer representation: Clusterer representation<4>.

heaps

* API documentation: API documentation<101>.
* Loading: Loading<102>.
* Testing: Testing<94>.
* Usage: Usage<46>.
* Credits: Credits<3>.

hierarchical_clustering

* API documentation: API documentation<102>.
* Loading: Loading<103>.
* Testing: Testing<95>.
* Features: Features<27>.
* Options: Options<26>.
* Clusterer representation: Clusterer representation<5>.
* Additional API::
* Diagnostics: Diagnostics<3>.

hierarchies

* API documentation: API documentation<103>.
* Loading: Loading<104>.
* Testing: Testing<96>.

hmac

* API documentation: API documentation<104>.
* Loading: Loading<105>.
* Testing: Testing<97>.
* Examples: Examples<170>.

hodge_rank

* API documentation: API documentation<105>.
* Loading: Loading<106>.
* Testing: Testing<98>.
* Features: Features<28>.
* Scoring semantics: Scoring semantics<4>.
* Residual semantics::
* Usage: Usage<47>.
* Diagnostics syntax: Diagnostics syntax<11>.
* Ranker representation: Ranker representation<8>.
* References: References<17>.

Usage

* Learning a ranker: Learning a ranker<8>.
* Inspecting residuals::

hook_flows

* API documentation: API documentation<106>.
* Loading: Loading<107>.
* Testing: Testing<99>.
* Usage: Usage<48>.

hook_objects

* API documentation: API documentation<107>.
* Loading: Loading<108>.
* Testing: Testing<100>.
* Usage: Usage<49>.

Usage

* Using the Prolog backend adapter file expansion rules::
* Restoring the default compiler expansion workflow::
* Preventing applying any (other) user-defined expansion rules: Preventing applying any other user-defined expansion rules.
* Expanding grammar rules into clauses independently of the compiler::
* Using the expansion rules defined in a Prolog module::
* Wrap the contents of a plain Prolog file as an object::
* Outputting term-expansion results to a stream or a file::
* Printing entity predicate goals before or after calling them::
* Suppressing goals::

html

* API documentation: API documentation<108>.
* Loading: Loading<109>.
* Testing: Testing<101>.
* Generating a HTML document::
* Generating a HTML fragment::
* Working with callbacks to generate content::
* Working with custom elements::

ica_projection

* API documentation: API documentation<109>.
* Loading: Loading<110>.
* Testing: Testing<102>.
* Features: Features<29>.
* Options: Options<27>.
* Usage: Usage<50>.
* Dimension reducer representation::
* References: References<18>.

Usage

* Learning a reducer::
* Transforming new instances::
* Exporting and reusing the reducer::

ids

* API documentation: API documentation<110>.
* Loading: Loading<111>.
* Testing: Testing<103>.
* Usage: Usage<51>.

ieee_754

* Loading: Loading<112>.
* Testing: Testing<104>.
* Object model::
* Value representation::
* Public API: Public API<2>.
* Semantics::

intervals

* Practical limits::
* API documentation: API documentation<111>.
* Loading: Loading<113>.
* Testing: Testing<105>.
* Examples: Examples<171>.

iqr_anomaly_detector

* API documentation: API documentation<112>.
* Loading: Loading<114>.
* Testing: Testing<106>.
* Features: Features<30>.
* Options: Options<28>.
* Detector representation: Detector representation<3>.
* Notes: Notes<7>.

iso_639

* API documentation: API documentation<113>.
* Loading: Loading<115>.
* Testing: Testing<107>.

iso_3166

* API documentation: API documentation<114>.
* Loading: Loading<116>.
* Testing: Testing<108>.

iso_4217

* API documentation: API documentation<115>.
* Loading: Loading<117>.
* Testing: Testing<109>.

iso_9362

* API documentation: API documentation<116>.
* Loading: Loading<118>.
* Testing: Testing<110>.

iso_13616

* API documentation: API documentation<117>.
* Loading: Loading<119>.
* Testing: Testing<111>.

isolation_forest_anomaly_detector

* API documentation: API documentation<118>.
* Loading: Loading<120>.
* Testing: Testing<112>.
* Implemented features: Implemented features<2>.
* Options: Options<29>.
* Detector representation: Detector representation<4>.
* Limitations: Limitations<4>.
* References: References<19>.
* Usage: Usage<52>.

java

* API documentation: API documentation<119>.
* Loading: Loading<121>.
* Testing: Testing<113>.
* Usage: Usage<53>.
* Known issues: Known issues<11>.

json

* API documentation: API documentation<120>.
* Loading: Loading<122>.
* Testing: Testing<114>.
* Representation: Representation<11>.
* Encoding: Encoding<7>.
* Decoding: Decoding<7>.
* Known issues: Known issues<12>.

json_ld

* API documentation: API documentation<121>.
* Loading: Loading<123>.
* Testing: Testing<115>.
* Parsing: Parsing<2>.
* Generating: Generating<2>.
* Expansion::
* Compaction::
* Flattening::
* Supported Features::
* Representation: Representation<12>.

json_lines

* API documentation: API documentation<122>.
* Loading: Loading<124>.
* Testing: Testing<116>.
* Representation: Representation<13>.
* Encoding: Encoding<8>.
* Decoding: Decoding<8>.
* Known issues: Known issues<13>.

json_pointer

* API documentation: API documentation<123>.
* Loading: Loading<125>.
* Testing: Testing<117>.
* Representation: Representation<14>.
* Examples: Examples<172>.

json_rpc

* API documentation: API documentation<124>.
* Loading: Loading<126>.
* Testing: Testing<118>.
* Usage: Usage<54>.
* API summary::

Usage

* Constructing JSON-RPC 2.0 messages: Constructing JSON-RPC 2 0 messages.
* Standard error constructors::
* Encoding and decoding::
* Message classification::
* Field extraction::
* Stream I/O (client and server API): Stream I/O client and server API.
* Content-Length framed I/O (LSP/MCP protocols): Content-Length framed I/O LSP/MCP protocols.

API summary

* Message construction::
* Standard error responses::
* Encoding and decoding: Encoding and decoding<2>.
* Message classification: Message classification<2>.
* Field extraction: Field extraction<2>.
* Stream I/O::

json_schema

* API documentation: API documentation<125>.
* Loading: Loading<127>.
* Testing: Testing<119>.
* Schema Parsing::
* Validation::
* Supported Keywords::
* Known Limitations::

kcenters_clusterer

* API documentation: API documentation<126>.
* Loading: Loading<128>.
* Testing: Testing<120>.
* Features: Features<31>.
* Options: Options<30>.
* Diagnostics: Diagnostics<4>.
* Clusterer representation: Clusterer representation<6>.
* References: References<20>.

kemeny_young_ranker

* API documentation: API documentation<127>.
* Loading: Loading<129>.
* Testing: Testing<121>.
* Features: Features<32>.
* Usage: Usage<55>.
* Options: Options<31>.
* Scoring semantics: Scoring semantics<5>.
* Diagnostics syntax: Diagnostics syntax<12>.
* Ranker representation: Ranker representation<9>.
* Notes: Notes<8>.
* References: References<21>.

Usage

* Learning a ranker: Learning a ranker<9>.
* Inspecting the learned consensus::
* Ranking candidate items: Ranking candidate items<8>.

kernel_svm_classifier

* API documentation: API documentation<128>.
* Loading: Loading<130>.
* Testing: Testing<122>.
* Features: Features<33>.
* Options: Options<32>.
* Usage: Usage<56>.
* Classifier representation: Classifier representation<3>.
* References: References<22>.

Usage

* Learning a classifier: Learning a classifier<2>.
* Making predictions: Making predictions<2>.
* Exporting the classifier: Exporting the classifier<2>.

kernel_pca_projection

* API documentation: API documentation<129>.
* Loading: Loading<131>.
* Testing: Testing<123>.
* Features: Features<34>.
* Options: Options<33>.
* Usage: Usage<57>.
* Dimension reducer representation: Dimension reducer representation<2>.
* References: References<23>.

Usage

* Learning a reducer: Learning a reducer<2>.
* Transforming new instances: Transforming new instances<2>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<2>.

kmeans_clusterer

* API documentation: API documentation<130>.
* Loading: Loading<132>.
* Testing: Testing<124>.
* Features: Features<35>.
* Options: Options<34>.
* Diagnostics: Diagnostics<5>.
* Clusterer representation: Clusterer representation<7>.
* References: References<24>.

kmedians_clusterer

* API documentation: API documentation<131>.
* Loading: Loading<133>.
* Testing: Testing<125>.
* Features: Features<36>.
* Options: Options<35>.
* Diagnostics: Diagnostics<6>.
* Clusterer representation: Clusterer representation<8>.
* References: References<25>.

kmedoids_clusterer

* API documentation: API documentation<132>.
* Loading: Loading<134>.
* Testing: Testing<126>.
* Features: Features<37>.
* Options: Options<36>.
* Diagnostics: Diagnostics<7>.
* Clusterer representation: Clusterer representation<9>.
* References: References<26>.

kmodes_clusterer

* API documentation: API documentation<133>.
* Loading: Loading<135>.
* Testing: Testing<127>.
* Features: Features<38>.
* Options: Options<37>.
* Diagnostics: Diagnostics<8>.
* Clusterer representation: Clusterer representation<10>.
* References: References<27>.

knn_classifier

* API documentation: API documentation<134>.
* Loading: Loading<136>.
* Testing: Testing<128>.
* Features: Features<39>.
* Usage: Usage<58>.
* Options: Options<38>.
* Classifier representation: Classifier representation<4>.
* References: References<28>.

Usage

* Learning a Classifier: Learning a Classifier<2>.
* Making Predictions: Making Predictions<2>.
* Exporting the Classifier: Exporting the Classifier<2>.
* Using a learned classifier::

knn_distance_anomaly_detector

* API documentation: API documentation<135>.
* Loading: Loading<137>.
* Testing: Testing<129>.
* Features: Features<40>.
* Options: Options<39>.
* Detector representation: Detector representation<5>.
* References: References<29>.

knn_regression

* API documentation: API documentation<136>.
* Loading: Loading<138>.
* Testing: Testing<130>.
* Features: Features<41>.
* Regressor representation: Regressor representation<5>.
* Diagnostics syntax: Diagnostics syntax<13>.
* Options: Options<40>.

kprototypes_clusterer

* API documentation: API documentation<137>.
* Loading: Loading<139>.
* Testing: Testing<131>.
* Features: Features<42>.
* Options: Options<41>.
* Distance Function::
* Clusterer representation: Clusterer representation<11>.
* References: References<30>.

ksuid

* API documentation: API documentation<138>.
* Loading: Loading<140>.
* Testing: Testing<132>.
* Usage: Usage<59>.

lasso_regression

* API documentation: API documentation<139>.
* Loading: Loading<141>.
* Testing: Testing<133>.
* Features: Features<43>.
* Regressor representation: Regressor representation<6>.
* Diagnostics syntax: Diagnostics syntax<14>.
* Options: Options<42>.

lda_classifier

* API documentation: API documentation<140>.
* Loading: Loading<142>.
* Testing: Testing<134>.
* Features: Features<44>.
* Options: Options<43>.
* Usage: Usage<60>.
* Classifier representation: Classifier representation<5>.
* References: References<31>.

Usage

* Learning a classifier: Learning a classifier<3>.
* Making predictions: Making predictions<3>.
* Exporting the classifier: Exporting the classifier<3>.

lda_projection

* API documentation: API documentation<141>.
* Loading: Loading<143>.
* Testing: Testing<135>.
* Features: Features<45>.
* Options: Options<44>.
* Usage: Usage<61>.
* Dimension reducer representation: Dimension reducer representation<3>.
* References: References<32>.

Usage

* Learning a reducer: Learning a reducer<3>.
* Transforming new instances: Transforming new instances<3>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<3>.

linda

* API documentation: API documentation<142>.
* Loading: Loading<144>.
* Testing: Testing<136>.
* Usage: Usage<62>.
* Examples: Examples<173>.
* API Summary::
* Known issues: Known issues<14>.
* See also: See also<2>.

Usage

* Starting a server::
* Connecting a client::
* Tuple operations::
* Disconnecting::
* Timeout control::

Examples

* Producer-Consumer::
* Critical Region::
* Synchronization::

API Summary

* Server predicates::
* Client predicates::
* Tuple predicates (single/default server): Tuple predicates single/default server.
* Tuple predicates (multiple servers): Tuple predicates multiple servers.

linear_algebra

* API documentation: API documentation<143>.
* Loading: Loading<145>.
* Testing: Testing<137>.

linear_regression

* API documentation: API documentation<144>.
* Loading: Loading<146>.
* Testing: Testing<138>.
* Features: Features<46>.
* Regressor representation: Regressor representation<7>.
* Diagnostics syntax: Diagnostics syntax<15>.
* Options: Options<45>.

linear_svm_classifier

* API documentation: API documentation<145>.
* Loading: Loading<147>.
* Testing: Testing<139>.
* Features: Features<47>.
* Options: Options<46>.
* Usage: Usage<63>.
* Classifier representation: Classifier representation<6>.
* References: References<33>.

Usage

* Learning a classifier: Learning a classifier<4>.
* Making predictions: Making predictions<4>.
* Exporting the classifier: Exporting the classifier<4>.

listing

* API documentation: API documentation<146>.
* Loading: Loading<148>.
* Testing: Testing<140>.
* Usage: Usage<64>.

lof_anomaly_detector

* API documentation: API documentation<147>.
* Loading: Loading<149>.
* Testing: Testing<141>.
* Features: Features<48>.
* Options: Options<47>.
* Detector representation: Detector representation<6>.
* References: References<34>.

logging

* API documentation: API documentation<148>.
* Loading: Loading<150>.

logistic_regression_classifier

* API documentation: API documentation<149>.
* Loading: Loading<151>.
* Testing: Testing<142>.
* Features: Features<49>.
* Options: Options<48>.
* Usage: Usage<65>.
* Classifier representation: Classifier representation<7>.
* References: References<35>.

Usage

* Learning a classifier: Learning a classifier<5>.
* Making predictions: Making predictions<5>.
* Exporting the classifier: Exporting the classifier<5>.

loops

* API documentation: API documentation<150>.
* Loading: Loading<152>.
* Testing: Testing<143>.
* Usage: Usage<66>.

massey_ranker

* API documentation: API documentation<151>.
* Loading: Loading<153>.
* Testing: Testing<144>.
* Features: Features<50>.
* Scoring semantics: Scoring semantics<6>.
* Usage: Usage<67>.
* Diagnostics syntax: Diagnostics syntax<16>.
* Ranker representation: Ranker representation<10>.
* References: References<36>.

Usage

* Learning a ranker: Learning a ranker<10>.
* Inspecting diagnostics: Inspecting diagnostics<8>.
* Ranking candidate items: Ranking candidate items<9>.
* Exporting the ranker: Exporting the ranker<8>.

mcp_server

* API documentation: API documentation<152>.
* Loading: Loading<154>.
* Testing: Testing<145>.
* Usage: Usage<68>.
* Error handling: Error handling<3>.
* Protocol::
* Supported MCP methods::

Usage

* Implementing the tool protocol::
* Auto-dispatch vs. custom tool_call/3: Auto-dispatch vs custom tool_call/3.
* Output schemas (structured tool output): Output schemas structured tool output.
* Starting the server for debugging::
* MCP client configuration::
* Elicitation (interactive tools): Elicitation interactive tools.
* Prompts (prompt templates): Prompts prompt templates.
* Resources (data exposure): Resources data exposure.

memcached

* API documentation: API documentation<153>.
* Loading: Loading<155>.
* Testing: Testing<146>.
* Protocol Version::
* Features: Features<51>.
* Usage: Usage<69>.
* API Summary: API Summary<2>.
* Error Handling: Error Handling<2>.
* Key Format::
* Expiration Times::

Usage

* Connecting to a Memcached server::
* Storing data::
* Retrieving data::
* Check-and-Set (CAS): Check-and-Set CAS.
* Deleting data::
* Increment/Decrement::
* Touch and Get-and-Touch::
* Server management::
* Disconnecting: Disconnecting<2>.

API Summary

* Connection management::
* Storage commands::
* Retrieval commands::
* Deletion::
* Increment/Decrement: Increment/Decrement<2>.
* Touch::
* Server commands::

message_pack

* API documentation: API documentation<154>.
* Loading: Loading<156>.
* Testing: Testing<147>.
* Representation: Representation<15>.
* Notes: Notes<9>.

meta

* API documentation: API documentation<155>.
* Loading: Loading<157>.
* Testing: Testing<148>.
* Usage: Usage<70>.

meta_compiler

* API documentation: API documentation<156>.
* Loading: Loading<158>.
* Testing: Testing<149>.
* Usage: Usage<71>.
* Known issues: Known issues<15>.

mime_types

* API documentation: API documentation<157>.
* Loading: Loading<159>.
* Testing: Testing<150>.
* Usage: Usage<72>.

modified_z_score_anomaly_detector

* API documentation: API documentation<158>.
* Loading: Loading<160>.
* Testing: Testing<151>.
* Features: Features<52>.
* Options: Options<49>.
* Detector representation: Detector representation<7>.
* Notes: Notes<10>.

mutations

* API documentation: API documentation<159>.
* Loading: Loading<161>.
* Testing: Testing<152>.
* Usage: Usage<73>.

multisets

* API documentation: API documentation<160>.
* Loading: Loading<162>.
* Testing: Testing<153>.

nanoid

* API documentation: API documentation<161>.
* Loading: Loading<163>.
* Testing: Testing<154>.
* Usage: Usage<74>.

naive_bayes_classifier

* API documentation: API documentation<162>.
* Loading: Loading<164>.
* Testing: Testing<155>.
* Features: Features<53>.
* Usage: Usage<75>.
* Classifier representation: Classifier representation<8>.
* References: References<37>.

Usage

* Learning a Classifier: Learning a Classifier<3>.
* Making Predictions: Making Predictions<3>.
* Exporting the Classifier: Exporting the Classifier<3>.
* Using a learned classifier: Using a learned classifier<2>.

nearest_centroid_classifier

* API documentation: API documentation<163>.
* Loading: Loading<165>.
* Testing: Testing<156>.
* Features: Features<54>.
* Usage: Usage<76>.
* Options: Options<50>.
* Classifier representation: Classifier representation<9>.
* References: References<38>.

Usage

* Learning a Classifier: Learning a Classifier<4>.
* Making Predictions: Making Predictions<4>.
* Exporting the Classifier: Exporting the Classifier<4>.
* Using a learned classifier: Using a learned classifier<3>.

nested_dictionaries

* API documentation: API documentation<164>.
* Loading: Loading<166>.
* Testing: Testing<157>.
* Usage: Usage<77>.
* Curly term representation::

nmf_projection

* API documentation: API documentation<165>.
* Loading: Loading<167>.
* Testing: Testing<158>.
* Features: Features<55>.
* Options: Options<51>.
* Usage: Usage<78>.
* Dimension reducer representation: Dimension reducer representation<4>.
* References: References<39>.

optics_clusterer

* API documentation: API documentation<166>.
* Loading: Loading<168>.
* Testing: Testing<159>.
* Features: Features<56>.
* Options: Options<52>.
* Clusterer representation: Clusterer representation<12>.

optionals

* API documentation: API documentation<167>.
* Loading: Loading<169>.
* Testing: Testing<160>.
* Usage: Usage<79>.
* See also: See also<3>.

options

* API documentation: API documentation<168>.
* Loading: Loading<170>.
* Testing: Testing<161>.
* Usage: Usage<80>.

os

* API documentation: API documentation<169>.
* Loading: Loading<171>.
* Testing: Testing<162>.
* Known issues: Known issues<16>.

partitions

* API documentation: API documentation<170>.
* Loading: Loading<172>.
* Testing: Testing<163>.

pattern_mining_protocols

* API documentation: API documentation<171>.
* Loading: Loading<173>.
* Testing: Testing<164>.
* Common options: Common options<2>.
* Diagnostics: Diagnostics<9>.
* Related support libraries::

pca_projection

* API documentation: API documentation<172>.
* Loading: Loading<174>.
* Testing: Testing<165>.
* Features: Features<57>.
* Options: Options<53>.
* Usage: Usage<81>.
* Dimension reducer representation: Dimension reducer representation<5>.
* References: References<40>.

Usage

* Learning a reducer: Learning a reducer<4>.
* Transforming new instances: Transforming new instances<4>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<4>.

permutations

* API documentation: API documentation<173>.
* Loading: Loading<175>.
* Testing: Testing<166>.

plackett_luce_ranker

* API documentation: API documentation<174>.
* Loading: Loading<176>.
* Testing: Testing<167>.
* Features: Features<58>.
* Dataset requirements: Dataset requirements<2>.
* Usage: Usage<82>.
* Diagnostics syntax: Diagnostics syntax<17>.
* Options: Options<54>.
* Ranker representation: Ranker representation<11>.
* See also: See also<4>.

Usage

* Learning a ranker: Learning a ranker<11>.
* Inspecting diagnostics: Inspecting diagnostics<9>.

Diagnostics syntax

* Ranking candidate items: Ranking candidate items<10>.
* Exporting the ranker: Exporting the ranker<9>.

plackett_luce_last_ranker

* API documentation: API documentation<175>.
* Loading: Loading<177>.
* Testing: Testing<168>.
* Features: Features<59>.
* Dataset requirements: Dataset requirements<3>.
* Usage: Usage<83>.
* Diagnostics syntax: Diagnostics syntax<18>.
* Options: Options<55>.
* Ranker representation: Ranker representation<12>.
* See also: See also<5>.
* References: References<41>.

Usage

* Learning a ranker: Learning a ranker<12>.
* Inspecting diagnostics: Inspecting diagnostics<10>.

Diagnostics syntax

* Ranking candidate items: Ranking candidate items<11>.
* Exporting the ranker: Exporting the ranker<10>.

pls_projection

* API documentation: API documentation<176>.
* Loading: Loading<178>.
* Testing: Testing<169>.
* Features: Features<60>.
* Options: Options<56>.
* Usage: Usage<84>.
* Dimension reducer representation: Dimension reducer representation<6>.
* References: References<42>.

Usage

* Learning a reducer: Learning a reducer<5>.
* Transforming new instances: Transforming new instances<5>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<5>.

prefix_span_pattern_miner

* API documentation: API documentation<177>.
* Loading: Loading<179>.
* Testing: Testing<170>.
* Features: Features<61>.
* Options: Options<57>.
* Pattern miner representation: Pattern miner representation<6>.
* References: References<43>.

probabilistic_pca_projection

* API documentation: API documentation<178>.
* Loading: Loading<180>.
* Testing: Testing<171>.
* Features: Features<62>.
* Options: Options<58>.
* Usage: Usage<85>.
* Dimension reducer representation: Dimension reducer representation<7>.
* References: References<44>.

Usage

* Learning a reducer: Learning a reducer<6>.
* Transforming new instances: Transforming new instances<6>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<6>.

process

* API documentation: API documentation<179>.
* Loading: Loading<181>.
* Testing: Testing<172>.
* Usage: Usage<86>.

protobuf

* API documentation: API documentation<180>.
* Loading: Loading<182>.
* Testing: Testing<173>.
* Protocol Buffers Overview::
* Schema Representation::
* Data Representation::
* Encoding: Encoding<9>.
* Decoding: Decoding<9>.
* Wire Format Details::
* Binary Format Compatibility::
* Examples and Test Files::
* Further Reading::

Schema Representation

* Supported Types::
* Schema Examples: Schema Examples<2>.

Supported Types

* Scalar Value Types::
* Complex Types::

Encoding

* Simple Value Encoding::
* Message Encoding::
* Including Schema in Output::

Decoding

* Parsing with Schema Embedded::
* Parsing with Known Schema::
* Parsing from Different Sources::

Examples and Test Files

* person.proto: person proto.
* addressbook.proto: addressbook proto.
* Performance Considerations::

qda_classifier

* API documentation: API documentation<181>.
* Loading: Loading<183>.
* Testing: Testing<174>.
* Features: Features<63>.
* Options: Options<59>.
* Usage: Usage<87>.
* Classifier representation: Classifier representation<10>.
* References: References<45>.

Usage

* Learning a classifier: Learning a classifier<6>.
* Making predictions: Making predictions<6>.
* Exporting the classifier: Exporting the classifier<6>.

queues

* API documentation: API documentation<182>.
* Loading: Loading<184>.
* Testing: Testing<175>.
* Usage: Usage<88>.

random

* API documentation: API documentation<183>.
* Loading: Loading<185>.
* Testing: Testing<176>.
* Algorithms::
* Usage: Usage<89>.

random_forest_classifier

* API documentation: API documentation<184>.
* Loading: Loading<186>.
* Testing: Testing<177>.
* Features: Features<64>.
* Options: Options<60>.
* Classifier representation: Classifier representation<11>.
* References: References<46>.
* Usage: Usage<90>.

Usage

* Learning a Classifier: Learning a Classifier<5>.
* Making Predictions: Making Predictions<5>.
* Exporting the Classifier: Exporting the Classifier<5>.
* Using a Saved Classifier: Using a Saved Classifier<2>.
* Printing the Classifier: Printing the Classifier<2>.

random_forest_regression

* API documentation: API documentation<185>.
* Loading: Loading<187>.
* Testing: Testing<178>.
* Features: Features<65>.
* Regressor representation: Regressor representation<8>.
* Diagnostics syntax: Diagnostics syntax<19>.
* Options: Options<61>.

random_projection

* API documentation: API documentation<186>.
* Loading: Loading<188>.
* Testing: Testing<179>.
* Features: Features<66>.
* Options: Options<62>.
* Usage: Usage<91>.
* Dimension reducer representation: Dimension reducer representation<8>.
* References: References<47>.

Usage

* Learning a reducer: Learning a reducer<7>.
* Transforming new instances: Transforming new instances<7>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<7>.

rank_centrality

* API documentation: API documentation<187>.
* Loading: Loading<189>.
* Testing: Testing<180>.
* Features: Features<67>.
* Dataset requirements: Dataset requirements<4>.
* Usage: Usage<92>.
* Diagnostics syntax: Diagnostics syntax<20>.
* Options: Options<63>.
* Ranker representation: Ranker representation<13>.
* References: References<48>.

Usage

* Learning a ranker: Learning a ranker<13>.
* Inspecting diagnostics: Inspecting diagnostics<11>.

Diagnostics syntax

* Ranking candidate items: Ranking candidate items<12>.
* Exporting the ranker: Exporting the ranker<11>.

ranked_pairs

* API documentation: API documentation<188>.
* Loading: Loading<190>.
* Testing: Testing<181>.
* Features: Features<68>.
* Usage: Usage<93>.
* Diagnostics syntax: Diagnostics syntax<21>.
* Options: Options<64>.
* Scoring semantics: Scoring semantics<7>.
* Ranker representation: Ranker representation<14>.
* See also: See also<6>.

Usage

* Learning a ranker: Learning a ranker<14>.
* Inspecting diagnostics: Inspecting diagnostics<12>.
* Ranking candidate items: Ranking candidate items<13>.
* Inspecting locked pairs::
* Exporting the ranker: Exporting the ranker<12>.

ranking_protocols

* Protocol requirements::
* Shared categories::
* Diagnostics: Diagnostics<10>.
* Export header format: Export header format<3>.
* API documentation: API documentation<189>.
* Loading: Loading<191>.
* Testing: Testing<182>.
* Test datasets: Test datasets<6>.

reader

* API documentation: API documentation<190>.
* Loading: Loading<192>.
* Testing: Testing<183>.

recorded_database

* API documentation: API documentation<191>.
* Loading: Loading<193>.
* Testing: Testing<184>.
* Usage: Usage<94>.
* Known issues: Known issues<17>.

redis

* API documentation: API documentation<192>.
* Loading: Loading<194>.
* Testing: Testing<185>.
* Supported Redis Features::
* Credits: Credits<4>.
* Known issues: Known issues<18>.

Supported Redis Features

* Connection Management::
* String Operations::
* Key Operations::
* Hash Operations::
* List Operations::
* Set Operations::
* Sorted Set Operations::
* Usage Examples::

regression_protocols

* API documentation: API documentation<193>.
* Loading: Loading<195>.
* Testing: Testing<186>.
* Test datasets: Test datasets<7>.

regression_tree

* API documentation: API documentation<194>.
* Loading: Loading<196>.
* Testing: Testing<187>.
* Export header format: Export header format<4>.
* Features: Features<69>.
* Regressor representation: Regressor representation<9>.
* Diagnostics syntax: Diagnostics syntax<22>.
* Options: Options<65>.

regularized_bradley_terry_ranker

* API documentation: API documentation<195>.
* Loading: Loading<197>.
* Testing: Testing<188>.
* Features: Features<70>.
* Dataset requirements: Dataset requirements<5>.
* Usage: Usage<95>.
* Diagnostics syntax: Diagnostics syntax<23>.
* Options: Options<66>.
* Ranker representation: Ranker representation<15>.
* References: References<49>.

Usage

* Learning a ranker: Learning a ranker<15>.
* Inspecting diagnostics: Inspecting diagnostics<13>.

Diagnostics syntax

* Ranking candidate items: Ranking candidate items<14>.
* Exporting the ranker: Exporting the ranker<13>.

ridge_regression

* API documentation: API documentation<196>.
* Loading: Loading<198>.
* Testing: Testing<189>.
* Features: Features<71>.
* Regressor representation: Regressor representation<10>.
* Diagnostics syntax: Diagnostics syntax<24>.
* Options: Options<67>.

schulze_ranker

* API documentation: API documentation<197>.
* Loading: Loading<199>.
* Testing: Testing<190>.
* Features: Features<72>.
* Options: Options<68>.
* Strongest paths::
* Diagnostics syntax: Diagnostics syntax<25>.
* Ranker representation: Ranker representation<16>.

sequential_pattern_mining_protocols

* API documentation: API documentation<198>.
* Loading: Loading<200>.
* Testing: Testing<191>.
* Test datasets: Test datasets<8>.

sets

* API documentation: API documentation<199>.
* Loading: Loading<201>.
* Testing: Testing<192>.
* Usage: Usage<96>.
* Credits: Credits<5>.

sgd_classifier

* API documentation: API documentation<200>.
* Loading: Loading<202>.
* Testing: Testing<193>.
* Features: Features<73>.
* Options: Options<69>.
* Usage: Usage<97>.
* Classifier representation: Classifier representation<12>.
* References: References<50>.

Usage

* Learning a classifier: Learning a classifier<7>.
* Making predictions: Making predictions<7>.
* Exporting the classifier: Exporting the classifier<7>.

snowflakeid

* API documentation: API documentation<201>.
* Loading: Loading<203>.
* Testing: Testing<194>.
* Usage: Usage<98>.

sockets

* Design rationale::
* API documentation: API documentation<202>.
* Loading: Loading<204>.
* Testing: Testing<195>.
* Usage: Usage<99>.
* API Summary: API Summary<3>.
* Backend-specific notes::
* Known issues: Known issues<19>.

Usage

* Creating a client connection::
* Creating a server::
* Getting the current host name::

Backend-specific notes

* Stream representation::
* Binary and text modes::

spade_pattern_miner

* API documentation: API documentation<203>.
* Loading: Loading<205>.
* Testing: Testing<196>.
* Features: Features<74>.
* Options: Options<70>.
* Pattern miner representation: Pattern miner representation<7>.
* References: References<51>.

simulated_annealing

* API documentation: API documentation<204>.
* Loading: Loading<206>.
* Testing: Testing<197>.
* Features: Features<75>.
* Defining a problem::
* Options: Options<71>.
* Run statistics::
* Usage: Usage<100>.

Usage

* Defining a problem: Defining a problem<2>.
* Running the algorithm::
* Running with custom options::
* Running with statistics::
* Reproducible runs with seed::
* Reheating restarts::
* Auto-temperature estimation::
* Using a custom random number generator::

statistics

* API documentation: API documentation<205>.
* Loading: Loading<207>.
* Testing: Testing<198>.
* API overview::

API overview

* Aggregation::
* Extremes and Range::
* Central Tendency::
* Measures of Position / Quantiles::
* Measures of Dispersion::
* Measures of Shape::
* Measures of Association::
* Error Metrics::
* Normalization::
* Frequency / Counting::
* Validation: Validation<2>.

stemming

* API documentation: API documentation<206>.
* Loading: Loading<208>.
* Testing: Testing<199>.
* Usage: Usage<101>.
* Algorithms: Algorithms<2>.
* Choosing an Algorithm::
* Known Limitations: Known Limitations<2>.

Usage

* Porter Stemmer::
* Lovins Stemmer::

Algorithms

* Porter Stemmer: Porter Stemmer<2>.
* Lovins Stemmer: Lovins Stemmer<2>.

stomp

* Protocol Version: Protocol Version<2>.
* Features: Features<76>.
* API documentation: API documentation<207>.
* Loading: Loading<209>.
* Testing: Testing<200>.
* Usage: Usage<102>.
* API Summary: API Summary<4>.
* Connection Options::
* Send Options::
* Subscribe Options::
* Receive Options::
* Error Handling: Error Handling<3>.

Usage

* Connecting to a STOMP server::
* Sending messages::
* Subscribing to destinations::
* Receiving messages::
* Acknowledging messages::
* Unsubscribing::
* Transactions: Transactions<2>.
* Disconnecting: Disconnecting<3>.
* Heartbeat handling::
* Working with frames::

API Summary

* Connection management: Connection management<2>.
* Messaging::
* Acknowledgment::
* Transactions: Transactions<3>.
* Heartbeat::
* Frame inspection::

string_distance

* API documentation: API documentation<208>.
* Loading: Loading<210>.
* Testing: Testing<201>.
* Algorithms: Algorithms<3>.

strings

* API documentation: API documentation<209>.
* Loading: Loading<211>.
* Testing: Testing<202>.
* Predicates: Predicates<2>.

subsequences

* API documentation: API documentation<210>.
* Loading: Loading<212>.
* Testing: Testing<203>.

term_io

* API documentation: API documentation<211>.
* Loading: Loading<213>.
* Testing: Testing<204>.

thurstone_mosteller_ranker

* API documentation: API documentation<212>.
* Loading: Loading<214>.
* Testing: Testing<205>.
* Features: Features<77>.
* Scoring semantics: Scoring semantics<8>.
* Options: Options<72>.
* Diagnostics syntax: Diagnostics syntax<26>.
* Ranker representation: Ranker representation<17>.

time_scales

* API documentation: API documentation<213>.
* Loading: Loading<215>.
* Testing: Testing<206>.
* Features: Features<78>.
* Limitations: Limitations<5>.
* Representation: Representation<16>.
* Examples: Examples<174>.

timeout

* API documentation: API documentation<214>.
* Loading: Loading<216>.
* Testing: Testing<207>.
* Known issues: Known issues<20>.

tle_orbits

* API documentation: API documentation<215>.
* Loading: Loading<217>.
* Testing: Testing<208>.
* Representation: Representation<17>.
* Public API: Public API<3>.
* Examples: Examples<175>.
* Notes: Notes<11>.

toml

* API documentation: API documentation<216>.
* Loading: Loading<218>.
* Testing: Testing<209>.
* Status::
* Representation: Representation<18>.
* Examples: Examples<176>.
* Notes: Notes<12>.

Examples

* Parsing a TOML String::
* Parsing with Curly Table Representation::
* Generating TOML::

toon

* API documentation: API documentation<217>.
* Loading: Loading<219>.
* Testing: Testing<210>.
* Representation: Representation<19>.
* TOON format features::
* Usage examples::

Representation

* Objects: Objects<2>.
* Arrays::
* Primitives::

truncated_svd_projection

* API documentation: API documentation<218>.
* Loading: Loading<220>.
* Testing: Testing<211>.
* Features: Features<79>.
* Options: Options<73>.
* Usage: Usage<103>.
* Dimension reducer representation: Dimension reducer representation<9>.
* References: References<52>.

Usage

* Learning a reducer: Learning a reducer<8>.
* Transforming new instances: Transforming new instances<8>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<8>.

tsv

* API documentation: API documentation<219>.
* Loading: Loading<221>.
* Testing: Testing<212>.
* Usage: Usage<104>.

types

* API documentation: API documentation<220>.
* Loading: Loading<222>.
* Testing: Testing<213>.
* Type-checking: Type-checking<2>.
* Defining new types::
* Examples: Examples<177>.

tzif

* API documentation: API documentation<221>.
* Loading: Loading<223>.
* Testing: Testing<214>.
* Representation: Representation<20>.
* Zone identifier validation::
* Local Queries::
* Examples: Examples<178>.

ulid

* API documentation: API documentation<222>.
* Loading: Loading<224>.
* Testing: Testing<215>.
* Generating ULIDs::
* Type-checking ULIDs::

unicode_data

* Authors::
* License::
* Website::
* Description: Description<165>.
* Requirements: Requirements<6>.
* Usage: Usage<105>.
* Known issues: Known issues<21>.
* Acknowledgements::
* Files and API Summary::

Files and API Summary

* unicode_arabic_shaping.pl: unicode_arabic_shaping pl.
* unicode_bidi_mirroring.pl: unicode_bidi_mirroring pl.
* unicode_blocks.pl: unicode_blocks pl.
* unicode_case_folding.pl: unicode_case_folding pl.
* unicode_categories.pl: unicode_categories pl.
* unicode_cjk_radicals.pl: unicode_cjk_radicals pl.
* unicode_composition_exclusions.pl: unicode_composition_exclusions pl.
* unicode_core_properties.pl: unicode_core_properties pl.
* unicode_decomposition_type.pl: unicode_decomposition_type pl.
* unicode_derived_age.pl: unicode_derived_age pl.
* unicode_derived_bidi_class.pl: unicode_derived_bidi_class pl.
* unicode_derived_combining_class.pl: unicode_derived_combining_class pl.
* unicode_derived_core_properties.pl: unicode_derived_core_properties pl.
* unicode_derived_decomposition_type.pl: unicode_derived_decomposition_type pl.
* unicode_derived_east_asian_width.pl: unicode_derived_east_asian_width pl.
* unicode_derived_joining_group.pl: unicode_derived_joining_group pl.
* unicode_derived_joining_type.pl: unicode_derived_joining_type pl.
* unicode_derived_line_break.pl: unicode_derived_line_break pl.
* unicode_derived_normalization_props.pl: unicode_derived_normalization_props pl.
* unicode_derived_numeric_type.pl: unicode_derived_numeric_type pl.
* unicode_derived_numeric_values.pl: unicode_derived_numeric_values pl.
* unicode_hangul_syllable_type.pl: unicode_hangul_syllable_type pl.
* unicode_indic_matra_category.pl: unicode_indic_matra_category pl.
* unicode_indic_syllabic_category.pl: unicode_indic_syllabic_category pl.
* unicode_jamo.pl: unicode_jamo pl.
* unicode_name_aliases.pl: unicode_name_aliases pl.
* unicode_names.pl: unicode_names pl.
* unicode_prop_list.pl: unicode_prop_list pl.
* unicode_range_scripts.pl: unicode_range_scripts pl.
* unicode_script_extensions.pl: unicode_script_extensions pl.
* unicode_scripts.pl: unicode_scripts pl.
* unicode_special_casing.pl: unicode_special_casing pl.
* unicode_unihan_variants.pl: unicode_unihan_variants pl.
* unicode_version.pl: unicode_version pl.

union_find

* API documentation: API documentation<223>.
* Loading: Loading<225>.
* Testing: Testing<216>.
* Usage: Usage<106>.

url

* API documentation: API documentation<224>.
* Loading: Loading<226>.
* Testing: Testing<217>.

uuid

* API documentation: API documentation<225>.
* Loading: Loading<227>.
* Testing: Testing<218>.
* Generating version 1 UUIDs::
* Generating version 4 UUIDs::
* Generating version 3 UUIDs::
* Generating version 5 UUIDs::
* Generating version 7 UUIDs::
* Generating the Nil and Max UUIDs::

validations

* API documentation: API documentation<226>.
* Loading: Loading<228>.
* Testing: Testing<219>.
* Usage: Usage<107>.
* Comparison with the expecteds library::
* See also: See also<7>.

Comparison with the expecteds library

* Example; form validation with error accumulation: Example form validation with error accumulation.

wkt_wkb

* API documentation: API documentation<227>.
* Loading: Loading<229>.
* Testing: Testing<220>.
* Representation: Representation<21>.
* Sources and sinks::
* Examples: Examples<179>.
* Notes: Notes<13>.

yaml

* API documentation: API documentation<228>.
* Loading: Loading<230>.
* Testing: Testing<221>.
* API::
* Data Representation: Data Representation<2>.
* Examples: Examples<180>.
* Features: Features<80>.
* Supported YAML Features::
* Limitations: Limitations<6>.
* Error Handling: Error Handling<4>.
* File Organization::
* Test Files::
* Performance Considerations: Performance Considerations<2>.
* Integration with Other Libraries::
* Future Enhancements::
* See Also::

API

* Parsing: Parsing<3>.
* Generating: Generating<3>.
* Multi-Document Parsing::
* Multi-Document Generation::

Examples

* Parsing a Simple YAML String::
* Parsing a YAML List::
* Parsing a YAML File::
* Generating YAML from a Term::
* Generating YAML to a File::
* Working with Nested Structures::

z_score_anomaly_detector

* API documentation: API documentation<229>.
* Loading: Loading<231>.
* Testing: Testing<222>.
* Features: Features<81>.
* Options: Options<74>.
* Detector representation: Detector representation<8>.
* Notes: Notes<14>.

zippers

* API documentation: API documentation<230>.
* Loading: Loading<232>.
* Testing: Testing<223>.

Ports

* fcube::
* metagol::
* toychr::

fcube

* API documentation: API documentation<231>.
* Loading: Loading<233>.
* Testing: Testing<224>.

metagol

* API documentation: API documentation<232>.
* Loading: Loading<234>.
* Testing: Testing<225>.

toychr

* API documentation: API documentation<233>.
* Loading: Loading<235>.
* Testing: Testing<226>.

Contributions

* flags::
* iso8601::
* pddl_parser::
* verdi_neruda::
* xml_parser::

flags

* API documentation: API documentation<234>.
* Loading: Loading<236>.
* Testing: Testing<227>.

iso8601

* API documentation: API documentation<235>.
* Loading: Loading<237>.
* Testing: Testing<228>.

pddl_parser

* API documentation: API documentation<236>.
* Loading: Loading<238>.
* Testing: Testing<229>.

xml_parser

* API documentation: API documentation<237>.
* Loading: Loading<239>.
* Testing: Testing<230>.
* Known issues: Known issues<22>.


File: TheLogtalkHandbook-3.100.1.info,  Node: User Manual,  Next: Reference Manual,  Prev: Top,  Up: Top

1 User Manual
*************

* Menu:

* Declarative object-oriented programming::
* Main features::
* Nomenclature::
* Messages::
* Objects::
* Protocols::
* Categories::
* Predicates::
* Inheritance::
* Event-driven programming::
* Multi-threading programming::
* Error handling::
* Reflection::
* Writing and running applications::
* Printing messages and asking questions::
* Term and goal expansion::
* Documenting::
* Debugging::
* Performance: Performance<2>.
* Installing Logtalk::
* Prolog integration and migration::


File: TheLogtalkHandbook-3.100.1.info,  Node: Declarative object-oriented programming,  Next: Main features,  Up: User Manual

1.1 Declarative object-oriented programming
===========================================

Logtalk is a 'declarative object-oriented logic programming language'.
This means that Logtalk shares key concepts with other object-oriented
programming languages but abstracts and reinterprets these concepts in
the context of declarative logic programming.

The key concepts in 'declarative' object-oriented programming are
'encapsulation' and 'reuse patterns'.  Notably, the concept of 'mutable
state', which is an 'imperative' concept, is not a significant concept
in 'declarative' object-oriented programming.  Declarative
object-oriented programming concepts can be materialized in both logic
and functional languages.  In this section, we focus only on declarative
object-oriented logic programming.

The first key generalization of object-oriented programming concepts is
the concept of 'object' itself.  What an object encapsulates depends on
the 'base programming paradigm' where we apply object-oriented
programming concepts.  When these concepts are applied to an imperative
language, where mutable state and destructive assignment are central,
objects naturally encapsulate and abstract mutable state, providing
disciplined access and modification.  When these concepts are applied to
a declarative logic language such as Prolog, objects naturally
encapsulate predicates.  Therefore, an object can be seen as a 'theory',
expressed by a set of related predicates.  Theories are usually static,
and thus Logtalk objects are static by default.  This contrasts with
imperative object-oriented languages where usually classes are static
and objects are dynamic.  This view of an object as a set of predicates
also forgoes a distinction between 'data' and 'procedures' that is
central to imperative object-oriented languages but moot in declarative,
*note homoiconic: 7. logic languages.

The second key generalization concerns the relation between objects and
other entities such as protocols (interfaces) and ancestor objects.  The
idea is that entity relations define 'reuse patterns' and the 'roles'
played by the participating entities.  A common reuse pattern is
'inheritance'.  In this case, an entity inherits, and thus reuses,
resources from an ancestor entity.  In a reuse pattern, each
participating entity plays a specific 'role'.  The same entity, however,
can play multiple roles depending on its relations with other entities.
For example, an object can play the role of a class for its instances,
the role of a subclass for its superclasses, and the role of an instance
for its metaclass.  Another common reuse pattern is 'protocol
implementation'.  In this case, an object implementing a protocol reuses
its predicate declarations by providing an implementation for those
predicates and exposing those predicates to its clients.  An essential
consequence of this generalization is that protocols, objects, and
categories are first-class entities, while e.g.  'prototype', 'parent',
'class', 'instance', 'metaclass', 'subclass', 'superclass', or
'ancestor' are just 'roles' that an object can play.  When sending a
message to an object, the corresponding predicate 'declaration' and
predicate 'definition' lookup procedures (reuse patterns) depend on the
role or roles that the object plays (see the *note Inheritance: 8.
section for details).  Another consequence of this generalization is
that a language can provide multiple reuse patterns instead of selecting
a set of patterns and supporting this set as a design choice that
excludes other reuse patterns.  For example, most imperative
object-oriented languages are either class-based or prototype-based.  In
contrast, Logtalk supports both classes and prototypes by providing the
corresponding reuse patterns using objects as first-class entities
capable of playing multiple roles.


File: TheLogtalkHandbook-3.100.1.info,  Node: Main features,  Next: Nomenclature,  Prev: Declarative object-oriented programming,  Up: User Manual

1.2 Main features
=================

Several years ago, I decided that the best way to learn object-oriented
programming was to build my own object-oriented language.  Prolog being
always my favorite language, I chose to extend it with object-oriented
capabilities.  Strong motivation also comes from my frustration with
Prolog shortcomings for writing large applications.  Eventually this
work led to the Logtalk programming language as we know it today.  The
first system to use the name Logtalk appeared in February 1995.  At that
time, Logtalk was mainly an experiment in computational reflection with
a rudimentary runtime and no compiler.  Based on feedback by users and
on the author’s subsequent work, the name was retained and Logtalk was
created as a full programming language focusing on using object-oriented
concepts for code encapsulation and reuse.  Development started in
January 1998 with the first public alpha version released in July 1998.
The first stable release (2.0) was published in February 1999.
Development of the third generation of Logtalk started in 2012 with the
first public alpha version in August 2012 and the first stable release
(3.0.0) in January 2015.

Logtalk provides the following features:

* Menu:

* Integration of logic and object-oriented programming::
* Integration of event-driven and object-oriented programming::
* Support for component-based programming::
* Support for both prototype and class-based systems::
* Support for multiple object hierarchies::
* Separation between interface and implementation::
* Private, protected and public inheritance: Private protected and public inheritance.
* Private, protected and public object predicates: Private protected and public object predicates.
* Parametric objects::
* High level multi-threading programming support::
* Smooth learning curve::
* Compatibility with most Prolog systems and the ISO standard::
* Performance::
* Logtalk scope::


File: TheLogtalkHandbook-3.100.1.info,  Node: Integration of logic and object-oriented programming,  Next: Integration of event-driven and object-oriented programming,  Up: Main features

1.2.1 Integration of logic and object-oriented programming
----------------------------------------------------------

     Logtalk tries to bring together the main advantages of these two
     programming paradigms.  On one hand, the object orientation allows
     us to work with the same set of entities in the successive phases
     of application development, giving us a way of organizing and
     encapsulating the knowledge of each entity within a given domain.
     On the other hand, logic programming allows us to represent, in a
     declarative way, the knowledge we have of each entity.  Together,
     these two advantages allow us to minimize the distance between an
     application and its problem domain, making the writing and
     maintenance of programming easier and more productive.

     From a pragmatic perspective, Logtalk objects provide Prolog with
     the possibility of defining several namespaces, instead of the
     traditional Prolog single database, addressing some of the needs of
     large software projects.


File: TheLogtalkHandbook-3.100.1.info,  Node: Integration of event-driven and object-oriented programming,  Next: Support for component-based programming,  Prev: Integration of logic and object-oriented programming,  Up: Main features

1.2.2 Integration of event-driven and object-oriented programming
-----------------------------------------------------------------

     Event-driven programming enables the building of reactive systems,
     where computing which takes place at each moment is a result of the
     observation of occurring events.  This integration complements
     object-oriented programming, in which each computing is initiated
     by the explicit sending of a message to an object.  The user
     dynamically defines what events are to be observed and establishes
     monitors for these events.  This is especially useful when
     representing relationships between objects that imply constraints
     in the state of participating objects *note [Rumbaugh87]: 10, *note
     [Rumbaugh88]: 11, *note [Fornarino_et_al_89]: 12, *note [Razek92]:
     13.  Other common uses are reflective applications like code
     debugging or profiling *note [Maes87]: 14.  Predicates can be
     implicitly called when a spied event occurs, allowing programming
     solutions which minimize object coupling.  In addition, events
     provide support for behavioral reflection and can be used to
     implement the concepts of 'pointcut' and 'advice' found in
     Aspect-Oriented Programming.


File: TheLogtalkHandbook-3.100.1.info,  Node: Support for component-based programming,  Next: Support for both prototype and class-based systems,  Prev: Integration of event-driven and object-oriented programming,  Up: Main features

1.2.3 Support for component-based programming
---------------------------------------------

     Predicates can be encapsulated inside 'categories' which can be
     imported by any object, without any code duplication and
     irrespective of object hierarchies.  A category is a first-class
     encapsulation entity, at the same level as objects and protocols,
     which can be used as a component when building new objects.  Thus,
     objects may be defined through composition of categories, which act
     as fine-grained units of code reuse.  Categories may also extend
     existing objects.  Categories can be used to implement 'mixins' and
     'aspects'.  Categories allow for code reuse between unrelated
     objects, independent of hierarchy relations, in the same vein as
     protocols allow for interface reuse.


File: TheLogtalkHandbook-3.100.1.info,  Node: Support for both prototype and class-based systems,  Next: Support for multiple object hierarchies,  Prev: Support for component-based programming,  Up: Main features

1.2.4 Support for both prototype and class-based systems
--------------------------------------------------------

     Almost any (if not all) object-oriented languages available today
     are either class-based or prototype-based *note [Lieberman86]: 19,
     with a strong predominance of class-based languages.  Logtalk
     provides support for both hierarchy types.  That is, we can have
     both prototype and class hierarchies in the same application.
     Prototypes solve a problem of class-based systems where we
     sometimes have to define a class that will have only one instance
     in order to reuse a piece of code.  Classes solve a dual problem in
     prototype based systems where it is not possible to encapsulate
     some code to be reused by other objects but not by the
     encapsulating object.  Stand-alone objects, that is, objects that
     do not belong to any hierarchy, are a convenient solution to
     encapsulate code that will be reused by several unrelated objects.


File: TheLogtalkHandbook-3.100.1.info,  Node: Support for multiple object hierarchies,  Next: Separation between interface and implementation,  Prev: Support for both prototype and class-based systems,  Up: Main features

1.2.5 Support for multiple object hierarchies
---------------------------------------------

     Languages like Smalltalk-80 *note [Goldberg83]: 1c, Objective-C
     *note [Cox86]: 1d. and Java *note [Joy_et_al_00]: 1e. define a
     single hierarchy rooted in a class usually named ‘Object’.  This
     makes it easy to ensure that all objects share a common behavior
     but also tends to result in lengthy hierarchies where it is
     difficult to express objects which represent exceptions to default
     behavior.  In Logtalk we can have multiple, independent, object
     hierarchies.  Some of them can be prototype-based while others can
     be class-based.  Furthermore, stand-alone objects provide a simple
     way to encapsulate utility predicates that do not need or fit in an
     object hierarchy.


File: TheLogtalkHandbook-3.100.1.info,  Node: Separation between interface and implementation,  Next: Private protected and public inheritance,  Prev: Support for multiple object hierarchies,  Up: Main features

1.2.6 Separation between interface and implementation
-----------------------------------------------------

     This is an expected (should we say standard ?)  feature of almost
     any modern programming language.  Logtalk provides support for
     separating interface from implementation in a flexible way:
     predicate directives can be contained in an object, a category or a
     protocol (first-order entities in Logtalk) or can be spread in both
     objects, categories and protocols.


File: TheLogtalkHandbook-3.100.1.info,  Node: Private protected and public inheritance,  Next: Private protected and public object predicates,  Prev: Separation between interface and implementation,  Up: Main features

1.2.7 Private, protected and public inheritance
-----------------------------------------------

     Logtalk supports private, protected and public inheritance in a
     similar way to C++ *note [Stroustrup86]: 23, enabling us to
     restrict the scope of inherited, imported or implemented predicates
     (by default inheritance is public).


File: TheLogtalkHandbook-3.100.1.info,  Node: Private protected and public object predicates,  Next: Parametric objects,  Prev: Private protected and public inheritance,  Up: Main features

1.2.8 Private, protected and public object predicates
-----------------------------------------------------

     Logtalk supports data hiding by implementing private, protected and
     public object predicates in a way similar to C++ *note
     [Stroustrup86]: 23.  Private predicates can only be called from the
     container object.  Protected predicates can be called by the
     container object or by the container descendants.  Public
     predicates can be called from any object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Parametric objects,  Next: High level multi-threading programming support,  Prev: Private protected and public object predicates,  Up: Main features

1.2.9 Parametric objects
------------------------

     Object names can be compound terms (instead of atoms), providing a
     way to parameterize object predicates.  Parametric objects are
     implemented in a similar way to ‘L&O’ *note [McCabe92]: 28, ‘OL(P)’
     *note [Fromherz93]: 29. or ‘SICStus Objects’ *note [SICStus95]: 2a.
     (however, access to parameter values is done via a built-in method
     instead of making the parameters scope global over the whole
     object).  Parametric objects allows us to treat any predicate
     clause as defining an 'instantiation' of a parametric object.
     Thus, a parametric object allows us to encapsulate and associate
     any number of predicates with a compound term.


File: TheLogtalkHandbook-3.100.1.info,  Node: High level multi-threading programming support,  Next: Smooth learning curve,  Prev: Parametric objects,  Up: Main features

1.2.10 High level multi-threading programming support
-----------------------------------------------------

     High level multi-threading programming is available when running
     Logtalk with selected backend Prolog compilers, allowing objects to
     support both synchronous and asynchronous messages.  Logtalk allows
     programmers to take advantage of modern multi-processor and
     multi-core computers without bothering with the details of creating
     and destroying threads, implement thread communication, or
     synchronizing threads.


File: TheLogtalkHandbook-3.100.1.info,  Node: Smooth learning curve,  Next: Compatibility with most Prolog systems and the ISO standard,  Prev: High level multi-threading programming support,  Up: Main features

1.2.11 Smooth learning curve
----------------------------

     Logtalk has a smooth learning curve, by adopting standard Prolog
     syntax and by enabling an incremental learning and use of most of
     its features.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compatibility with most Prolog systems and the ISO standard,  Next: Performance,  Prev: Smooth learning curve,  Up: Main features

1.2.12 Compatibility with most Prolog systems and the ISO standard
------------------------------------------------------------------

     The Logtalk system has been designed to be compatible with most
     Prolog compilers and, in particular, with the ISO Prolog standard
     *note [ISO95]: 31.  It runs in almost any computer system with a
     modern Prolog compiler.


File: TheLogtalkHandbook-3.100.1.info,  Node: Performance,  Next: Logtalk scope,  Prev: Compatibility with most Prolog systems and the ISO standard,  Up: Main features

1.2.13 Performance
------------------

     The current Logtalk implementation works as a trans-compiler:
     Logtalk source files are first compiled to Prolog source files,
     which are then compiled by the chosen Prolog compiler.  Therefore,
     Logtalk performance necessarily depends on the *note backend Prolog
     compiler: 34.  The Logtalk compiler preserves the programmers
     choices when writing efficient code that takes advantage of tail
     recursion and first-argument indexing.

     As an object-oriented language, Logtalk can use both *note static
     binding: 35. and *note dynamic binding: 36. for matching messages
     and methods.  Furthermore, Logtalk entities (objects, protocols,
     and categories) are independently compiled, allowing for a very
     flexible programming development.  Entities can be edited,
     compiled, and loaded at runtime, without necessarily implying
     recompilation of all related entities.

     When dynamic binding is used, the Logtalk runtime engine implements
     caching of *note message lookups: 37. (including messages to 'self'
     and 'super' calls), ensuring a performance level close to what
     could be achieved when using static binding.

     For more detailed information on performance, see its dedicated
     *note section: 38.


File: TheLogtalkHandbook-3.100.1.info,  Node: Logtalk scope,  Prev: Performance,  Up: Main features

1.2.14 Logtalk scope
--------------------

Logtalk, being a superset of Prolog, shares with it the same preferred
areas of application but also extends them with those areas where
object-oriented features provide an advantage compared to plain Prolog.
Among these areas we have:

'Logic and object-oriented programming teaching and researching'

     Logtalk smooth learning curve, combined with support for both
     prototype and class-based programming, protocols, components or
     aspects via category-based composition, and other advanced
     object-oriented features allow a smooth introduction to
     object-oriented programming to people with a background in Prolog
     programming.  The distribution of Logtalk source code using an
     open-source license provides a framework for people to learn and
     then modify to try out new ideas on object-oriented programming
     research.  In addition, the Logtalk distribution includes plenty of
     programming examples that can be used in the classroom for teaching
     logic and object-oriented programming concepts.

'Structured knowledge representations and knowledge-based systems'

     Logtalk objects, coupled with event-driven programming features,
     enable easy implementation of frame-like systems and similar
     structured knowledge representations.

'Blackboard systems, agent-based systems, and systems with complex object relationships'

     Logtalk support for event-driven programming can provide a basis
     for the dynamic and reactive nature of blackboard type
     applications.

'Highly portable applications'

     Logtalk is compatible with most modern Prolog systems that support
     official and de facto standards.  Used as a way to provide Prolog
     with namespaces, it avoids the porting problems of most Prolog
     module systems.  Platform, operating system, or compiler specific
     code can be isolated from the rest of the code by encapsulating it
     in objects with well-defined interfaces.

'Alternative to a Prolog module system'

     Logtalk can be used as an alternative to a Prolog compiler module
     system.  Most Prolog applications that use modules can be converted
     into Logtalk applications, improving portability across Prolog
     systems and taking advantage of the stronger encapsulation and
     reuse framework provided by Logtalk object-oriented features.

'Integration with other programming languages'

     Logtalk support for most key object-oriented features helps users
     integrating Prolog with object-oriented languages like C++, Java,
     or Smalltalk by facilitating a high-level mapping between the two
     languages.


File: TheLogtalkHandbook-3.100.1.info,  Node: Nomenclature,  Next: Messages,  Prev: Main features,  Up: User Manual

1.3 Nomenclature
================

Depending on your logic programming and object-oriented programming
background (or lack of it), you may find Logtalk nomenclature either
familiar or at odds with the terms used in other languages.  In
addition, being a superset of Prolog, terms such as 'predicate' and
'method' are often used interchangeably.  Logtalk inherits most of its
nomenclature from Prolog and Smalltalk.

Note that the same terms can have different meanings in different
languages.  A good example is 'class'.  The support for meta-classes in
e.g.  Smalltalk translates to a concept of class that is different in
key aspects from the concept of class in e.g.  Java or C++.  Other terms
that can have different meanings are 'delegation' and 'forwarding'.
There are also cases where the same concept is found under different
names in some languages (e.g., 'self' and 'this') but that can also mean
different concepts in Logtalk and other languages.  Always be aware of
these differences and be cautious with assumptions carried from other
programming languages.

In this section, we map nomenclatures from Prolog and popular OOP
languages such as Smalltalk, C++, Java, and Python to the Logtalk
nomenclature.  The Logtalk distribution includes several examples of how
to implement common concepts found in other languages, complementing the
information in this section.  This Handbook also features a *note Prolog
interoperability section: 3e. and an extensive *note glossary: 3f.
providing the exact meaning of the names commonly used in Logtalk
programming.

* Menu:

* Prolog nomenclature::
* Smalltalk nomenclature::
* C++ nomenclature::
* Java nomenclature::
* Python nomenclature::


File: TheLogtalkHandbook-3.100.1.info,  Node: Prolog nomenclature,  Next: Smalltalk nomenclature,  Up: Nomenclature

1.3.1 Prolog nomenclature
-------------------------

Being a superset of Prolog, Logtalk inherits its nomenclature.  But
Logtalk also aims to fix several Prolog shortcomings, thus introducing
new concepts and refining existing Prolog concepts.  Logtalk
object-oriented nature also introduces names and concepts that are not
common when discussing logic programming semantics.  We mention here the
most relevant ones, notably those where semantics or common practice
differ.  Further details can be found elsewhere in this Handbook.

'arbitrary goals as directives'

     Although not ISO Prolog Core standard compliant, several Prolog
     systems accept using arbitrary goal as directives.  This is not
     supported in Logtalk source files.  Always use an *note
     initialization/1: 42. directive to wrap those goals.  This ensures
     that any initialization goals, which often have side-effects, are
     only called if the source file is successfully compiled and loaded.

'calling a predicate'

     Sending a *note message: 43. to an object is similar to 'calling a
     goal' with the difference that the actual predicate that is called
     is determined not just by the message 'term' but also by the object
     receiving the message and possibly its ancestors.  This is also
     different from calling a Prolog module predicate: a message may
     result e.g.  in calling a predicate *note inherited: 44. by the
     object but calling a module predicate requires the predicate to
     exist in (or be reexported by) the module.

'closed-world assumption semantics'

     Logtalk provides clear closed-world assumption semantics: messages
     or calls for declared but undefined predicates fail.  Messages or
     calls for unknown (i.e., not declared) predicates throw an error.
     Crucially, this semantics applies to both 'static' and 'dynamic'
     predicates.  But in Prolog workarounds are required to have a
     static predicate being known by the runtime without it being also
     defined (so that calling it would fail instead of throwing a
     predicate existence error).

'compiling and loading source files'

     Logtalk provides its own built-in predicates for *note compiling
     and loading: 45. source files.  It also provides convenient
     top-level interpreter *note shorthands: 46. for these and other
     frequent operations.  In general, the traditional Prolog built-in
     predicates and top-level interpreter shorthands cannot be used to
     load Logtalk source files.

'debugging'

     In most (if not all) Prolog systems, debugging support is a
     built-in feature made available using a set of built-in predicates
     like ‘trace/0’ and ‘spy/1’.  But in Logtalk the *note default
     debugger: 47. is a regular application, implemented using a public
     *note reflection API: 48.  This means that the debugger must be
     explicitly loaded (either automatically from a *note settings file:
     49. at startup or from the top-level).  It also means that the
     debugger can be easily extended or replaced by an alternative
     application.

'directive operators'

     Some Prolog systems declare directive names as operators (e.g.,
     ‘dynamic’, ‘multifile’, …).  This is not required by the ISO Prolog
     Core standard.  It’s a practice that should be avoided as it makes
     code non-portable.

'encapsulation'

     Logtalk enforces encapsulation of object predicates, generating a
     permission error when a predicate is not within the scope of the
     caller.  In contrast, most Prolog module systems allow any module
     predicate to be called by using explicit qualification, even if not
     exported.  Worse, some Prolog systems also allow defining clauses
     for a module predicate outside the module, without declaring the
     predicate as multifile, by simply writing clauses with explicit
     module-qualified heads.

'entity loading'

     When using Prolog modules, ‘use_module/1-2’ (or equivalent)
     directives both load the module files and declare that the
     (implicitly or explicitly) imported predicates can be used with
     implicit module qualification.  But Logtalk separates entity
     (object, protocol, category, or module) predicate 'usage'
     declarations (via *note uses/1: 4a. and *note uses/2: 4b. or its
     own *note use_module/1: 4c. and *note use_module/2: 4d. directives)
     from 'loading' goals (using the *note logtalk_load/1: 46. and *note
     logtalk_load/2: 4e. predicates), called using an explicit and
     disciplined approach from *note loader files: 4f.

'flags scope'

     The *note set_logtalk_flag/2: 50. 'directive' is always local to
     the entity or source file that contains it.  Only calls to the
     *note set_logtalk_flag/2: 51. 'predicate' set the global default
     value for a flag.  This distinction is lacking in Prolog (where
     directives usually have a global scope) and Prolog modules (where
     some flags are local to modules in some systems and global in other
     systems).

'meta-predicate call semantics'

     Logtalk provides consistent *note meta-predicate: 52. call
     semantics: meta-arguments are always called in the meta-predicate
     calling context.  This contrasts with Prolog module meta-predicates
     where the semantics of implicitly qualified calls are different
     from explicitly qualified calls.

'operators scope'

     Operators declared inside an entity (object, protocol, or category)
     are local to the entity.  But operators defined in a source file
     but outside an entity are global for compatibility with existing
     Prolog code.

'predicates scope'

     In plain Prolog, all predicates are visible.  In a Prolog module, a
     predicate can be exported or local.  In Logtalk, a predicate can be
     *note public: 53, *note protected: 54, *note private: 55, or *note
     local: 56.

'predicate declaration'

     Logtalk provides a clear distinction between *note declaring: 57. a
     predicate and *note defining: 58. a predicate.  This is a
     fundamental requirement for the concept of *note protocol: 59. (aka
     interface) in Logtalk: we must be able to 'declare' a predicate
     without necessarily 'defining' it.  This clear distinction is
     missing in Prolog and Prolog modules.  Notably, it’s a compiler
     error for a module to try to export a predicate that it does not
     define.

'predicate loading conflicts'

     Logtalk does not use predicate import/export semantics.  Thus,
     there are never conflicts when loading entities (objects,
     protocols, or categories) that declare the same public predicates.
     But attempting to load two Prolog modules that export the same
     predicate results in a conflict, usually a compilation error (this
     is especially problematic when the ‘use_module/1’ directive is
     used; e.g.  adding a new exported predicate can break applications
     that use the module but not the new predicate).


File: TheLogtalkHandbook-3.100.1.info,  Node: Smalltalk nomenclature,  Next: C++ nomenclature,  Prev: Prolog nomenclature,  Up: Nomenclature

1.3.2 Smalltalk nomenclature
----------------------------

The Logtalk name originates from a combination of the Prolog and
Smalltalk names.  Smalltalk had a significant influence on the design of
Logtalk and thus inherits some of its ideas and nomenclature.  The
following list relates the most commonly used Smalltalk terms with their
Logtalk counterparts.

'abstract class'

     Similar to Smalltalk, an abstract class is just a class not meant
     to be instantiated by not understanding a message to create
     instances.

'assignment statement'

     Logtalk, as a superset of Prolog, uses 'logic variables' and
     'unification' and thus provides no equivalent to the Smalltalk
     assignment statement.

'block'

     Logtalk supports lambda expressions and meta-predicates, which can
     be used to provide similar functionality to Smalltalk blocks.

'class'

     In Logtalk, 'class' is a just a 'role' that an object can play.
     This is similar to Smalltalk, where classes are also objects.

'class method'

     Class methods in Logtalk are simply instance methods declared and
     defined in the class metaclass.

'class variable'

     Logtalk objects, which can play the roles of class and instance,
     encapsulate predicates, not state.  Class variables, which in
     Smalltalk are really shared instance variables, can be emulated in
     a class by defining a predicate locally instead of defining it in
     the class instances.

'inheritance'

     While Smalltalk only supports single inheritance, Logtalk supports
     single inheritance, multiple inheritance, and multiple
     instantiation.

'instance'

     While in Smalltalk every object is an 'instance' of some class,
     objects in Logtalk can play different roles, including the role of
     a prototype where the concepts of instance and class don’t apply.
     Moreover, instances can be either created dynamically or defined
     statically.

'instance method'

     Instance methods in Logtalk are simply predicates declared and
     defined in a class and thus inherited by the class instances.

'instance variable'

     Logtalk being a 'declarative' language, objects encapsulate a set
     of predicates instead of encapsulating 'state'.  But different
     objects may provide different definitions of the same predicates.
     Mutable internal state as in Smalltalk can be emulated by using
     dynamic predicates.

'message'

     Similar to Smalltalk, a 'message' is a request for an operation,
     which is interpreted in Logtalk as a logic query, asking for the
     construction of a proof that something is true.

'message selector'

     Logtalk uses the predicate template (i.e., the predicate callable
     term with all its arguments unbound) as a message selector.  The
     actual type of the message arguments is not considered.  Like
     Smalltalk, Logtalk uses 'single dispatch' on the message receiver.

'metaclass'

     Metaclasses are optional in Logtalk (except for a root class) and
     can be shared by several classes.  When metaclasses are used,
     infinite regression is simply avoided by making a class an instance
     of itself.

'method'

     Same as in Smalltalk, a 'method' is the actual code (i.e.,
     predicate definition) that is run to answer a message.  Logtalk
     uses the words 'method' and 'predicate' interchangeably.

'method categories'

     There is no support in Logtalk for partitioning the methods of an
     object into different categories.  The Logtalk concept of
     'category' (a first-class entity) was, however, partially inspired
     by Smalltalk method categories.

'object'

     Unlike Smalltalk, where 'everything' is an object, Logtalk language
     constructs include both 'terms' (as in Prolog representing e.g.
     numbers and structures) and three first-class entities: objects,
     protocols, and categories.

'pool variables*'

     Logtalk, as a superset of Prolog, uses 'predicates' with no
     distinction between 'variables' and 'methods'.  Categories can be
     used to share a set of predicate definitions between any number of
     objects.

'protocol'

     In Smalltalk, an object 'protocol' is the set of messages it
     understands.  The same concept applies in Logtalk.  But Logtalk
     also supports protocols as first-class entities where a protocol
     can be implemented by multiple objects and an object can implement
     multiple protocols.

'self'

     Logtalk uses the same definition of 'self' found in Smalltalk: the
     object that received the message being processed.  Note, however,
     that 'self' is not a keyword in Logtalk but is implicit in the
     *note (;;)/1: 5c. message to 'self' control construct.

'subclass'

     Same definition in Logtalk.

'super'

     As in Smalltalk, the idea of 'super' is to allow calling an
     inherited predicate (that is usually being redefined).  Note,
     however, that 'super' is not a keyword in Logtalk, which provides
     instead a *note (^^)/1: 5d. 'super' call control construct.

'superclass'

     Same definition in Logtalk.  But while in Smalltalk a class can
     only have a single superclass, Logtalk support for multiple
     inheritance allows a class to have multiple superclasses.


File: TheLogtalkHandbook-3.100.1.info,  Node: C++ nomenclature,  Next: Java nomenclature,  Prev: Smalltalk nomenclature,  Up: Nomenclature

1.3.3 C++ nomenclature
----------------------

There are several C++ glossaries available on the Internet.  The list
that follows relates the most commonly used C++ terms with their Logtalk
equivalents.

'abstract class'

     Logtalk uses an 'operational' definition of abstract class: any
     class that does not inherit a method for creating new instances can
     be considered an abstract class.  Moreover, Logtalk supports *note
     interfaces/protocols: 59, which are often a better way to provide
     the functionality of C++ abstract classes.

'base class'

     Logtalk uses the term *note superclass: 60. with the same meaning.

'data member'

     Logtalk uses *note predicates: 61. for representing both behavior
     and data.

'constructor function'

     There are no special methods for creating new objects in Logtalk.
     Instead, Logtalk provides a built-in predicate, *note
     create_object/4: 62, which can be used as a building block to
     define more sophisticated object creation predicates.

'derived class'

     Logtalk uses the term *note subclass: 63. with the same meaning.

'destructor function'

     There are no special methods for deleting new objects in Logtalk.
     Instead, Logtalk provides a built-in predicate, *note
     abolish_object/1: 64, which is often used to define more
     sophisticated object deletion predicates.

'friend function'

     Not supported in Logtalk.  Nevertheless, see the User Manual
     section on *note meta-predicates: 65.

'instance'

     In Logtalk, an instance can be either created dynamically at
     runtime or defined statically in a source file in the same way as
     classes.

'member'

     Logtalk uses the term *note predicate: 61.

'member function'

     Logtalk uses *note predicates: 61. for representing both behavior
     and data.

'namespace'

     Logtalk does not support multiple identifier namespaces.  All
     Logtalk entity identifiers share the same namespace (Logtalk
     entities are objects, categories, and protocols).

'nested class'

     Logtalk does not support nested classes.

'static member'

     Logtalk does not support a ‘static’ keyword.  But the equivalent of
     static members can be declared in a class metaclass.

'template'

     Logtalk supports *note parametric objects: 66, which allows you to
     get the similar functionality of templates at runtime.

'this'

     Logtalk uses the built-in context method *note self/1: 67. for
     retrieving the instance that received the message being processed.
     Logtalk also provides a *note this/1: 68. method but for returning
     the class containing the method being executed.  Why the name
     clashes?  Well, the notion of *note self: 69. was inherited from
     Smalltalk, which predates C++.

'virtual member function'

     There is no ‘virtual’ keyword in Logtalk.  Any inherited or
     imported predicate can be redefined (either overridden or
     specialized).  Logtalk can use *note static binding: 35. or *note
     dynamic binding: 36. for locating both method declarations and
     method definitions.  Moreover, methods that are declared but not
     defined simply fail when called (as per the *note closed-world
     assumption: 6a.).


File: TheLogtalkHandbook-3.100.1.info,  Node: Java nomenclature,  Next: Python nomenclature,  Prev: C++ nomenclature,  Up: Nomenclature

1.3.4 Java nomenclature
-----------------------

There are several Java glossaries available on the Internet.  The list
that follows relates the most commonly used Java terms with their
Logtalk equivalents.

'abstract class'

     Logtalk uses an 'operational' definition of abstract class: any
     class that does not inherit a method for creating new instances is
     an abstract class.  I.e.  there is no ‘abstract’ keyword in
     Logtalk.

'abstract method'

     In Logtalk, you may simply declare a method (*note predicate: 61.)
     in a class without defining it, leaving its definition to some
     descendant subclass.

'assertion'

     There is no ‘assertion’ keyword in Logtalk.  Assertions are
     supported using Logtalk compilation hooks and developer tools.

'class'

     Logtalk objects can play the role of classes, instances, or
     protocols (depending on their relations with other objects).

'extends'

     There is no ‘extends’ keyword in Logtalk.  Class inheritance is
     indicated using 'specialization relations'.  Moreover, the 'extends
     relation' is used in Logtalk to indicate protocol, category, or
     prototype extension.

'interface'

     Logtalk uses the term *note protocol: 59. with a similar meaning.
     But note that Logtalk objects and categories declared as
     implementing a protocol are not required to provide definitions for
     the declared predicates (*note closed-world assumption: 6a.).

'callback method'

     Logtalk supports *note event-driven programming: 6d, the most
     common usage context of callback methods.  Callback methods can
     also be implemented using *note meta-predicates: 52.

'constructor'

     There are no special methods for creating new objects in Logtalk.
     Instead, Logtalk provides a built-in predicate, *note
     create_object/4: 62, which is often used to define more
     sophisticated object creation predicates.

'final'

     There is no ‘final’ keyword in Logtalk.  Predicates can always be
     redeclared and redefined in subclasses (and instances!).

'inner class'

     Inner classes are not supported in Logtalk.

'instance'

     In Logtalk, an instance can be either created dynamically at
     runtime or defined statically in a source file in the same way as
     classes.

'method'

     Logtalk uses the term *note predicate: 61. interchangeably with the
     term 'method'.

'method call'

     Logtalk usually uses the expression 'message-sending' for method
     calls, true to its Smalltalk heritage.

'method signature'

     Logtalk selects the method/predicate to execute in order to answer
     a method call based only on the method name and number of
     arguments.  Logtalk (and Prolog) are not typed languages in the
     same sense as Java.

'package'

     There is no concept of packages in Logtalk.  All Logtalk entities
     (objects, protocols, categories) share a single namespace.  But
     Logtalk does support a concept of *note library: 6e. that allows
     grouping of entities whose source files share a common path prefix.

'reflection'

     Logtalk features a 'white box' API supporting 'structural'
     reflection about *note entity contents: 6f, a 'black box' API
     supporting 'behavioral' reflection about *note object protocols:
     70, and an *note events: 71. API for reasoning about messages
     exchanged at runtime.

'static'

     There is no ‘static’ keyword in Logtalk.  See the entries below on
     'static method' and 'static variable'.

'static method'

     Static methods may be implemented in Logtalk by using a *note
     metaclass: 72. for the class and defining the static methods in the
     metaclass.  I.e.  static methods are simply instance methods of the
     class metaclass.

'static variable'

     Static variables are 'shared instance variables' and can simply be
     both declared and defined in a class.  The built-in database
     methods can be used to implement destructive updates if necessary
     by accessing and updating a single clause of a dynamic predicate
     stored in the class.

'super'

     Instead of a ‘super’ keyword, Logtalk provides a super operator and
     control construct, *note (^^)/1: 5d, for calling overridden
     methods.

'synchronized'

     Logtalk supports *note multi-threading programming: 73. in selected
     Prolog compilers, including a *note synchronized/1: 74. predicate
     directive.  Logtalk allows you to synchronize a predicate or a set
     of predicates using per-predicate or per-predicate-set 'mutexes'.

'this'

     Logtalk uses the built-in context method *note self/1: 67. for
     retrieving the instance that received the message being processed.
     Logtalk also provides a *note this/1: 68. method but for returning
     the class containing the method being executed.  Why the name
     clashes?  Well, the notion of *note self: 69. was inherited from
     Smalltalk, which predates C++.


File: TheLogtalkHandbook-3.100.1.info,  Node: Python nomenclature,  Prev: Java nomenclature,  Up: Nomenclature

1.3.5 Python nomenclature
-------------------------

The list that follows relates the commonly used Python concepts with
their Logtalk equivalents.

'abstract class'

     Logtalk uses a different definition of abstract class: a class that
     does not inherit a method for creating new instances.  Notably, the
     presence of 'abstract methods' (i.e., predicates that are declared
     but not defined) does not make a class abstract.

'abstract method'

     Logtalk uses the term 'predicate' interchangeably with 'method'.
     Predicates can be declared without also being defined in an object
     (or category).

'class'

     Logtalk objects can play the role of classes, instances, or
     protocols (depending on their relations with other objects).

'dictionary'

     There is no native, built-in associative data type.  But the
     library provides several implementations of a dictionary protocol.

'function'

     The closest equivalent is a predicate defined in ‘user’, a
     pseudo-object for predicates not defined in regular objects, and
     thus callable from anywhere without requiring a scope directive.

'function object'

     Predicate calls (goals) can be passed or returned from other
     predicates and unified with other terms (e.g., variables).

'import path'

     Logtalk uses the term 'library' to refer to a directory of source
     files and supports defining aliases (symbolic names) to library
     paths to abstract the actual locations.

'lambda'

     Logtalk natively supports lambda expressions.

'list'

     Lists are compound terms with native syntax support.

'list comprehensions'

     There is no native, built-in support for list comprehensions.  But
     the standard ‘findall/3’ predicate can be used to construct a list
     by calling a goal that generates the list elements.

'loader'

     Logtalk uses the term 'loader' to refer to source files whose main
     or sole purpose is to load other source files.

'loop'

     There are no native loop control constructs based on a counter.
     But the library provides implementations of several loop
     predicates.

'metaclass'

     Logtalk objects play the role of metaclasses when instantiated by
     objects that play the role of classes.

'method'

     Logtalk uses the terms 'method' and 'predicate' interchangeably.
     Predicates can be defined in objects (and categories).  The value
     of 'self' is implicit, unlike in Python where it is the first
     parameter of any method.

'method resolution order'

     Logtalk uses a depth-first algorithm to lookup method (predicate)
     declarations and definitions.  It’s possible to use predicate
     'aliases' to access predicate declarations and definitions other
     than the first ones found by the lookup algorithm.

'object'

     Objects are first-class entities that can play multiple roles,
     including prototype, class, instance, and metaclass.

'package'

     Logtalk uses the term 'library' to refer to a directory of source
     files defining objects, categories, and protocols.

'set'

     There is no native, built-in set type.  But the library provides
     set implementations.

'string'

     The interpretation of text between double-quotes depends on the
     ‘double_quotes’ flag.  Depending on this flag, double-quoted text
     can be interpreted as a list of characters, a list of character
     codes, or an atom.  Some backend Prolog compilers allow
     double-quoted text to be interpreted as a string in the Python
     sense.

'tuple'

     Compound terms can be used to represent tuples of any complexity.

'variable'

     Logtalk works with 'logical variables', which are close to the
     mathematical concept of variables and distinct from variables in
     imperative or imperative-based OOP languages where they are
     symbolic names for memory locations.  Logical variables can be
     'unified' with any term, including other variables.

'while loop'

     The built-in ‘forall/2’ predicate implements a 'generate-and-test'
     loop.


File: TheLogtalkHandbook-3.100.1.info,  Node: Messages,  Next: Objects,  Prev: Nomenclature,  Up: User Manual

1.4 Messages
============

Messages allow us to ask an object to prove a goal and must always match
a declared predicate within the scope of the 'sender' object.  Note that
sending a message is fundamentally different from calling a predicate.
When calling a predicate, the caller decides implicitly which predicate
definition will be executed.  When sending a message, it is the
receiving object, not the sender, that decides which predicate
definition (if any) will be called to answer the message.  The predicate
definition that is used to answer a message depends on the relations
between the object and its imported categories and ancestor objects (if
any).  See the *note Inheritance: 8. section for details on the
predicate declaration and predicate definition lookup procedures.

When a message corresponds to a *note meta-predicate: 52, the
meta-arguments are always called in the context of the object (or
category) sending the message.

Logtalk uses nomenclature similar to other object-oriented programming
languages such as Smalltalk.  Therefore, the terms 'query' and 'message'
are used interchangeably when referring to a declared predicate that is
part of an object interface.  Likewise, the terms 'predicate' and
'method' are used interchangeably when referring to the predicate
definition (inside an object or category) that is called to answer a
message.

* Menu:

* Operators used in message-sending::
* Sending a message to an object::
* Delegating a message to an object::
* Sending a message to self::
* Broadcasting::
* Calling imported and inherited predicates::
* Message sending and event generation::
* Sending a message from a module::
* Message sending performance::


File: TheLogtalkHandbook-3.100.1.info,  Node: Operators used in message-sending,  Next: Sending a message to an object,  Up: Messages

1.4.1 Operators used in message-sending
---------------------------------------

Logtalk declares the following operators for the message-sending control
constructs:

     :- op(600, xfy, ::).
     :- op(600,  fy, ::).
     :- op(600,  fy, ^^).

It is assumed that these operators remain active (once the Logtalk
compiler and runtime files are loaded) until the end of the Prolog
session (this is the usual behavior of most Prolog compilers).  Note
that these operator definitions are compatible with the predefined
operators in the Prolog ISO standard.


File: TheLogtalkHandbook-3.100.1.info,  Node: Sending a message to an object,  Next: Delegating a message to an object,  Prev: Operators used in message-sending,  Up: Messages

1.4.2 Sending a message to an object
------------------------------------

Sending a message to an object is accomplished by using the *note
(;;)/2: 7e. control construct:

     ..., Object::Message, ...

The message must match a public predicate declared for the receiving
object.  The message may also correspond to a protected or private
predicate if the 'sender' matches the predicate scope container.  If the
predicate is declared but not defined, the message simply fails (as per
the *note closed-world assumption: 6a.).


File: TheLogtalkHandbook-3.100.1.info,  Node: Delegating a message to an object,  Next: Sending a message to self,  Prev: Sending a message to an object,  Up: Messages

1.4.3 Delegating a message to an object
---------------------------------------

It is also possible to send a message to an object while preserving the
original 'sender' and 'meta-call context' by using the *note []/1: 81.
delegation control construct:

     ..., [Object::Message], ....

This control construct can only be used within objects and categories
(at the top-level interpreter, the 'sender' is always the pseudo-object
‘user’ so using this control construct would be equivalent to using the
‘(::)/2’ message-sending control construct).


File: TheLogtalkHandbook-3.100.1.info,  Node: Sending a message to self,  Next: Broadcasting,  Prev: Delegating a message to an object,  Up: Messages

1.4.4 Sending a message to 'self'
---------------------------------

While defining a predicate, we sometimes need to send a message to
'self', i.e., to the same object that has received the original message.
This is done in Logtalk through the *note (;;)/1: 5c. control construct:

     ..., ::Message, ....

The message must match either a public or protected predicate declared
for the receiving object or a private predicate within the scope of the
'sender' otherwise an error will be thrown.  If the message is sent from
inside a category or if we are using private inheritance, then the
message may also match a private predicate.  Again, if the predicate is
declared but not defined, the message simply fails (as per the *note
closed-world assumption: 6a.).


File: TheLogtalkHandbook-3.100.1.info,  Node: Broadcasting,  Next: Calling imported and inherited predicates,  Prev: Sending a message to self,  Up: Messages

1.4.5 Broadcasting
------------------

In the Logtalk context, 'broadcasting' is interpreted as the sending of
several messages to the same object.  This can be achieved by using the
message-sending control construct described above.  However, for
convenience, Logtalk implements an extended syntax for message-sending
that may improve program readability in some cases.  This extended
syntax uses the ‘(,)/2’, ‘(;)/2’, and ‘(->)/2’ control constructs (plus
the ‘(*->)/2’ soft-cut control construct when provided by the backend
Prolog compiler).  For example, if we wish to send several messages to
the same object, we can write:

     | ?- Object::(Message1, Message2, ...).

This is semantically equivalent to:

     | ?- Object::Message1, Object::Message2, ... .

This extended syntax may also be used with the ‘(::)/1’ message-sending
control construct.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling imported and inherited predicates,  Next: Message sending and event generation,  Prev: Broadcasting,  Up: Messages

1.4.6 Calling imported and inherited predicates
-----------------------------------------------

When redefining a predicate, sometimes we need to call the inherited
definition in the new code.  This functionality, introduced by the
Smalltalk language through the ‘super’ primitive, is available in
Logtalk using the *note (^^)/1: 5d. control construct:

     ..., ^^Predicate, ....

Most of the time we will use this control construct by instantiating the
pattern:

     Predicate :-
         ...,            % do something
         ^^Predicate,    % call inherited definition
         ... .           % do something more

This control construct is generalized in Logtalk where it may be used to
call any imported or inherited predicate definition.  This control
construct may be used within objects and categories.  When combined with
*note static binding: 35, this control construct allows imported and
inherited predicates to be called with the same performance as local
predicates.  As with the message-sending control constructs, the
‘(^^)/1’ call simply fails when the predicate is declared but not
defined (as per the *note closed-world assumption: 6a.).


File: TheLogtalkHandbook-3.100.1.info,  Node: Message sending and event generation,  Next: Sending a message from a module,  Prev: Calling imported and inherited predicates,  Up: Messages

1.4.7 Message sending and event generation
------------------------------------------

Assuming the *note events: 89. flag is set to ‘allow’ for the object (or
category) sending a message using the *note (;;)/2: 7e. control
construct, two events are generated, one before and one after the
message execution.  Messages that are sent using the *note (;;)/1: 5c.
(message to 'self') control construct or the *note (^^)/1: 5d. super
mechanism described above do not generate any events.  The rationale
behind this distinction is that messages to 'self' and 'super' calls are
only used internally in the definition of methods or to execute
additional messages with the same target object (represented by 'self').
In other words, events are only generated when using an object’s public
interface; they cannot be used to break object encapsulation.

If we need to generate events for a public message sent to 'self', then
we just need to write something like:

     Predicate :-
         ...,
         % get self reference
         self(Self),
         % send a message to self using (::)/2
         Self::Message,
         ... .

If we also need the sender of the message to be other than the object
containing the predicate definition, we can write:

     Predicate :-
         ...,
         % send a message to self using (::)/2
         % sender will be the pseudo-object user
         self(Self),
         {Self::Message},
         ... .

When events are not used, it is possible to turn off event generation
globally or on a per-entity basis by using the ‘events’ compiler flag to
optimize message-sending performance (see the *note Event-driven
programming: 6d. section for more details).


File: TheLogtalkHandbook-3.100.1.info,  Node: Sending a message from a module,  Next: Message sending performance,  Prev: Message sending and event generation,  Up: Messages

1.4.8 Sending a message from a module
-------------------------------------

Messages can be sent to objects from within Prolog modules.  Depending
on the backend support for goal-expansion and on the *note optimize: 8c.
flag being turned on, the messages will use static binding when
possible.  This optimization requires the object to be compiled and
loaded before the module.  Note that the module can be ‘user’.  This is
usually the case when sending the message from the top-level
interpreter.  Thus, the same conditions apply in this case.  Note that
loading Prolog modules using Prolog directives or built-in predicates
necessarily limits the range of possible optimizations for messages sent
from the modules.

     Warning: If you want to benchmark the performance of a
     message-sending goal at the top-level interpreter, be careful to
     check first if the goal is pre-compiled to use static binding;
     otherwise you will also be benchmarking the Logtalk compiler
     itself.


File: TheLogtalkHandbook-3.100.1.info,  Node: Message sending performance,  Prev: Sending a message from a module,  Up: Messages

1.4.9 Message sending performance
---------------------------------

For a detailed discussion on message-sending performance, see the *note
Performance: 38. section.


File: TheLogtalkHandbook-3.100.1.info,  Node: Objects,  Next: Protocols,  Prev: Messages,  Up: User Manual

1.5 Objects
===========

The main goal of Logtalk objects is the encapsulation and reuse of
predicates.  Instead of a single database containing all your code,
Logtalk objects provide separated namespaces or databases, allowing the
partitioning of code into more manageable parts.  Logtalk is a
'declarative programming language' and does not aim to bring some sort
of new dynamic state change concept to Logic Programming or Prolog.

Logtalk, defines two built-in objects, user(1) and logtalk(2), which are
described at the end of this section.

* Menu:

* Objects, prototypes, classes, and instances: Objects prototypes classes and instances.
* Defining a new object::
* Parametric objects: Parametric objects<2>.
* Finding defined objects::
* Creating a new object at runtime::
* Abolishing an existing object::
* Object directives::
* Object relationships::
* Object properties::
* Built-in objects::
* Multi-threading applications::

   ---------- Footnotes ----------

   (1) ../../apis/user_0.html#user-0

   (2) ../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Objects prototypes classes and instances,  Next: Defining a new object,  Up: Objects

1.5.1 Objects, prototypes, classes, and instances
-------------------------------------------------

There are only three kinds of encapsulation entities in Logtalk:
'objects', 'protocols', and 'categories'.  Logtalk uses the term
'object' in a broad sense.  The terms 'prototype', 'parent', 'class',
'subclass', 'superclass', 'metaclass', and 'instance' always designate
an object.  Different names are used to emphasize the 'role' played by
an object in a particular context.  I.e.  we use a term other than
object when we want to make the relationship with other objects
explicit.  For example, an object with an 'instantiation' relation with
another object plays the role of an 'instance', while the instantiated
object plays the role of a 'class'; an object with a 'specialization'
relation with another object plays the role of a 'subclass', while the
specialized object plays the role of a 'superclass'; an object with an
'extension' relation with another object plays the role of a
'prototype', the same for the extended object.  A 'stand-alone' object,
i.e.  an object with no relations with other objects, is always
interpreted as a prototype.  In Logtalk, entity relations essentially
define 'patterns' of code reuse.  An entity is compiled according to the
roles it plays.

Logtalk allows you to work from standalone objects to any kind of
hierarchy, either class-based or prototype-based.  You may use single or
multiple inheritance, use or forgo metaclasses, implement reflective
designs, use parametric objects, and take advantage of protocols and
categories (think components).

* Menu:

* Prototypes::
* Classes::


File: TheLogtalkHandbook-3.100.1.info,  Node: Prototypes,  Next: Classes,  Up: Objects prototypes classes and instances

1.5.1.1 Prototypes
..................

Prototypes are either self-defined objects or objects defined as
extensions to other prototypes with whom they share common properties.
Prototypes are ideal for representing one-of-a-kind objects.  Prototypes
usually represent concrete objects in the application domain.  When
linking prototypes using 'extension' relations, Logtalk uses the term
'prototype hierarchies' although most authors prefer to use the term
'hierarchy' only with class generalization/specialization relations.  In
the context of logic programming, prototypes are often the ideal
replacement for modules.


File: TheLogtalkHandbook-3.100.1.info,  Node: Classes,  Prev: Prototypes,  Up: Objects prototypes classes and instances

1.5.1.2 Classes
...............

Classes are used to represent abstractions of common properties of sets
of objects.  Classes often provide an ideal structuring solution when
you want to express hierarchies of abstractions or work with many
similar objects.  Classes are used indirectly through 'instantiation'.
Contrary to most object-oriented programming languages, instances can be
created both dynamically at runtime or defined in a source file like
other objects.  Using classes requires defining at least one *note
metaclass: 72, as explained below.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a new object,  Next: Parametric objects<2>,  Prev: Objects prototypes classes and instances,  Up: Objects

1.5.2 Defining a new object
---------------------------

We can define a new object in the same way we write Prolog code: by
using a text editor.  Logtalk source files may contain one or more
objects, categories, or protocols.  If you prefer to define each entity
in its own source file, it is recommended that the file be named after
the object.  By default, all Logtalk source files use the extension
‘.lgt’ but this is optional and can be set in the adapter files.
Intermediate Prolog source files (generated by the Logtalk compiler)
have, by default, a ‘_lgt’ suffix and a ‘.pl’ extension.  Again, this
can be set to match the needs of a particular Prolog compiler in the
corresponding adapter file.  For instance, we may define an object named
‘vehicle’ and save it in a ‘vehicle.lgt’ source file, which will be
compiled to a ‘vehicle_lgt.pl’ Prolog file (depending on the *note
backend compiler: 34, the names of the intermediate Prolog files may
include a directory hash and a process identifier to prevent file name
clashes when embedding Logtalk applications or running parallel Logtalk
processes).

Object names can be atoms or compound terms (when defining parametric
objects, see below).  Objects, categories, and protocols share the same
name space: we cannot have an object with the same name as a protocol or
a category.

Object code (directives and predicates) is textually encapsulated by
using two Logtalk directives: *note object/1-5: 9a. and *note
end_object/0: 9b.  The simplest object will be one that is
self-contained, not depending on any other Logtalk entity:

     :- object(Object).
         ...
     :- end_object.

If an object implements one or more protocols then the opening directive
will be:

     :- object(Object,
         implements([Protocol1, Protocol2, ...])).
         ...
     :- end_object.

An object can import one or more categories:

     :- object(Object,
         imports([Category1, Category2, ...])).
         ...
     :- end_object.

If an object both implements protocols and imports categories, then we
will write:

     :- object(Object,
         implements([Protocol1, Protocol2, ...]),
         imports([Category1, Category2, ...])).
         ...
     :- end_object.

In object-oriented programming, objects are usually organized in
hierarchies that enable interface and code sharing by inheritance.  In
Logtalk, we can construct prototype-based hierarchies by writing:

     :- object(Prototype,
         extends(Parent)).
         ...
     :- end_object.

We can also have class-based hierarchies by defining instantiation and
specialization relations between objects.  To define an object as a
class instance we will write:

     :- object(Object,
         instantiates(Class)).
         ...
     :- end_object.

A class may specialize another class, its superclass:

     :- object(Class,
         specializes(Superclass)).
         ...
     :- end_object.

If we are defining a reflexive system where every class is also an
instance, we will probably be using the following pattern:

     :- object(Class,
         instantiates(Metaclass),
         specializes(Superclass)).
         ...
     :- end_object.

In short, an object can be a 'stand-alone' object or be part of an
object hierarchy.  The hierarchy can be prototype-based (defined by
extending other objects) or class-based (with instantiation and
specialization relations).  An object may also implement one or more
protocols or import one or more categories.

A 'stand-alone' object (i.e., an object with no extension,
instantiation, or specialization relations with other objects) always
plays the role of a prototype, that is, a self-describing object.  If we
want to use classes and instances, then we will need to specify at least
one instantiation or specialization relation.  The best way to do this
is to define a set of objects that provide the basis of a reflective
system *note [Cointe87]: 9c, *note [Moura94]: 9d.  For example:

     % avoid the inevitable unknown entity warnings as in a
     % reflective system there will always be references to
     % an entity that will be defined after the reference

     :- set_logtalk_flag(unknown_entities, silent).


     % default root of the inheritance graph
     % providing predicates common to all objects

     :- object(object,
         instantiates(class)).
         ...
     :- end_object.


     % default metaclass for all classes providing
     % predicates common to all instantiable classes

     :- object(class,
         instantiates(class),
         specializes(abstract_class)).
         ...
     :- end_object.


     % default metaclass for all abstract classes
     % providing predicates common to all classes

     :- object(abstract_class,
         instantiates(class),
         specializes(object)).
         ...
     :- end_object.

Note that with these instantiation and specialization relations,
‘object’, ‘class’, and ‘abstract_class’ are, at the same time, classes
and instances of some class.  In addition, each object inherits its own
predicates and the predicates of the other two objects without any
inheritance loop.

When a full-blown reflective system solution is not needed, the above
scheme can be simplified by making an object an instance of itself, i.e.
by making a class its own metaclass.  For example:

     :- object(class,
         instantiates(class)).
         ...
     :- end_object.

We can use, in the same application, both prototype and class-based
hierarchies (and freely exchange messages between all objects).  We
cannot, however, mix the two types of hierarchies by, e.g., specializing
an object that extends another object in this current Logtalk version.

Logtalk also supports public, protected, and private inheritance.  See
the *note inheritance: 9e. section for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Parametric objects<2>,  Next: Finding defined objects,  Prev: Defining a new object,  Up: Objects

1.5.3 Parametric objects
------------------------

Parametric objects have a compound term as identifier where all the
arguments of the compound term are variables.  These variables can be
bound when sending a message or become bound when a message to the
object succeeds, thus acting as 'object parameters'.  The object
predicates can be coded to depend on those parameters, which are
'logical variables' shared by all object predicates.  Parametric objects
can also be used to associate a set of predicates to terms that share a
common functor and arity.

As a consequence of parameters being logical variables, when defining,
for example, a parametric object ‘foo/1’, ‘foo(bar)’ and ‘foo(baz)’ are
different parameterizations of the same object, not distinct objects.

* Menu:

* Accessing object parameters::
* Parametric object proxies::


File: TheLogtalkHandbook-3.100.1.info,  Node: Accessing object parameters,  Next: Parametric object proxies,  Up: Parametric objects<2>

1.5.3.1 Accessing object parameters
...................................

Object parameters can be accessed using *note parameter variables: a1.
or built-in execution context methods.  Parameter variables is the
recommended solution to access object parameters.  Although they
introduce a concept of entity global variables, their unique syntax
(‘_ParameterName_’) avoids conflicts, makes them easily recognizable,
and distinguishes them from other named anonymous variables.  For
example:

     :- object(foo(_Bar_, _Baz_, ...)).

         ...
         bar(_Bar_).

         baz :-
             baz(_Baz_),
             ... .

Note that using parameter variables doesn’t change the fact that entity
parameters are logical variables.  Parameter variables simplify code
maintenance by allowing parameters to be added, reordered, or removed
without having to specify or update parameter indexes.

Logtalk provides also a *note parameter/2: a2. built-in local method to
access individual parameters:

     :- object(foo(_Bar, _Baz, ...)).

         ...
         bar(Bar) :-
             parameter(1, Bar).

         baz :-
             parameter(2, Baz),
             baz(Baz),
             ... .

An alternative solution is to use the built-in local method *note
this/1: 68, which allows access to all parameters with a single call.
For example:

     :- object(foo(_Bar, _Baz, ...)).

         ...
         baz :-
             this(foo(_, Baz, ...)),
             baz(Baz),
             ... .

Both solutions are equally efficient as calls to the methods ‘this/1’
and ‘parameter/2’ are usually compiled inline into a clause head
unification.  The drawback of this second solution is that we must check
all calls of ‘this/1’ if we change the object name.  Note that we can’t
use these method with the message-sending operators (*note (;;)/2: 7e,
*note (;;)/1: 5c, or *note (^^)/1: 5d.).

When storing a parametric object in its own source file, the convention
is to name the file after the object, with the object arity appended.
For instance, when defining an object named ‘sort(Type)’, we may save it
in a ‘sort_1.lgt’ text file.  This way it is easy to avoid file name
clashes when saving Logtalk entities that have the same functor but
different arity.


File: TheLogtalkHandbook-3.100.1.info,  Node: Parametric object proxies,  Prev: Accessing object parameters,  Up: Parametric objects<2>

1.5.3.2 Parametric object proxies
.................................

Compound terms with the same functor and with the same number of
arguments as a parametric object identifier may act as 'proxies' to a
parametric object.  Proxies may be stored on the database as Prolog
facts and be used to represent different instantiations of a parametric
object identifier.  For example:

     :- object(circle(_Id_, _Radius_, _Color_)).

         :- public(area/1).
         ...

     :- end_object.

     % parametric object proxies:
     circle('#1', 1.23, blue).
     circle('#2', 3.71, yellow).
     circle('#3', 0.39, green).
     circle('#4', 5.74, black).
     circle('#5', 8.32, cyan).

Logtalk provides a convenient notation for accessing proxies represented
as Prolog facts when sending a message:

     ..., {Proxy}::Message, ...

For example, using the ‘circle/3’ parametric object above, we can
compute a list with the areas of all circles using the following goal:

     | ?- findall(Area, {circle(_, _, _)}::area(Area), Areas).

     Areas = [4.75291, 43.2412, 0.477836, 103.508, 217.468].

In this context, the proxy argument is proved as a plain Prolog goal.
If successful, the message is sent to the corresponding parametric
object.  Typically, the proof allows retrieval of parameter
instantiations.  This construct can either be used with a proxy argument
that is sufficiently instantiated in order to unify with a single Prolog
fact or with a proxy argument that unifies with several facts on
backtracking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Finding defined objects,  Next: Creating a new object at runtime,  Prev: Parametric objects<2>,  Up: Objects

1.5.4 Finding defined objects
-----------------------------

We can find, by backtracking, all defined objects by calling the *note
current_object/1: a6. built-in predicate with an unbound argument:

     | ?- current_object(Object).
     Object = logtalk ;
     Object = user ;
     ...

This predicate can also be used to test if an object is defined by
calling it with a valid object identifier (an atom or a compound term).


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating a new object at runtime,  Next: Abolishing an existing object,  Prev: Finding defined objects,  Up: Objects

1.5.5 Creating a new object at runtime
--------------------------------------

An object can be dynamically created at runtime by using the *note
create_object/4: 62. built-in predicate:

     | ?- create_object(Object, Relations, Directives, Clauses).

The first argument should be either a variable or the name of the new
object (a Prolog atom or compound term, which must not match any
existing entity name).  The remaining three arguments correspond to the
relations described in the opening object directive and to the object
code contents (directives and clauses).

For example, the call:

     | ?- create_object(
              foo,
              [extends(bar)],
              [public(foo/1)],
              [foo(1), foo(2)]
          ).

is equivalent to compiling and loading the object:

     :- object(foo,
         extends(bar)).

         :- dynamic.

         :- public(foo/1).
         foo(1).
         foo(2).

     :- end_object.

If we need to create a lot of (dynamic) objects at runtime, then it is
best to define a metaclass or a prototype with a predicate that will
call this built-in predicate to make new objects.  This predicate may
provide automatic object name generation, name checking, and accept
object initialization options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Abolishing an existing object,  Next: Object directives,  Prev: Creating a new object at runtime,  Up: Objects

1.5.6 Abolishing an existing object
-----------------------------------

Dynamic objects can be abolished using the *note abolish_object/1: 64.
built-in predicate:

     | ?- abolish_object(Object).

The argument must be an identifier of a defined dynamic object;
otherwise an error will be thrown.


File: TheLogtalkHandbook-3.100.1.info,  Node: Object directives,  Next: Object relationships,  Prev: Abolishing an existing object,  Up: Objects

1.5.7 Object directives
-----------------------

Object directives are used to set initialization goals, define object
properties, document an object dependencies on other Logtalk entities,
and load the contents of files into an object.

* Menu:

* Object initialization::
* Dynamic objects::
* Object documentation::
* Loading files into an object::
* Declaring object aliases::


File: TheLogtalkHandbook-3.100.1.info,  Node: Object initialization,  Next: Dynamic objects,  Up: Object directives

1.5.7.1 Object initialization
.............................

We can define a goal to be executed as soon as an object is (compiled
and) loaded to memory with the *note initialization/1: 42. directive:

     :- initialization(Goal).

The argument can be any valid Logtalk goal.  For example, a call to a
local predicate:

     :- object(foo).

         :- initialization(init).
         :- private(init/0).

         init :-
             ... .

         ...

     :- end_object.

Or a message to another object:

     :- object(assembler).

         :- initialization(control::start).
         ...

     :- end_object.

Another common initialization goal is a message to 'self' in order to
call an inherited or imported predicate.  For example, assuming that we
have a ‘monitor’ category defining a ‘reset/0’ predicate, we could
write:

     :- object(profiler,
         imports(monitor)).

         :- initialization(::reset).
         ...

     :- end_object.

Note, however, that descendant objects do not inherit initialization
directives.  In this context, 'self' denotes the object that contains
the directive.  Also note that object initialization does not
necessarily mean setting an object dynamic state.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dynamic objects,  Next: Object documentation,  Prev: Object initialization,  Up: Object directives

1.5.7.2 Dynamic objects
.......................

Similar to Prolog predicates, an object can be either static or dynamic.
An object created during the execution of a program is always dynamic.
An object defined in a file can be either dynamic or static.  Dynamic
objects are declared by using the *note dynamic/0: b1. directive in the
object source code:

     :- dynamic.

The directive must precede any predicate directives or clauses.  Please
be aware that using dynamic code results in a performance hit when
compared to static code.  We should only use dynamic objects when these
need to be abolished during program execution.  In addition, note that
we can declare and define dynamic predicates within a static object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Object documentation,  Next: Loading files into an object,  Prev: Dynamic objects,  Up: Object directives

1.5.7.3 Object documentation
............................

An object can be documented with arbitrary user-defined information by
using the *note info/1: b4. entity directive.  See the *note
Documenting: b5. section for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading files into an object,  Next: Declaring object aliases,  Prev: Object documentation,  Up: Object directives

1.5.7.4 Loading files into an object
....................................

The *note include/1: b8. directive can be used to load the contents of a
file into an object.  A typical usage scenario is to load a plain Prolog
file into an object, thus providing a simple way to encapsulate its
contents.  For example, assume a ‘cities.pl’ file defining facts for a
‘city/4’ predicate.  We could define a wrapper for this database by
writing:

     :- object(cities).

         :- public(city/4).

         :- include(dbs('cities.pl')).

     :- end_object.

The ‘include/1’ directive can also be used when creating an object
dynamically.  For example:

     | ?- create_object(cities, [], [public(city/4), include(dbs('cities.pl'))], []).


File: TheLogtalkHandbook-3.100.1.info,  Node: Declaring object aliases,  Prev: Loading files into an object,  Up: Object directives

1.5.7.5 Declaring object aliases
................................

The *note uses/1: 4a. directive can be used to declare object aliases.
The typical uses of this directive include shortening long object names,
working consistently with specific parameterizations of parametric
objects, and simplifying experimenting with different object
implementations of the same protocol when using explicit
message-sending.


File: TheLogtalkHandbook-3.100.1.info,  Node: Object relationships,  Next: Object properties,  Prev: Object directives,  Up: Objects

1.5.8 Object relationships
--------------------------

Logtalk provides six sets of built-in predicates that enable us to query
the system about the relationships that an object has with other
entities.

The *note instantiates_class/2-3: bd. built-in predicates can be used to
query all instantiation relations:

     | ?- instantiates_class(Instance, Class).

or, if we also want to know the instantiation scope:

     | ?- instantiates_class(Instance, Class, Scope).

Specialization relations can be found by using the *note
specializes_class/2-3: be. built-in predicates:

     | ?- specializes_class(Class, Superclass).

or, if we also want to know the specialization scope:

     | ?- specializes_class(Class, Superclass, Scope).

For prototypes, we can query extension relations using the *note
extends_object/2-3: bf. built-in predicates:

     | ?- extends_object(Object, Parent).

or, if we also want to know the extension scope:

     | ?- extends_object(Object, Parent, Scope).

In order to find which objects import which categories, we can use the
*note imports_category/2-3: c0. built-in predicates:

     | ?- imports_category(Object, Category).

or, if we also want to know the importation scope:

     | ?- imports_category(Object, Category, Scope).

To find which objects implements which protocols, we can use the *note
implements_protocol/2-3: c1. and *note conforms_to_protocol/2-3: c2.
built-in predicates:

     | ?- implements_protocol(Object, Protocol, Scope).

or, if we also want to consider inherited protocols:

     | ?- conforms_to_protocol(Object, Protocol, Scope).

Note that, if we use an unbound first argument, we will need to use the
*note current_object/1: a6. built-in predicate to ensure that the entity
returned is an object and not a category.

To find which objects are explicitly complemented by categories, we can
use the *note complements_object/2: c3. built-in predicate:

     | ?- complements_object(Category, Object).

Note that more than one category may explicitly complement a single
object, and a single category can complement several objects.


File: TheLogtalkHandbook-3.100.1.info,  Node: Object properties,  Next: Built-in objects,  Prev: Object relationships,  Up: Objects

1.5.9 Object properties
-----------------------

We can find the properties of defined objects by calling the built-in
predicate *note object_property/2: c6.:

     | ?- object_property(Object, Property).

The following object properties are supported:

‘static’

     The object is static

‘dynamic’

     The object is dynamic (and thus can be abolished in runtime by
     calling the *note abolish_object/1: 64. built-in predicate)

‘built_in’

     The object is a built-in object (and thus always available)

‘threaded’

     The object supports/makes multi-threading calls

‘file(Path)’

     Absolute path of the source file defining the object (if
     applicable)

‘file(Basename, Directory)’

     Basename and directory of the source file defining the object (if
     applicable); ‘Directory’ always ends with a ‘/’

‘lines(BeginLine, EndLine)’

     Source file begin and end lines of the object definition (if
     applicable)

‘directive(BeginLine, EndLine)’

     Source file begin and end lines of the object opening directive (if
     applicable)

‘context_switching_calls’

     The object supports context-switching calls (i.e., can be used with
     the *note (<<)/2: c7. debugging control construct)

‘dynamic_declarations’

     The object supports dynamic declarations of predicates

‘events’

     Messages sent from the object generate events

‘source_data’

     Source data available for the object

‘info(List)’

     List of the compound term representation of the object ‘info/1’
     pairs with the key as functor.

‘complements(Permission)’

     The object supports complementing categories with the specified
     permission (‘allow’ or ‘restrict’)

‘complements’

     The object supports complementing categories

‘public(Resources)’

     List of public predicates and operators declared by the object

‘protected(Resources)’

     List of protected predicates and operators declared by the object

‘private(Resources)’

     List of private predicates and operators declared by the object

‘declares(Predicate, Properties)’

     List of *note properties: c8. for a predicate declared by the
     object

‘defines(Predicate, Properties)’

     List of *note properties: c8. for a predicate defined by the object

‘includes(Predicate, Entity, Properties)’

     List of *note properties: c8. for an object multifile predicate
     that are defined in the specified entity (the properties include
     ‘number_of_clauses(Number)’, ‘number_of_rules(Number)’,
     ‘include(File)’, ‘lines(Start,End)’, and ‘line_count(Start)’ with
     ‘Start-End’ being the line range of the first multifile predicate
     clause)

‘provides(Predicate, Entity, Properties)’

     List of *note properties: c8. for other entity multifile predicates
     that are defined in the object (the properties include
     ‘number_of_clauses(Number)’, ‘number_of_rules(Number)’,
     ‘include(File)’, ‘lines(Start,End)’, and ‘line_count(Start)’ with
     ‘Start-End’ being the line range of the first multifile predicate
     clause)

‘references(Reference, Properties)’

     List of *note properties: c8. for other references to entities in
     calls to the execution-context built-in methods and in directives
     for multifile predicates and multifile non-terminals that are found
     in the object (the properties include ‘in(Context)’,
     ‘non_terminal(NonTerminal)’, ‘include(File)’, ‘lines(Start,End)’,
     and ‘line_count(Start)’ with ‘Start-End’ being the line range of
     the first reference, a directive, a predicate clause, or a
     non-terminal grammar rule; the possible values for ‘Context’ are
     ‘multifile’, ‘dynamic’, ‘discontiguous’, ‘meta_predicate’,
     ‘meta_non_terminal’, and ‘clause’); ‘Reference’ can be either
     ‘Entity’ or ‘Entity::Functor/Arity’

‘alias(Entity, Properties)’

     List of *note properties: c8. for an *note entity alias: c9.
     declared by the object (the properties include ‘object’ in case of
     an object alias, ‘module’ in case of a module alias,
     ‘for(Original)’, ‘lines(Start,End)’, and ‘line_count(Start)’ with
     ‘Start-End’ being the line range of the ‘uses/1’ or ‘use_module/1’
     directive)

‘alias(Predicate, Properties)’

     List of *note properties: c8. for a *note predicate alias: ca.
     declared by the object (the properties include ‘predicate’,
     ‘for(Original)’, ‘from(Entity)’, ‘non_terminal(NonTerminal)’,
     ‘lines(Start,End)’, and ‘line_count(Start)’ with ‘Start-End’ being
     the line range of the alias directive)

‘calls(Call, Properties)’

     List of *note properties: c8. for predicate calls made by the
     object (‘Call’ is either a predicate indicator or a control
     construct such as ‘(::)/1-2’ or ‘(^^)/1’ with a predicate indicator
     as argument; note that ‘Call’ may not be ground in case of a call
     to a control construct where its argument is only known at runtime;
     the properties include ‘caller(Caller)’, ‘alias(Alias)’,
     ‘non_terminal(NonTerminal)’, ‘lines(Start,End)’,
     ‘line_count(Start)’ with ‘Caller’, ‘Alias’, and ‘NonTerminal’ being
     predicate indicators and ‘Start-End’ being the line range of the
     predicate clause or directive making the call)

‘updates(Predicate, Properties)’

     List of *note properties: c8. for dynamic predicate updates (and
     also access using the ‘clause/2’ predicate) made by the object
     (‘Predicate’ is either a predicate indicator or a control construct
     such as ‘(::)/1-2’ or ‘(:)/2’ with a predicate indicator as
     argument; note that ‘Predicate’ may not be ground in case of a
     control construct argument only known at runtime; the properties
     include ‘updater(Updater)’, ‘alias(Alias)’,
     ‘non_terminal(NonTerminal)’, ‘lines(Start,End)’, and
     ‘line_count(Start)’ with ‘Updater’ being a (possibly multifile)
     predicate indicator, ‘Alias’ and ‘NonTerminal’ being predicate
     indicators, and ‘Start-End’ being the line range of the predicate
     clause or directive updating the predicate)

‘number_of_clauses(Number)’

     Total number of predicate clauses defined in the object at
     compilation time (includes both user-defined clauses and auxiliary
     clauses generated by the compiler or by the *note expansion hooks:
     cb. but does not include clauses for multifile predicates defined
     for other entities or clauses for the object own multifile
     predicates contributed by other entities)

‘number_of_rules(Number)’

     Total number of predicate rules defined in the object at
     compilation time (includes both user-defined rules and auxiliary
     rules generated by the compiler or by the *note expansion hooks:
     cb. but does not include rules for multifile predicates defined for
     other entities or rules for the object own multifile predicates
     contributed by other entities)

‘number_of_user_clauses(Number)’

     Total number of user-defined predicate clauses defined in the
     object at compilation time (does not include clauses for multifile
     predicates defined for other entities or clauses for the object own
     multifile predicates contributed by other entities)

‘number_of_user_rules(Number)’

     Total number of user-defined predicate rules defined in the object
     at compilation time (does not include rules for multifile
     predicates defined for other entities or rules for the object own
     multifile predicates contributed by other entities)

‘debugging’

     The object is compiled in debug mode

‘module’

     The object resulted from the compilation of a Prolog module

When a predicate is called from an ‘initialization/1’ directive, the
argument of the ‘caller/1’ property is ‘(:-)/1’.

Some properties such as line numbers are only available when the object
is defined in a source file compiled with the *note source_data: cc.
flag turned on.  Moreover, line numbers are only supported in *note
backend Prolog compilers: 34. that provide access to the start line of a
read term.  When such support is not available, the value ‘-1’ is
returned for the start and end lines.

The properties that return the number of clauses (rules) report the
clauses (rules) 'textually defined in the object' for both multifile and
non-multifile predicates.  Thus, these numbers exclude clauses (rules)
for multifile predicates 'contributed' by other entities.


File: TheLogtalkHandbook-3.100.1.info,  Node: Built-in objects,  Next: Multi-threading applications,  Prev: Object properties,  Up: Objects

1.5.10 Built-in objects
-----------------------

Logtalk defines some built-in objects that are always available for any
application.

* Menu:

* The built-in pseudo-object user::
* The built-in object logtalk::


File: TheLogtalkHandbook-3.100.1.info,  Node: The built-in pseudo-object user,  Next: The built-in object logtalk,  Up: Built-in objects

1.5.10.1 The built-in pseudo-object ‘user’
..........................................

The built-in user(1) pseudo-object virtually contains all user predicate
definitions not encapsulated in a Logtalk entity (or a Prolog module for
backends supporting a module system).  These predicates are assumed to
be implicitly declared public.  Messages sent from this pseudo-object,
which includes messages sent from the top-level interpreter, generate
events when the default value of the *note events: 89. flag is set to
‘allow’.  Defining complementing categories for this pseudo-object is
not supported.

With some of the *note backend Prolog compilers: 34. that support a
module system, it is possible to load (the) Logtalk (compiler/runtime)
into a module other than the pseudo-module ‘user’.  In this case, the
Logtalk pseudo-object ‘user’ virtually contains all user predicate
definitions defined in the module where Logtalk was loaded.

   ---------- Footnotes ----------

   (1) ../../apis/user_0.html#user-0


File: TheLogtalkHandbook-3.100.1.info,  Node: The built-in object logtalk,  Prev: The built-in pseudo-object user,  Up: Built-in objects

1.5.10.2 The built-in object ‘logtalk’
......................................

The built-in logtalk(1) object provides *note message printing: d3.
predicates, *note question asking: d4. predicates, *note debug and trace
event: d5. predicates, predicates for accessing the internal database of
loaded files and their properties, halt predicates, and also a set of
low-level utility predicates normally used when defining hook objects.
Consult its API documentation for details.

   ---------- Footnotes ----------

   (1) ../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading applications,  Prev: Built-in objects,  Up: Objects

1.5.11 Multi-threading applications
-----------------------------------

When writing multi-threading applications, user-defined predicates
calling built-in predicates such as ‘create_object/4’ and
‘abolish_object/1’ may need to be declared synchronized in order to
avoid race conditions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocols,  Next: Categories,  Prev: Objects,  Up: User Manual

1.6 Protocols
=============

Protocols enable the separation between interface and implementation:
several objects can implement the same protocol, and an object can
implement several protocols.  Protocols may contain only predicate
declarations.  In some languages the term 'interface' is used with a
similar meaning.  Logtalk allows predicate declarations of any scope
within protocols, contrary to some languages that only allow public
declarations.

Logtalk defines three built-in protocols, monitoring(1), expanding(2),
and forwarding(3), which are described at the end of this section.

* Menu:

* Defining a new protocol::
* Finding defined protocols::
* Creating a new protocol at runtime::
* Abolishing an existing protocol::
* Protocol directives::
* Protocol relationships::
* Protocol properties::
* Implementing protocols::
* Built-in protocols::
* Multi-threading applications: Multi-threading applications<2>.

   ---------- Footnotes ----------

   (1) ../../apis/monitoring_0.html#monitoring-0

   (2) ../../apis/expanding_0.html#expanding-0

   (3) ../../apis/forwarding_0.html#forwarding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a new protocol,  Next: Finding defined protocols,  Up: Protocols

1.6.1 Defining a new protocol
-----------------------------

We can define a new protocol in the same way we write Prolog code: by
using a text editor.  Logtalk source files may contain one or more
objects, categories, or protocols.  If you prefer to define each entity
in its own source file, it is recommended that the file be named after
the protocol.  By default, all Logtalk source files use the extension
‘.lgt’ but this is optional and can be set in the adapter files.
Intermediate Prolog source files (generated by the Logtalk compiler)
have, by default, a ‘_lgt’ suffix and a ‘.pl’ extension.  Again, this
can be set to match the needs of a particular Prolog compiler in the
corresponding adapter file.  For example, we may define a protocol named
‘listp’ and save it in a ‘listp.lgt’ source file that will be compiled
to a ‘listp_lgt.pl’ Prolog file (depending on the backend compiler, the
names of the intermediate Prolog files may include a directory hash and
a process identifier to prevent file name clashes when embedding Logtalk
applications or running parallel Logtalk processes).

Protocol names must be atoms.  Objects, categories, and protocols share
the same namespace: we cannot have a protocol with the same name as an
object or a category.

Protocol directives are textually encapsulated by using two Logtalk
directives: *note protocol/1-2: dc. and *note end_protocol/0: dd.  The
most simple protocol will be one that is self-contained, not depending
on any other Logtalk entity:

     :- protocol(Protocol).
         ...
     :- end_protocol.

If a protocol extends one or more protocols, then the opening directive
will be:

     :- protocol(Protocol,
         extends([Protocol1, Protocol2, ...])).
         ...
     :- end_protocol.

In order to maximize protocol reuse, all predicates specified in a
protocol should relate to the same functionality.  Therefore, the only
recommended use of protocol extension is when you need both a minimal
protocol and an extended version of the same protocol with additional,
convenient predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Finding defined protocols,  Next: Creating a new protocol at runtime,  Prev: Defining a new protocol,  Up: Protocols

1.6.2 Finding defined protocols
-------------------------------

We can find, by backtracking, all defined protocols by using the *note
current_protocol/1: e0. built-in predicate with a unbound argument:

     | ?- current_protocol(Protocol).

This predicate can also be used to test if a protocol is defined by
calling it with a valid protocol identifier (an atom).


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating a new protocol at runtime,  Next: Abolishing an existing protocol,  Prev: Finding defined protocols,  Up: Protocols

1.6.3 Creating a new protocol at runtime
----------------------------------------

We can create a new (dynamic) protocol at runtime by calling the Logtalk
built-in predicate *note create_protocol/3: e3.:

     | ?- create_protocol(Protocol, Relations, Directives).

The first argument should be either a variable or the name of the new
protocol (a Prolog atom, which must not match an existing entity name).
The remaining two arguments correspond to the relations described in the
opening protocol directive and to the protocol directives.

For instance, the call:

     | ?- create_protocol(ppp, [extends(qqq)], [public([foo/1, bar/1])]).

is equivalent to compiling and loading the protocol:

     :- protocol(ppp,
         extends(qqq)).

         :- dynamic.

         :- public([foo/1, bar/1]).

     :- end_protocol.

If we need to create a lot of (dynamic) protocols at runtime, then it is
best to define a metaclass or a prototype with a predicate that will
call this built-in predicate in order to provide more sophisticated
behavior.


File: TheLogtalkHandbook-3.100.1.info,  Node: Abolishing an existing protocol,  Next: Protocol directives,  Prev: Creating a new protocol at runtime,  Up: Protocols

1.6.4 Abolishing an existing protocol
-------------------------------------

Dynamic protocols can be abolished using the *note abolish_protocol/1:
e6. built-in predicate:

     | ?- abolish_protocol(Protocol).

The argument must be an identifier of a defined dynamic protocol;
otherwise an error will be thrown.


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol directives,  Next: Protocol relationships,  Prev: Abolishing an existing protocol,  Up: Protocols

1.6.5 Protocol directives
-------------------------

Protocol directives are used to define protocol properties and
documentation.

* Menu:

* Dynamic protocols::
* Protocol documentation::
* Loading files into a protocol::


File: TheLogtalkHandbook-3.100.1.info,  Node: Dynamic protocols,  Next: Protocol documentation,  Up: Protocol directives

1.6.5.1 Dynamic protocols
.........................

As usually happens with Prolog code, a protocol can be either static or
dynamic.  A protocol created during the execution of a program is always
dynamic.  A protocol defined in a file can be either dynamic or static.
Dynamic protocols are declared by using the *note dynamic/0: b1.
directive in the protocol source code:

     :- dynamic.

The directive must precede any predicate directives.  Please be aware
that using dynamic code results in a performance hit when compared to
static code.  We should only use dynamic protocols when these need to be
abolished during program execution.


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol documentation,  Next: Loading files into a protocol,  Prev: Dynamic protocols,  Up: Protocol directives

1.6.5.2 Protocol documentation
..............................

A protocol can be documented with arbitrary user-defined information by
using the *note info/1: b4. entity directive.  See the *note
Documenting: b5. section for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading files into a protocol,  Prev: Protocol documentation,  Up: Protocol directives

1.6.5.3 Loading files into a protocol
.....................................

The *note include/1: b8. directive can be used to load the contents of a
file into a protocol.  See the *note Objects: 91. section for an example
of using this directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol relationships,  Next: Protocol properties,  Prev: Protocol directives,  Up: Protocols

1.6.6 Protocol relationships
----------------------------

Logtalk provides two sets of built-in predicates that enable us to query
the system about the relationships that a protocol has with other
entities.

The *note extends_protocol/2-3: f0. built-in predicates return all pairs
of protocols so that the first one extends the second:

     | ?- extends_protocol(Protocol1, Protocol2).

or, if we also want to know the extension scope:

     | ?- extends_protocol(Protocol1, Protocol2, Scope).

To find which objects or categories implement which protocols, we can
call the *note implements_protocol/2-3: c1. built-in predicates:

     | ?- implements_protocol(ObjectOrCategory, Protocol).

or, if we also want to know the implementation scope:

     | ?- implements_protocol(ObjectOrCategory, Protocol, Scope).

Note that, if we use a non-instantiated variable for the first argument,
we will need to use the *note current_object/1: a6. or *note
current_category/1: f1. built-in predicates to identify the kind of
entity returned.


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol properties,  Next: Implementing protocols,  Prev: Protocol relationships,  Up: Protocols

1.6.7 Protocol properties
-------------------------

We can find the properties of defined protocols by calling the *note
protocol_property/2: f4. built-in predicate:

     | ?- protocol_property(Protocol, Property).

A protocol may have the property ‘static’, ‘dynamic’, or ‘built_in’.
Dynamic protocols can be abolished in runtime by calling the *note
abolish_protocol/1: e6. built-in predicate.  Depending on the *note
backend Prolog compiler: 34, a protocol may have additional properties
related to the source file where it is defined.

The following protocol properties are supported:

‘static’

     The protocol is static

‘dynamic’

     The protocol is dynamic (and thus can be abolished in runtime by
     calling the *note abolish_category/1: f5. built-in predicate)

‘built_in’

     The protocol is a built-in protocol (and thus always available)

‘source_data’

     Source data available for the protocol

‘info(List)’

     List of the compound term representation of the object ‘info/1’
     pairs with the key as functor.

‘file(Path)’

     Absolute path of the source file defining the protocol (if
     applicable)

‘file(Basename, Directory)’

     Basename and directory of the source file defining the protocol (if
     applicable); ‘Directory’ always ends with a ‘/’

‘lines(BeginLine, EndLine)’

     Source file begin and end lines of the protocol definition (if
     applicable)

‘directive(BeginLine, EndLine)’

     Source file begin and end lines of the protocol opening directive
     (if applicable)

‘public(Resources)’

     List of public predicates and operators declared by the protocol

‘protected(Resources)’

     List of protected predicates and operators declared by the protocol

‘private(Resources)’

     List of private predicates and operators declared by the protocol

‘declares(Predicate, Properties)’

     List of *note properties: c8. for a predicate declared by the
     protocol

‘alias(Predicate, Properties)’

     List of *note properties: c8. for a *note predicate alias: ca.
     declared by the protocol (the properties include ‘for(Original)’,
     ‘from(Entity)’, ‘non_terminal(NonTerminal)’, and ‘line_count(Line)’
     with ‘Line’ being the begin line of the alias directive)

Some of the properties, such as line numbers, are only available when
the protocol is defined in a source file compiled with the *note
source_data: cc. flag turned on.


File: TheLogtalkHandbook-3.100.1.info,  Node: Implementing protocols,  Next: Built-in protocols,  Prev: Protocol properties,  Up: Protocols

1.6.8 Implementing protocols
----------------------------

Any number of objects or categories can implement a protocol.  The
syntax is very simple:

     :- object(Object,
         implements(Protocol)).
         ...
     :- end_object.

or, in the case of a category:

     :- category(Object,
         implements(Protocol)).
         ...
     :- end_category.

To make all public predicates declared via an implemented protocol
protected or to make all public and protected predicates private we
prefix the protocol’s name with the corresponding keyword.  For
instance:

     :- object(Object,
         implements(private::Protocol)).
         ...
     :- end_object.

or:

     :- object(Object,
         implements(protected::Protocol)).
         ...
     :- end_object.

Omitting the scope keyword is equivalent to writing:

     :- object(Object,
         implements(public::Protocol)).
         ...
     :- end_object.

The same rules apply to protocols implemented by categories.


File: TheLogtalkHandbook-3.100.1.info,  Node: Built-in protocols,  Next: Multi-threading applications<2>,  Prev: Implementing protocols,  Up: Protocols

1.6.9 Built-in protocols
------------------------

Logtalk defines a set of built-in protocols that are always available
for any application.

* Menu:

* The built-in protocol expanding::
* The built-in protocol monitoring::
* The built-in protocol forwarding::


File: TheLogtalkHandbook-3.100.1.info,  Node: The built-in protocol expanding,  Next: The built-in protocol monitoring,  Up: Built-in protocols

1.6.9.1 The built-in protocol ‘expanding’
.........................................

The built-in expanding(1) protocol declares the *note term_expansion/2:
fc. and *note goal_expansion/2: fd. predicates.  See the description of
the *note hook: fe. compiler flag for more details.

   ---------- Footnotes ----------

   (1) ../../apis/expanding_0.html#expanding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: The built-in protocol monitoring,  Next: The built-in protocol forwarding,  Prev: The built-in protocol expanding,  Up: Built-in protocols

1.6.9.2 The built-in protocol ‘monitoring’
..........................................

The built-in monitoring(1) protocol declares the *note before/3: 101.
and *note after/3: 102. public event handler predicates.  See the *note
Event-driven programming: 6d. section for more details.

   ---------- Footnotes ----------

   (1) ../../apis/monitoring_0.html#monitoring-0


File: TheLogtalkHandbook-3.100.1.info,  Node: The built-in protocol forwarding,  Prev: The built-in protocol monitoring,  Up: Built-in protocols

1.6.9.3 The built-in protocol ‘forwarding’
..........................................

The built-in forwarding(1) protocol declares the *note forward/1: 105.
user-defined message forwarding handler, which is automatically called
(if defined) by the runtime for any message that the receiving object
does not understand.  See also the *note []/1: 81. control construct.

   ---------- Footnotes ----------

   (1) ../../apis/forwarding_0.html#forwarding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading applications<2>,  Prev: Built-in protocols,  Up: Protocols

1.6.10 Multi-threading applications
-----------------------------------

When writing multi-threading applications, user-defined predicates
calling built-in predicates such as ‘create_protocol/3’ and
‘abolish_protocol/1’ may need to be declared synchronized in order to
avoid race conditions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Categories,  Next: Predicates,  Prev: Protocols,  Up: User Manual

1.7 Categories
==============

Categories are 'fine-grained units of code reuse' and can be regarded as
a dual concept of protocols.  Categories provide a way to encapsulate a
set of related predicate declarations and definitions that do not
represent a complete object and that only make sense when composed with
other predicates.  Categories may also be used to break a complex object
into functional units.  A category can be imported by several objects
(without code duplication), including objects participating in prototype
or class-based hierarchies.  This concept of categories shares some
ideas with Smalltalk-80 functional categories *note [Goldberg83]: 1c,
Flavors mix-ins *note [Moon86]: 10a. (without necessarily implying
multi-inheritance), and Objective-C categories *note [Cox86]: 1d.
Categories may also 'complement' existing objects, thus providing a
*note hot patching: 10b. mechanism inspired by the Objective-C
categories functionality.

Logtalk defines a built-in category, core_messages(1), which is
described at the end of this section.

* Menu:

* Defining a new category::
* Hot patching::
* Finding defined categories::
* Creating a new category at runtime::
* Abolishing an existing category::
* Category directives::
* Category relationships::
* Category properties::
* Importing categories::
* Calling category predicates::
* Parametric categories::
* Built-in categories::
* Multi-threading applications: Multi-threading applications<3>.

   ---------- Footnotes ----------

   (1) ../../apis/core_messages_0.html#core-messages-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a new category,  Next: Hot patching,  Up: Categories

1.7.1 Defining a new category
-----------------------------

We can define a new category in the same way we write Prolog code: by
using a text editor.  Logtalk source files may contain one or more
objects, categories, or protocols.  If you prefer to define each entity
in its own source file, it is recommended that the file be named after
the category.  By default, all Logtalk source files use the extension
‘.lgt’ but this is optional and can be set in the adapter files.
Intermediate Prolog source files (generated by the Logtalk compiler)
have, by default, a ‘_lgt’ suffix and a ‘.pl’ extension.  Again, this
can be set to match the needs of a particular Prolog compiler in the
corresponding adapter file.  For example, we may define a category named
‘documenting’ and save it in a ‘documenting.lgt’ source file that will
be compiled to a ‘documenting_lgt.pl’ Prolog file (depending on the
*note backend compiler: 34, the names of the intermediate Prolog files
may include a directory hash and a process identifier to prevent file
name clashes when embedding Logtalk applications or running parallel
Logtalk processes).

Category names can be atoms or compound terms (when defining parametric
categories).  Objects, categories, and protocols share the same name
space: we cannot have a category with the same name as an object or a
protocol.

Category code (directives and predicates) is textually encapsulated by
using two Logtalk directives: *note category/1-4: 10e. and *note
end_category/0: 10f.  The most simple category will be one that is
self-contained, not depending on any other Logtalk entity:

     :- category(Category).
         ...
     :- end_category.

If a category implements one or more protocols, then the opening
directive will be:

     :- category(Category,
         implements([Protocol1, Protocol2, ...])).
         ...
     :- end_category.

A category may be defined as a composition of other categories by
writing:

     :- category(Category,
         extends([Category1, Category2, ...])).
         ...
     :- end_category.

This feature should only be used when extending a category without
breaking its functional cohesion (for example, when a modified version
of a category is needed for importing on several unrelated objects).
The preferred way of composing several categories is by importing them
into an object.  When a category overrides a predicate defined in an
extended category, the overridden definition can still be called by
using the *note (^^)/1: 5d. control construct.

Categories cannot inherit from objects.  In addition, categories cannot
define clauses for dynamic predicates.  This restriction applies because
a category can be imported by several objects and because we cannot use
the database handling built-in methods with categories (messages can
only be sent to objects).  A consequence of this restriction is that a
category cannot declare a predicate (or non-terminal) as both multifile
and dynamic.  However, categories may contain declarations for dynamic
predicates, and they can contain predicates that handle dynamic
predicates.  For example:

     :- category(attributes).

         :- public(attribute/2).
         :- public(set_attribute/2).
         :- public(del_attribute/2).

         :- private(attribute_/2).
         :- dynamic(attribute_/2).

         attribute(Attribute, Value) :-
             % called in the context of "self"
             ::attribute_(Attribute, Value).

         set_attribute(Attribute, Value) :-
             % retract old clauses in "self"
             ::retractall(attribute_(Attribute, _)),
             % assert new clause in "self"
             ::assertz(attribute_(Attribute, Value)).

         del_attribute(Attribute, Value) :-
             % retract clause in "self"
             ::retract(attribute_(Attribute, Value)).

     :- end_category.

Each object importing this category will have its own ‘attribute_/2’
private and dynamic predicate.  The predicates ‘attribute/2’,
‘set_attribute/2’, and ‘del_attribute/2’ always access and modify the
dynamic predicate contained in the object receiving the corresponding
messages (i.e., 'self').  But it’s also possible to define predicates
that handle dynamic predicates in the context of 'this' instead of
'self'.  For example:

     :- category(attributes).

         :- public(attribute/2).
         :- public(set_attribute/2).
         :- public(del_attribute/2).

         :- private(attribute_/2).
         :- dynamic(attribute_/2).

         attribute(Attribute, Value) :-
             % call in the context of "this"
             attribute_(Attribute, Value).

         set_attribute(Attribute, Value) :-
             % retract old clauses in "this"
             retractall(attribute_(Attribute, _)),
             % asserts clause in "this"
             assertz(attribute_(Attribute, Value)).

         del_attribute(Attribute, Value) :-
             % retract clause in "this"
             retract(attribute_(Attribute, Value)).

     :- end_category.

When defining a category that declares and handles dynamic predicates,
working in the context of 'this' ties those dynamic predicates to the
object importing the category, while working in the context of 'self'
allows each object inheriting from the object that imports the category
to have its own set of clauses for those dynamic predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Hot patching,  Next: Finding defined categories,  Prev: Defining a new category,  Up: Categories

1.7.2 Hot patching
------------------

A category may also explicitly complement one or more existing objects,
thus providing *note hot patching: 10b. functionality inspired by
Objective-C categories:

     :- category(Category,
         complements([Object1, Object2, ....])).
         ...
     :- end_category.

This allows us to add missing directives (e.g., to define *note aliases:
ca. for complemented object predicates), replace broken predicate
definitions, add new predicates, and add protocols and categories to
existing objects without requiring access or modifications to their
source code.  Common scenarios are adding logging or debugging
predicates to a set of objects.  Complemented objects need to be
compiled with the *note complements: 112. compiler flag set ‘allow’ (to
allow both patching and adding functionality) or ‘restrict’ (to allow
only adding new functionality).  A complementing category takes
preference over a previously loaded complementing category for the same
object, thus allowing patching a previous patch if necessary.

When replacing a predicate definition, it is possible to call the
overridden definition in the object from the new definition in the
category by using the *note (@)/1: 113. control construct.  This
construct is only meaningful when used within categories and requires a
compile-time bound goal argument, which is called in *note this: 114.
(i.e., in the context of the complemented object or the object importing
a category).  As an example, consider the following object:

     :- object(bird).

         :- set_logtalk_flag(complements, allow).

         :- public(make_sound/0).
         make_sound :-
             write('Chirp, chirp!'), nl.

     :- end_object.

We can use the ‘(@)/1’ control construct to wrap the original
‘make_sound/0’ predicate definition by writing:

     :- category(logging,
         complements(bird)).

         make_sound :-
             write('Started making sound...'), nl,
             @make_sound,
             write('... finished making sound.'), nl.

     :- end_category.

After loading the object and the category, calling the ‘make_sound/0’
predicate will result in the following output:

     | ?- bird::make_sound.

     Started making sound...
     Chirp, chirp!
     ... finished making sound.
     yes

Note that *note super calls: 115. from predicates defined in
complementing categories lookup inherited definitions as if the calls
were made from the complemented object instead of the category
ancestors.  This allows more comprehensive object patching.  But it also
means that, if you want to patch an object so that it imports a category
that extends another category and uses super calls to access the
extended category predicates, you will need to define a (possibly empty)
complementing category that extends the category that you want to add.

An unfortunate consequence of allowing an object to be patched at
runtime using a complementing category is that it disables the use of
*note static binding: 35. optimizations for messages sent to the
complemented object, as it can always be later patched, thus rendering
the static binding optimizations invalid.

Another important caveat is that, while a complementing category can
replace a predicate definition, local callers of the replaced predicate
will still call the non-patched version of the predicate.  This is a
consequence of the lack of a portable solution at the *note backend
Prolog compiler: 34. level for replacing static predicate definitions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Finding defined categories,  Next: Creating a new category at runtime,  Prev: Hot patching,  Up: Categories

1.7.3 Finding defined categories
--------------------------------

We can find, by backtracking, all defined categories by using the *note
current_category/1: f1. built-in predicate with an unbound argument:

     | ?- current_category(Category).

This predicate can also be used to test if a category is defined by
calling it with a valid category identifier (an atom or a compound
term).


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating a new category at runtime,  Next: Abolishing an existing category,  Prev: Finding defined categories,  Up: Categories

1.7.4 Creating a new category at runtime
----------------------------------------

A category can be dynamically created at runtime by using the *note
create_category/4: 11a. built-in predicate:

     | ?- create_category(Category, Relations, Directives, Clauses).

The first argument should be either a variable or the name of the new
category (a Prolog atom, which must not match with an existing entity
name).  The remaining three arguments correspond to the relations
described in the opening category directive and to the category code
contents (directives and clauses).

For example, the call:

     | ?- create_category(
              ccc,
              [implements(ppp)],
              [private(bar/1)],
              [(foo(X):-bar(X)), bar(1), bar(2)]
          ).

is equivalent to compiling and loading the category:

     :- category(ccc,
         implements(ppp)).

         :- dynamic.

         :- private(bar/1).

         foo(X) :-
             bar(X).

         bar(1).
         bar(2).

     :- end_category.

If we need to create a lot of (dynamic) categories at runtime, then it
is best to define a metaclass or a prototype with a predicate that will
call this built-in predicate in order to provide more sophisticated
behavior.


File: TheLogtalkHandbook-3.100.1.info,  Node: Abolishing an existing category,  Next: Category directives,  Prev: Creating a new category at runtime,  Up: Categories

1.7.5 Abolishing an existing category
-------------------------------------

Dynamic categories can be abolished using the *note abolish_category/1:
f5. built-in predicate:

     | ?- abolish_category(Category).

The argument must be an identifier of a defined dynamic category;
otherwise, an error will be thrown.


File: TheLogtalkHandbook-3.100.1.info,  Node: Category directives,  Next: Category relationships,  Prev: Abolishing an existing category,  Up: Categories

1.7.6 Category directives
-------------------------

Category directives are used to define category properties, document
category dependencies on other Logtalk entities, and load the contents
of files into a category.

* Menu:

* Dynamic categories::
* Category documentation::
* Loading files into a category::
* Declaring object aliases: Declaring object aliases<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dynamic categories,  Next: Category documentation,  Up: Category directives

1.7.6.1 Dynamic categories
..........................

As usually happens with Prolog code, a category can be either static or
dynamic.  A category created during the execution of a program is always
dynamic.  A category defined in a file can be either dynamic or static.
Dynamic categories are declared by using the *note dynamic/0: b1.
directive in the category source code:

     :- dynamic.

The directive must precede any predicate directives or clauses.  Please
be aware that using dynamic code results in a performance hit when
compared to static code.  We should only use dynamic categories when
these need to be abolished during program execution.


File: TheLogtalkHandbook-3.100.1.info,  Node: Category documentation,  Next: Loading files into a category,  Prev: Dynamic categories,  Up: Category directives

1.7.6.2 Category documentation
..............................

A category can be documented with arbitrary user-defined information by
using the *note info/1: b4. entity directive.  See the *note
Documenting: b5. section for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading files into a category,  Next: Declaring object aliases<2>,  Prev: Category documentation,  Up: Category directives

1.7.6.3 Loading files into a category
.....................................

The *note include/1: b8. directive can be used to load the contents of a
file into a category.  See the *note Objects: 91. section for an example
of using this directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Declaring object aliases<2>,  Prev: Loading files into a category,  Up: Category directives

1.7.6.4 Declaring object aliases
................................

The *note uses/1: 4a. directive can be used to declare object aliases.
The typical uses of this directive are to shorten long object names and
to simplify experimenting with different object implementations of the
same protocol when using explicit message-sending.


File: TheLogtalkHandbook-3.100.1.info,  Node: Category relationships,  Next: Category properties,  Prev: Category directives,  Up: Categories

1.7.7 Category relationships
----------------------------

Logtalk provides two sets of built-in predicates that enable us to query
the system about the relationships that a category has with other
entities.

The built-in predicates *note implements_protocol/2-3: c1. and *note
conforms_to_protocol/2-3: c2. allow us to find which categories
implement which protocols:

     | ?- implements_protocol(Category, Protocol, Scope).

or, if we also want to consider inherited protocols:

     | ?- conforms_to_protocol(Category, Protocol, Scope).

Note that, if we use an unbound first argument, we will need to use the
*note current_category/1: f1. built-in predicate to ensure that the
returned entity is a category and not an object.

To find which objects import which categories, we can use the *note
imports_category/2-3: c0. built-in predicates:

     | ?- imports_category(Object, Category).

or, if we also want to know the importation scope:

     | ?- imports_category(Object, Category, Scope).

Note that a category may be imported by several objects.

To find which categories extend other categories, we can use the *note
extends_category/2-3: 129. built-in predicates:

     | ?- extends_category(Category1, Category2).

or, if we also want to know the extension scope:

     | ?- extends_category(Category1, Category2, Scope).

Note that a category may be extended by several categories.

To find which categories explicitly complement existing objects we can
use the *note complements_object/2: c3. built-in predicate:

     | ?- complements_object(Category, Object).

Note that a category may explicitly complement several objects.


File: TheLogtalkHandbook-3.100.1.info,  Node: Category properties,  Next: Importing categories,  Prev: Category relationships,  Up: Categories

1.7.8 Category properties
-------------------------

We can find the properties of defined categories by calling the built-in
predicate *note category_property/2: 12c.:

     | ?- category_property(Category, Property).

The following category properties are supported:

‘static’

     The category is static

‘dynamic’

     The category is dynamic (and thus can be abolished in runtime by
     calling the *note abolish_category/1: f5. built-in predicate)

‘built_in’

     The category is a built-in category (and thus always available)

‘file(Path)’

     Absolute path of the source file defining the category (if
     applicable)

‘file(Basename, Directory)’

     Basename and directory of the source file defining the category (if
     applicable); ‘Directory’ always ends with a ‘/’

‘lines(BeginLine, EndLine)’

     Source file begin and end lines of the category definition (if
     applicable)

‘directive(BeginLine, EndLine)’

     Source file begin and end lines of the category opening directive
     (if applicable)

‘events’

     Messages sent from the category generate events

‘source_data’

     Source data available for the category

‘info(List)’

     List of the compound term representation of the object ‘info/1’
     pairs with the key as functor.

‘public(Resources)’

     List of public predicates and operators declared by the category

‘protected(Resources)’

     List of protected predicates and operators declared by the category

‘private(Resources)’

     List of private predicates and operators declared by the category

‘declares(Predicate, Properties)’

     List of *note properties: c8. for a predicate declared by the
     category

‘defines(Predicate, Properties)’

     List of *note properties: c8. for a predicate defined by the
     category

‘includes(Predicate, Entity, Properties)’

     List of *note properties: c8. for an object multifile predicate
     that are defined in the specified entity (the properties include
     ‘number_of_clauses(Number)’, ‘number_of_rules(Number)’,
     ‘lines(Start,End)’, and ‘line_count(Start)’ with ‘Start-End’ being
     the line range of the first multifile predicate clause)

‘provides(Predicate, Entity, Properties)’

     List of *note properties: c8. for other entity multifile predicate
     that are defined in the category (the properties include
     ‘number_of_clauses(Number)’, ‘number_of_rules(Number)’,
     ‘lines(Start,End)’, and ‘line_count(Start)’ with ‘Start-End’ being
     the line range of the first multifile predicate clause)

‘references(Reference, Properties)’

     List of *note properties: c8. for other references to entities in
     calls to the execution-context built-in methods and in directives
     for multifile predicates and multifile non-terminals that are found
     in the category (the properties include ‘in(Context)’,
     ‘non_terminal(NonTerminal)’, ‘include(File)’, ‘lines(Start,End)’,
     and ‘line_count(Start)’ with ‘Start-End’ being the line range of
     the first reference, a directive, a predicate clause, or a
     non-terminal grammar rule; the possible values for ‘Context’ are
     ‘multifile’, ‘dynamic’, ‘discontiguous’, ‘meta_predicate’,
     ‘meta_non_terminal’, and ‘clause’); ‘Reference’ can be either
     ‘Entity’ or ‘Entity::Functor/Arity’

‘alias(Entity, Properties)’

     List of *note properties: c8. for an *note entity alias: c9.
     declared by the object (the properties include ‘object’ in case of
     an object alias, ‘module’ in case of a module alias,
     ‘for(Original)’, ‘lines(Start,End)’, and ‘line_count(Start)’ with
     ‘Start-End’ being the line range of the ‘uses/1’ or ‘use_module/1’
     directive)

‘alias(Predicate, Properties)’

     List of *note properties: c8. for a *note predicate alias: ca.
     declared by the category (the properties include ‘predicate’,
     ‘for(Original)’, ‘from(Entity)’, ‘non_terminal(NonTerminal)’,
     ‘lines(Start,End)’, and ‘line_count(Start)’ with ‘Start-End’ being
     the line range of the alias directive)

‘calls(Call, Properties)’

     List of *note properties: c8. for predicate calls made by the
     category (‘Call’ is either a predicate indicator or a control
     construct such as ‘(::)/1-2’ or ‘(^^)/1’ with a predicate indicator
     as argument; note that ‘Call’ may not be ground in case of a call
     to a control construct where its argument is only know at runtime;
     the properties include ‘caller(Caller)’, ‘alias(Alias)’,
     ‘non_terminal(NonTerminal)’, ‘lines(Start,End)’, and
     ‘line_count(Start)’ with ‘Caller’, ‘Alias’, and ‘NonTerminal’ being
     predicate indicators and ‘Start-End’ being the line range of the
     predicate clause or directive making the call)

‘updates(Predicate, Properties)’

     List of *note properties: c8. for dynamic predicate updates (and
     also access using the ‘clause/2’ predicate) made by the object
     (‘Predicate’ is either a predicate indicator or a control construct
     such as ‘(::)/1-2’ or ‘(:)/2’ with a predicate indicator as
     argument; note that ‘Predicate’ may not be ground in case of a
     control construct argument only know at runtime; the properties
     include ‘updater(Updater)’, ‘alias(Alias)’,
     ‘non_terminal(NonTerminal)’, ‘lines(Start,End)’, and
     ‘line_count(Start)’ with ‘Updater’ being a (possibly multifile)
     predicate indicator, ‘Alias’ and ‘NonTerminal’ being predicate
     indicators, and ‘Start-End’ being the line range of the predicate
     clause or directive updating the predicate)

‘number_of_clauses(Number)’

     Total number of predicate clauses defined in the category (includes
     both user-defined clauses and auxiliary clauses generated by the
     compiler or by the *note expansion hooks: cb. but does not include
     clauses for multifile predicates defined for other entities or
     clauses for the category own multifile predicates contributed by
     other entities)

‘number_of_rules(Number)’

     Total number of predicate rules defined in the category (includes
     both user-defined rules and auxiliary rules generated by the
     compiler or by the *note expansion hooks: cb. but does not include
     rules for multifile predicates defined for other entities or rules
     for the category own multifile predicates contributed by other
     entities)

‘number_of_user_clauses(Number)’

     Total number of user-defined predicate clauses defined in the
     category (does not include clauses for multifile predicates defined
     for other entities or clauses for the category own multifile
     predicates contributed by other entities)

‘number_of_user_rules(Number)’

     Total number of user-defined predicate rules defined in the
     category (does not include rules for multifile predicates defined
     for other entities or rules for the category own multifile
     predicates contributed by other entities)

Some properties, such as line numbers, are only available when the
category is defined in a source file compiled with the *note
source_data: cc. flag turned on.  Moreover, line numbers are only
supported in *note backend Prolog compilers: 34. that provide access to
the start line of a read term.  When such support is not available, the
value ‘-1’ is returned for the start and end lines.

The properties that return the number of clauses (rules) report the
clauses (rules) 'textually defined in the object' for both multifile and
non-multifile predicates.  Thus, these numbers exclude clauses (rules)
for multifile predicates 'contributed' by other entities.


File: TheLogtalkHandbook-3.100.1.info,  Node: Importing categories,  Next: Calling category predicates,  Prev: Category properties,  Up: Categories

1.7.9 Importing categories
--------------------------

Any number of objects can import a category.  In addition, an object may
import any number of categories.  The syntax is very simple:

     :- object(Object,
         imports([Category1, Category2, ...])).
         ...
     :- end_object.

To make all public predicates imported via a category protected, or to
make all public and protected predicates private, we prefix the
category’s name with the corresponding keyword:

     :- object(Object,
         imports(private::Category)).
         ...
     :- end_object.

or:

     :- object(Object,
         imports(protected::Category)).
         ...
     :- end_object.

Omitting the scope keyword is equivalent to writing:

     :- object(Object,
         imports(public::Category)).
         ...
     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling category predicates,  Next: Parametric categories,  Prev: Importing categories,  Up: Categories

1.7.10 Calling category predicates
----------------------------------

Category predicates can be called from within an object by sending a
message to 'self' or using a 'super' call.  Consider the following
category:

     :- category(output).

         :- public(out/1).

         out(X) :-
             write(X), nl.

     :- end_category.

The predicate ‘out/1’ can be called from within an object importing the
category by simply sending a message to 'self'.  For example:

     :- object(worker,
         imports(output)).

         ...
         do(Task) :-
             execute(Task, Result),
             ::out(Result).
         ...

     :- end_object.

This is the recommended way of calling a category predicate that can be
specialized/overridden in a descendant object, as the predicate
definition lookup will start from 'self'.

A direct call to a predicate definition found in an imported category
can be made using the *note (^^)/1: 5d. control construct.  For example:

     :- object(worker,
         imports(output)).

         ...
         do(Task) :-
             execute(Task, Result),
             ^^out(Result).
         ...

     :- end_object.

This alternative should only be used when the user knows a priori that
the category predicates will not be specialized or redefined by
descendant objects of the object importing the category.  Its advantage
is that, when the *note optimize: 8c. flag is turned on, the Logtalk
compiler will try to optimize the calls by using *note static binding:
35.  When *note dynamic binding: 36. is used due to e.g.  the lack of
sufficient information at compilation time, the performance is similar
to calling the category predicate using a message to *note self: 69. (in
both cases, a predicate lookup caching mechanism is used).


File: TheLogtalkHandbook-3.100.1.info,  Node: Parametric categories,  Next: Built-in categories,  Prev: Calling category predicates,  Up: Categories

1.7.11 Parametric categories
----------------------------

Category predicates can be parameterized in the same way as object
predicates by using a compound term as the category identifier where all
the arguments of the compound term are variables.  These variables, the
'category parameters', are 'logical variables' and can be accessed by
calling the *note parameter/2: a2. or *note this/1: 68. built-in local
methods in the category predicate clauses or by using *note parameter
variables: a1.

As a consequence of parameters being logical variables, when defining,
for example, a parametric category named ‘foo/1’, ‘foo(bar)’ and
‘foo(baz)’ are different parameterizations of the same category, not
distinct categories.

Category parameter values can be defined by the importing objects.  For
example:

     :- object(speech(Season, Event),
         imports([dress(Season), speech(Event)])).
         ...
     :- end_object.

Note that access to category parameters is only possible from within the
category.  In particular, calls to the *note this/1: 68. built-in local
method from category predicates always access the importing object
identifier (and thus object parameters, not category parameters).


File: TheLogtalkHandbook-3.100.1.info,  Node: Built-in categories,  Next: Multi-threading applications<3>,  Prev: Parametric categories,  Up: Categories

1.7.12 Built-in categories
--------------------------

Logtalk defines a built-in category that is always available for any
application.

* Menu:

* The built-in category core_messages::


File: TheLogtalkHandbook-3.100.1.info,  Node: The built-in category core_messages,  Up: Built-in categories

1.7.12.1 The built-in category ‘core_messages’
..............................................

The built-in core_messages(1) category provides default translations for
all compiler and runtime printed messages, such as warnings and errors.
It does not define any public predicates.

   ---------- Footnotes ----------

   (1) ../../apis/core_messages_0.html#core-messages-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading applications<3>,  Prev: Built-in categories,  Up: Categories

1.7.13 Multi-threading applications
-----------------------------------

When writing multi-threading applications, user-defined predicates
calling built-in predicates such as ‘create_category/4’ and
‘abolish_category/1’ may need to be declared synchronized in order to
avoid race conditions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Predicates,  Next: Inheritance,  Prev: Categories,  Up: User Manual

1.8 Predicates
==============

Predicate directives and clauses can be encapsulated inside objects and
categories.  Protocols can only contain predicate directives.  From the
point of view of a traditional imperative object-oriented language,
predicates allow both object state and object behavior to be
represented.  Mutable object state can be represented using dynamic
object predicates but should only be used when strictly necessary, as it
breaks declarative semantics.

* Menu:

* Reserved predicate names::
* Declaring predicates::
* Defining predicates::
* Definite clause grammar rules::
* Built-in methods::
* Predicate properties::
* Finding declared predicates::
* Calling Prolog predicates::
* Defining Prolog multifile predicates::
* Asserting and retracting Prolog predicates::


File: TheLogtalkHandbook-3.100.1.info,  Node: Reserved predicate names,  Next: Declaring predicates,  Up: Predicates

1.8.1 Reserved predicate names
------------------------------

For practical and performance reasons, some predicate names have a fixed
interpretation.  These predicates are declared in the built-in
protocols.  They are: *note goal_expansion/2: fd. and *note
term_expansion/2: fc, declared in the expanding(1) protocol; *note
before/3: 101. and *note after/3: 102, declared in the monitoring(2)
protocol; and *note forward/1: 105, declared in the forwarding(3)
protocol.  By default, the compiler prints a warning when a definition
for one of these predicates is found but the reference to the
corresponding built-in protocol is missing.

   ---------- Footnotes ----------

   (1) ../../apis/expanding_0.html#expanding-0

   (2) ../../apis/monitoring_0.html#monitoring-0

   (3) ../../apis/forwarding_0.html#forwarding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Declaring predicates,  Next: Defining predicates,  Prev: Reserved predicate names,  Up: Predicates

1.8.2 Declaring predicates
--------------------------

Logtalk provides a clear distinction between 'declaring a predicate' and
'defining a predicate' and thus clear *note closed-world assumption: 6a.
semantics.  Messages or calls for declared but undefined predicates
fail.  Messages or calls for unknown (i.e., non-declared) predicates
throw an error.  Note that this is a fundamental requirement for
supporting *note protocols: d9.: we must be able to declare a predicate
without necessarily defining it.

All object (or category) predicates that we want to access from other
objects (or categories) must be explicitly declared.  A predicate
declaration must contain, at least, a 'scope' directive.  Other
directives may be used to document the predicate or to ensure proper
compilation of the predicate clauses.

* Menu:

* Scope directives::
* Mode directive::
* Meta-predicate directive::
* Discontiguous directive::
* Dynamic directive::
* Operator directive::
* Uses directive::
* Alias directive::
* Documenting directive::
* Multifile directive::
* Coinductive directive::
* Synchronized directive::


File: TheLogtalkHandbook-3.100.1.info,  Node: Scope directives,  Next: Mode directive,  Up: Declaring predicates

1.8.2.1 Scope directives
........................

A predicate scope directive specifies 'from where' the predicate can be
called, i.e.  its 'visibility'.  Predicates can be 'public',
'protected', 'private', or 'local'.  Public predicates can be called
from any object.  Protected predicates can only be called from the
container object or from a container descendant.  Private predicates can
only be called from the container object.  Predicates are local when
they are not declared in a scope directive.  Local predicates, like
private predicates, can only be called from the container object (or
category), but they are 'invisible' to the reflection built-in methods
(*note current_predicate/1: 141. and *note predicate_property/2: 142.)
and to the message error handling mechanisms (i.e., sending a message
corresponding to a local predicate results in a ‘predicate_declaration’
existence error instead of a scope error).

The scope declarations are made using the directives *note public/1:
143, *note protected/1: 144, and *note private/1: 145.  For example:

     :- public(init/1).

     :- protected(valid_init_option/1).

     :- private(process_init_options/1).

If a predicate does not have a (local or inherited) scope declaration,
it is assumed that the predicate is local.  Note that we do not need to
write scope declarations for all defined predicates.  One exception is
local dynamic predicates: declaring them as private predicates may allow
the Logtalk compiler to generate optimized code for asserting and
retracting clauses.

Note that a predicate scope directive doesn’t specify 'where' a
predicate is, or can be, defined.  For example, a private predicate can
only be called from an object holding its scope directive.  But it can
be defined in descendant objects.  A typical example is an object
playing the role of a class defining a private (possibly dynamic)
predicate for its descendant instances.  Only the class can call (and
possibly assert/retract clauses for) the predicate, but its clauses can
be found/defined in the instances themselves.

Scope directives may also be used to declare grammar rule non-terminals
and operators.  For example:

     :- public(url//1).

     :- public(op(800, fx, tag)).

Note that, in the case of operators, the operator definitions don’t
become global when the entity containing the directives is compiled and
loaded.  This prevents an application from breaking when, for example,
an updated third-party library adds new operators.  It also allows
loading entities that provide conflicting operator definitions.  Here
the usual programming idiom is to copy the operator definitions to a
‘uses/2’ directive.  For example, the *note lgtunit: 146. tool makes
available a ‘(=~=)/2’ predicate (for approximate float equality) that is
intended to be used as an infix operator:

     :- uses(lgtunit, [
         op(700, xfx, =~=), (=~=)/2
     ]).

Thus, in practice, the solution to use library entity operators in
client entities is the same for using library entity predicates with
implicit message-sending.


File: TheLogtalkHandbook-3.100.1.info,  Node: Mode directive,  Next: Meta-predicate directive,  Prev: Scope directives,  Up: Declaring predicates

1.8.2.2 Mode directive
......................

Often predicates can only be called using specific argument patterns.
The valid arguments and instantiation modes of those arguments can be
documented using the *note mode/2: 149. directive (in the case of
'non-terminals', there’s also a *note mode_non_terminal/2: 14a.
directive).  For example:

     :- mode(member(?term, ?list), zero_or_more).
The first directive argument describes a valid 'calling mode'.  The
minimum information will be the instantiation mode of each argument.
The first four possible values are described in the ISO Prolog Core
standard *note [ISO95]: 31. (but with the meaning of the ‘-’
instantiation mode redefined here).  The remaining two can also be found
in use in some Prolog systems.

‘+’

     Argument must be instantiated (but not necessarily ground).

‘-’

     Argument should be a free (non-instantiated) variable.  When bound,
     the call will unify the computed term with the given argument.

‘?’

     Argument can either be instantiated or free.

‘@’

     Argument will not be further instantiated (modified).

‘++’

     Argument must be ground.

‘--’

     Argument must be unbound.  Used mainly when returning an opaque
     term (e.g., a stream handle).

Note that the ‘+’ and ‘@’ instantiation modes have the same meaning for
atomic arguments.  E.g.  you can write either ‘+atom’ or ‘@atom’ but the
first alternative is preferred.

The ISO ‘-’ instantiation mode is equivalent to the Logtalk ‘--’ mode,
allowing the use ‘-’ to document predicates with output arguments that
don’t require those arguments to be unbound at call time and also accept
bound arguments without throwing an exception.

These six mode atoms are also declared as prefix operators by the
Logtalk compiler.  This makes it possible to include type information
for each argument as in the example above.  Some possible type values
are: ‘event’, ‘object’, ‘category’, ‘protocol’, ‘callable’, ‘term’,
‘nonvar’, ‘var’, ‘atomic’, ‘atom’, ‘number’, ‘integer’, ‘float’,
‘compound’, and ‘list’.  The first four are Logtalk specific.  The
remaining are common Prolog types.  We can also use our own types that
can be either atoms or ground compound terms.  See the *note types: 14c.
library documentation for an extensive list of pre-defined types that
cover most common use cases.  The second directive argument documents
the 'number of proofs', but not necessarily distinct solutions, for the
specified mode.  As an example, the ‘member(X, [1,1,1,1])’ goal has only
one distinct solution but four proofs for that solution.  Note that
different modes for the same predicate often have different determinism.
The possible values are:

‘zero’

     Predicate always fails (e.g., the ‘false/0’ standard predicate).

‘one’

     Predicate always succeeds once (e.g., the ‘flush_output/0’ standard
     predicate).

‘zero_or_one’

     Predicate either fails or succeeds (e.g., the ‘atom/1’ standard
     predicate).

‘zero_or_more’

     Predicate has zero or more proofs (e.g., the ‘current_predicate/1’
     standard predicate).

‘one_or_more’

     Predicate has one or more proofs (e.g., the ‘repeat/0’ standard
     predicate).

‘zero_or_error’

     Predicate either fails or throws an error.

‘one_or_error’

     Predicate either succeeds once or throws an error (e.g., the
     ‘open/3’ standard predicate).

‘zero_or_one_or_error’

     Predicate succeeds once or fails or throws an error (e.g., the
     ‘get_char/1’ standard predicate).

‘zero_or_more_or_error’

     Predicate may fail or succeed multiple times or throw an error
     (e.g., the ‘retract/1’ standard predicate).

‘one_or_more_or_error’

     Predicate may succeed one or more times or throw an error.

‘error’

     Predicate will throw an error (e.g., the ‘type_error/2’ built-in
     method).

The last six values support documenting that some call modes may throw
an error or will throw an error 'despite the call arguments complying
with the expected types and instantiation modes'.  As an example,
consider the ‘open/3’ standard predicate:

     :- mode(open(@source_sink, @io_mode, --stream), one_or_error).

In this case, the mode directive tells the user that a valid call can
still throw an error (there may be e.g.  a permission error opening the
specified source or sink).

Notice that using the ‘zero’, ‘one’, ‘zero_or_one’, ‘zero_or_more’, or
‘one_or_more’ modes is not only for predicates that never throw an
exception; they can also be used for any predicate that doesn’t throw an
exception when the arguments are valid.  For example, the
‘current_predicate/1’ standard predicate throws an exception if the
argument is neither a variable nor a predicate indicator, but it
succeeds zero or more times when its argument is valid:

     :- mode(current_predicate(?predicate_indicator), zero_or_more).

Some predicates have more than one valid mode, thus implying several
mode directives.  For example, to document the possible use modes of the
standard ‘atom_concat/3’ predicate, we would write:

     :- mode(atom_concat(?atom, ?atom, +atom), one_or_more).
     :- mode(atom_concat(+atom, +atom, -atom), one).

The first ‘mode/2’ directive specifies that the ‘atom_concat/3’
predicate can be used to split an atom into a prefix and a suffix.  The
second ‘mode/2’ directive specifies that concatenating two atoms results
in a new atom.  There are often several alternative ‘mode/2’ directives
that can be used to specify a predicate.  For example, an alternative to
the second ‘mode/2’ directive above would be:

     :- mode(atom_concat(+atom, +atom, ?atom), zero_or_one).

In this case, the same information is provided by both alternatives.
But the first alternative is simpler and thus preferred.

Some old Prolog compilers supported some sort of mode directives to
improve performance.  To the best of my knowledge, there is no modern
Prolog compiler supporting this kind of directive for that purpose.  The
current Logtalk version simply parses this directive for collecting its
information for use in the *note reflection API: 48. (assuming the *note
source_data: cc. flag is turned on).  In any case, the use of mode
directives is a good starting point for documenting your predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate directive,  Next: Discontiguous directive,  Prev: Mode directive,  Up: Declaring predicates

1.8.2.3 Meta-predicate directive
................................

Some predicates may have arguments that will be called as goals,
interpreted as *note closures: 14f. that will be used for constructing
goals, or passing meta-arguments to calls to other meta-predicates.  To
ensure that these goals will be executed in the correct context (i.e.,
in the *note calling context: 150, not in the meta-predicate *note
definition context: 151.), we need to use the *note meta_predicate/1:
152. directive (in the case of 'meta non-terminals', there’s also a
*note meta_non_terminal/1: 153. directive).  For example:

     :- meta_predicate(findall(*, 0, *)).
     :- meta_predicate(map(2, *, *)).

The meta-predicate mode arguments in this directive have the following
meaning:

‘0’

     Meta-argument that will be called as a goal.

‘N’

     Meta-argument that will be a closure used to construct a call by
     extending it with ‘N’ arguments.  The value of ‘N’ must be a
     positive integer.

‘::’

     Argument that is context-aware but that will not be called as a
     goal or a closure.  It can contain, however, sub-terms that will be
     called as goals or closures.

‘^’

     Goal that may be existentially quantified (‘Vars^Goal’).

‘*’

     Normal argument.

The following meta-predicate mode arguments are for use only when
writing backend Prolog *note adapter files: 154. to deal with
proprietary built-in meta-predicates and meta-directives:

‘/’

     Predicate indicator (‘Name/Arity’), list of predicate indicators,
     or conjunction of predicate indicators.

‘//’

     Non-terminal indicator (‘Name//Arity’), list of predicate
     indicators, or conjunction of predicate indicators.

‘[0]’

     List of goals.

‘[N]’

     List of closures.

‘[/]’

     List of predicate indicators.

‘[//]’

     List of non-terminal indicators.

To the best of my knowledge, the use of non-negative integers to specify
closures was first introduced on Quintus Prolog for providing
information for predicate cross-reference tools.

Note that Logtalk meta-predicate semantics are different from Prolog
meta-predicate semantics (assuming a predicate-based module system as
common):

   - Meta-arguments are always called in the meta-predicate calling
     context, independent of using explicit or implicit message-sending
     (to the object defining the meta-predicate when not local).  Most
     Prolog systems have different semantics for explicit versus
     implicit module qualification.

   - Logtalk is not based on a predicate prefixing mechanism.
     Therefore, the meta-predicate directive is required for any
     predicate with meta-arguments (including when simply passing the
     meta-arguments to a call to another meta-predicate).  This is
     usually not required in Prolog systems due to the module prefixing
     of meta-arguments.

   - Sending a message from a meta-predicate definition to call a
     meta-predicate defined in another object resets the calling context
     for any passed meta-argument to the object sending the message
     (including for messages to 'self').  Meta-arguments behave
     differently in Prolog systems due to their module prefixing.

   - Logtalk protects from common scenarios where specially crafted
     meta-predicate definitions are used to break object (and category)
     encapsulation by changing the meta-arguments passed by client code
     or trying to subvert the implicit calling context to call client
     predicates other than the predicates passed as meta-arguments.

     Warning: As each Logtalk entity is independently compiled, this
     directive must be included in every object or category that
     contains a definition for the described meta-predicate, even if the
     meta-predicate declaration is inherited from another entity, to
     ensure proper compilation of meta-arguments.


File: TheLogtalkHandbook-3.100.1.info,  Node: Discontiguous directive,  Next: Dynamic directive,  Prev: Meta-predicate directive,  Up: Declaring predicates

1.8.2.4 Discontiguous directive
...............................

The clause of an object (or category) predicate may not be contiguous.
In that case, we must declare the predicate discontiguous by using the
*note discontiguous/1: 157. directive:

     :- discontiguous(foo/1).

This is a directive that we should avoid using: it makes your code
harder to read, and it is not supported by some Prolog backends.

     Warning: As each Logtalk entity is compiled independently of other
     entities, this directive must be included in every object or
     category that contains a definition for the described predicate
     (even if the predicate declaration is inherited from another
     entity).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dynamic directive,  Next: Operator directive,  Prev: Discontiguous directive,  Up: Declaring predicates

1.8.2.5 Dynamic directive
.........................

An object predicate can be static or dynamic.  By default, all
predicates (and non-terminals) of static objects defined in source files
are static.  To declare a dynamic predicate (or non-terminal), we use
the *note dynamic/1: 15a. directive.  For example:

     :- dynamic(foo/1).

Predicates of objects dynamically created at runtime (using the *note
create_object/4: 62. built-in predicate) and predicates of dynamic
objects defined in source files (using the *note dynamic/0: b1.
directive) are implicitly dynamic.

Dynamic predicates can be used to represent persistent mutable object
state.  Note that static objects may declare and define dynamic
predicates.  Categories can only declare dynamic predicates (with the
importing objects holding the predicate definitions).

     Warning: As each Logtalk entity is compiled independently from
     other entities, this directive must be included in every object
     that contains a definition for the described predicate (even if the
     predicate declaration is inherited from another object or imported
     from a category).  If we omit the dynamic declaration then the
     predicate definition will be compiled static.


File: TheLogtalkHandbook-3.100.1.info,  Node: Operator directive,  Next: Uses directive,  Prev: Dynamic directive,  Up: Declaring predicates

1.8.2.6 Operator directive
..........................

An object (or category) predicate can be declared as an operator using
the familiar *note op/3: 15d. directive:

     :- op(Priority, Specifier, Operator).

Operators are local to the object (or category) where they are declared.
This means that, if you declare a public predicate as an operator, you
cannot use operator notation when sending to an object (where the
predicate is visible) the respective message (as this would imply
visibility of the operator declaration in the context of the 'sender' of
the message).  If you want to declare global operators and, at the same
time, use them inside an entity, just write the corresponding directives
at the top of your source file, before the entity opening directive.

Note that operators can also be declared using a scope directive.  Only
these operators are visible to the *note current_op/3: 15e. reflection
method.

When the same operators are used on several entities within the same
source file, the corresponding directives must either be repeated in
each entity or appear before any entity that uses them.  But in the
later case, this results in a global scope for the operators.  If you
prefer the operators to be local to the source file, just 'undefine'
them at the end of the file.  For example:

     % before any entity that uses the operator
     :- op(400, xfx, results).

     ...

     % after all entities that used the operator
     :- op(0, xfx, results).

Global operators can be declared in the application loader file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Uses directive,  Next: Alias directive,  Prev: Operator directive,  Up: Declaring predicates

1.8.2.7 Uses directive
......................

When a predicate makes heavy use of predicates defined on other objects,
its predicate clauses can be verbose due to all the necessary
message-sending goals.  Consider the following example:

     foo :-
         ...,
         findall(X, list::member(X, L), A),
         list::append(A, B, C),
         list::select(Y, C, R),
         ...

Logtalk provides a directive, *note uses/2: 4b, which allows us to
simplify the code above.  One of the usage templates for this directive
is:

     :- uses(Object, [
         Name1/Arity1, Name2/Arity2, ...
     ]).

Rewriting the code above using this directive results in a simplified
and more readable predicate definition:

     :- uses(list, [
         append/3, member/2, select/3
     ]).

     foo :-
         ...,
         findall(X, member(X, L), A),
         append(A, B, C),
         select(Y, C, R),
         ...

Logtalk also supports an extended version of this directive that allows
the declaration of *note predicate aliases: ca. using the notation
‘Predicate as Alias’ (or the alternative notation ‘Predicate::Alias’).
For example:

     :- uses(btrees, [new/1 as new_btree/1]).
     :- uses(queues, [new/1 as new_queue/1]).

You may use this extended version for solving conflicts between
predicates declared on several ‘uses/2’ directives or just for giving
new names to the predicates that will be more meaningful on their using
context.

Predicate aliases can also be used to define *note predicate shorthands:
161, simplifying code maintenance.  For example:

     :- uses(pretty_printer, [
         indent(4, Term) as indent(Term)
     ]).

Assuming multiple calls to the shorthand, a change to the indent value
will require a change to a single line instead of changing every call.

Another common use of predicate aliases is changing the order of the
predicate arguments without using *note lambda expressions: 162.  For
example:

     :- uses(meta, [
         fold_left(Closure, Result0, List, Result) as foldl(Closure, List, Result0, Result)
     ]).

See the directive documentation for details and other examples.

The ‘uses/2’ directive allows simpler predicate definitions as long as
there are no conflicts between the predicates declared in the directive
and the predicates defined in the object (or category) containing the
directive.  A predicate (or its alias if defined) cannot be listed in
more than one ‘uses/2’ directive.  In addition, a ‘uses/2’ directive
cannot list a predicate (or its alias if defined) that is defined in the
object (or category) containing the directive.  Any conflicts are
reported by Logtalk as compilation errors.

The object identifier argument can also be a *note parameter variable:
a1. when using the directive in a parametric object or a parametric
category.  In this case, *note dynamic binding: 36. will necessarily be
used for all listed predicates (and non-terminals).  The parameter
variable must be instantiated at runtime when the messages are sent.
This feature simplifies experimenting with multiple implementations of
the same protocol (for example, to evaluate the performance of each
implementation for a particular case).  It also simplifies writing tests
that check multiple implementations of the same protocol.

An object (or category) can make a predicate listed in a ‘uses/2’ (or
‘use_module/2’) directive part of its protocol by simply adding a scope
directive for the predicate.  For example, in the ‘statistics’ library
we have:

     :- public(modes/2).
     :- uses(numberlist, [modes/2]).

Therefore, a goal such as ‘sample::modes(Sample, Modes)’ implicitly
calls ‘numberlist::modes(Sample, Modes)’ without requiring an explicit
local definition for the ‘modes/2’ predicate (which would trigger a
compilation error).


File: TheLogtalkHandbook-3.100.1.info,  Node: Alias directive,  Next: Documenting directive,  Prev: Uses directive,  Up: Declaring predicates

1.8.2.8 Alias directive
.......................

Logtalk allows the definition of an alternative name for an inherited or
imported predicate (or for an inherited or imported grammar rule
non-terminal) through the use of the *note alias/2: 165. directive:

     :- alias(Entity, [
         Predicate1 as Alias1,
         Predicate2 as Alias2,
         ...
     ]).

This directive can be used in objects, protocols, or categories.  The
first argument, ‘Entity’, must be an entity referenced in the opening
directive of the entity containing the ‘alias/2’ directive.  It can be
an extended or implemented protocol, an imported category, an extended
prototype, an instantiated class, or a specialized class.  The second
argument is a list of pairs of predicate indicators (or grammar rule
non-terminal indicators) using the ‘as’ infix operator.

A common use for the ‘alias/2’ directive is to give an alternative name
to an inherited predicate in order to improve readability.  For example:

     :- object(square,
         extends(rectangle)).

         :- alias(rectangle, [width/1 as side/1]).

         ...

     :- end_object.

The directive allows both ‘width/1’ and ‘side/1’ to be used as messages
to the object ‘square’.  Thus, using this directive, there is no need to
explicitly declare and define a “new” ‘side/1’ predicate.  Note that the
‘alias/2’ directive does not rename a predicate, it only provides an
alternative, additional name; the original name continues to be
available (although it may be masked due to the default inheritance
conflict mechanism).

Another common use for this directive is to solve conflicts when two
inherited predicates have the same name and arity.  We may want to call
the predicate that is masked out by the Logtalk lookup algorithm (see
the *note Inheritance: 8. section) or we may need to call both
predicates.  This is simply accomplished by using the ‘alias/2’
directive to give alternative names to masked-out or conflicting
predicates.  Consider the following example:

     :- object(my_data_structure,
         extends(list, set)).

         :- alias(list, [member/2 as list_member/2]).
         :- alias(set,  [member/2 as set_member/2]).

         ...

     :- end_object.

Assuming that both ‘list’ and ‘set’ objects define a ‘member/2’
predicate, without the ‘alias/2’ directives, only the definition of
‘member/2’ predicate in the object ‘list’ would be visible on the object
‘my_data_structure’, as a result of the application of the Logtalk
predicate lookup algorithm.  By using the ‘alias/2’ directives, all the
following messages would be valid (assuming a public scope for the
predicates):

     % uses list member/2
     | ?- my_data_structure::list_member(X, L).

     % uses set member/2
     | ?- my_data_structure::set_member(X, L).

     % uses list member/2
     | ?- my_data_structure::member(X, L).

When used this way, the ‘alias/2’ directive provides functionality
similar to programming constructs of other object-oriented languages
that support multi-inheritance (the most notable example probably being
the renaming of inherited features in Eiffel).

Note that the ‘alias/2’ directive never hides a predicate that is
visible on the entity containing the directive as a result of the
Logtalk lookup algorithm.  However, it may be used to make visible a
predicate that otherwise would be masked by another predicate, as
illustrated in the above example.

The ‘alias/2’ directive may also be used to give access to an inherited
predicate, which otherwise would be masked by another inherited
predicate, while keeping the original name as follows:

     :- object(my_data_structure,
         extends(list, set)).

         :- alias(list, [member/2 as list_member/2]).
         :- alias(set,  [member/2 as set_member/2]).

         member(X, L) :-
             ^^set_member(X, L).

         ...

     :- end_object.

Thus, when sending the message ‘member/2’ to ‘my_data_structure’, the
predicate definition in ‘set’ will be used instead of the one contained
in ‘list’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Documenting directive,  Next: Multifile directive,  Prev: Alias directive,  Up: Declaring predicates

1.8.2.9 Documenting directive
.............................

A predicate can be documented with arbitrary user-defined information by
using the *note info/2: 168. directive:

     :- info(Name/Arity, List).

The second argument is a list of ‘Key is Value’ terms.  See the *note
Documenting: b5. section for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multifile directive,  Next: Coinductive directive,  Prev: Documenting directive,  Up: Declaring predicates

1.8.2.10 Multifile directive
............................

A predicate can be declared *note multifile: 16b. by using the *note
multifile/1: 16c. directive:

     :- multifile(Name/Arity).

This allows clauses for a predicate to be defined in several objects
and/or categories.  This is a directive that should be used with care.
It’s commonly used in the definition of *note hook predicates: 16d.
Multifile predicates (and non-terminals) may also be declared dynamic
using the same predicate (or non-terminal) notation (multifile
predicates are static by default).

Logtalk precludes using a multifile predicate for breaking object
encapsulation by checking that the object (or category) declaring the
predicate (using a scope directive) defines it also as multifile.  This
entity is said to contain the 'primary declaration' for the multifile
predicate.  Entities containing primary multifile predicate declarations
must always be compiled before entities defining clauses for those
multifile predicates.  The Logtalk compiler will print a warning if the
scope directive is missing.  Note also that the ‘multifile/1’ directive
is mandatory when defining multifile predicates.

Consider the following simple example:

     :- object(main).

         :- public(a/1).
         :- multifile(a/1).
         a(1).

     :- end_object.

After compiling and loading the ‘main’ object, we can define other
objects (or categories) that contribute with clauses for the multifile
predicate.  For example:

     :- object(other).

         :- multifile(main::a/1).
         main::a(2).
         main::a(X) :-
             b(X).

         b(3).
         b(4).

     :- end_object.

After compiling and loading the above objects, you can use queries such
as:

     | ?- main::a(X).

     X = 1 ;
     X = 2 ;
     X = 3 ;
     X = 4
     yes

Note that the order of multifile predicate clauses depends on several
factors, including loading order and compiler implementation details.
Therefore, your code should never assume or rely on a specific order of
the multifile predicate clauses.

When a clause of a multifile predicate is a rule, its body is compiled
within the context of the object or category defining the clause.  This
allows clauses for multifile predicates to call local object or category
predicates.  But the values of the 'sender', 'this', and 'self' in the
implicit execution context are passed from the clause head to the clause
body.  This is necessary to ensure that these values are always valid
and to allow multifile predicate clauses to be defined in categories.  A
call to the ‘parameter/2’ execution context methods, however, retrieves
parameters of the entity defining the clause, not from the entity for
which the clause is defined.  The parameters of the entity for which the
clause is defined can be accessed by simple unification at the clause
head.

Multifile predicate rules should not contain cuts, as these may prevent
other clauses for the predicate from being used by callers.  The
compiler prints by default a warning when a cut is found in a multifile
predicate definition.

Local calls to the database methods from multifile predicate clauses
defined in an object take place in the object’s own database instead of
the database of the entity holding the multifile predicate primary
declaration.  Similarly, local calls to the ‘expand_term/2’ and
‘expand_goal/2’ methods from a multifile predicate clause look for
clauses of the ‘term_expansion/2’ and ‘goal_expansion/2’ hook predicates
starting from the entity defining the clause instead of the entity
holding the multifile predicate primary declaration.  Local calls to the
‘current_predicate/1’, ‘predicate_property/2’, and ‘current_op/3’
methods from multifile predicate clauses defined in an object also
lookup predicates and their properties in the object’s own database
instead of the database of the entity holding the multifile predicate
primary declaration.


File: TheLogtalkHandbook-3.100.1.info,  Node: Coinductive directive,  Next: Synchronized directive,  Prev: Multifile directive,  Up: Declaring predicates

1.8.2.11 Coinductive directive
..............................

A predicate can be declared *note coinductive: 170. by using the *note
coinductive/1: 171. directive.  For example:

     :- coinductive(comember/2).

Logtalk support for coinductive predicates is experimental and requires
a *note backend Prolog compiler: 34. with minimal support for cyclic
terms.  The value of the read-only *note coinduction flag: 172. is set
to ‘supported’ for the backend Prolog compilers providing that support.


File: TheLogtalkHandbook-3.100.1.info,  Node: Synchronized directive,  Prev: Coinductive directive,  Up: Declaring predicates

1.8.2.12 Synchronized directive
...............................

A predicate can be declared *note synchronized: 175. by using the *note
synchronized/1: 74. directive.  For example:

     :- synchronized(write_log_entry/2).
     :- synchronized([produce/1, consume/1]).

See the section on *note synchronized predicates: 176. for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining predicates,  Next: Definite clause grammar rules,  Prev: Declaring predicates,  Up: Predicates

1.8.3 Defining predicates
-------------------------

* Menu:

* Object predicates::
* Category predicates::
* Meta-predicates::
* Lambda expressions::
* Redefining built-in predicates::


File: TheLogtalkHandbook-3.100.1.info,  Node: Object predicates,  Next: Category predicates,  Up: Defining predicates

1.8.3.1 Object predicates
.........................

We define object predicates as we have always defined Prolog predicates,
the only difference being that we have four more control structures (the
three message-sending operators plus the external call operator) to play
with.  For example, if we wish to define an object containing common
utility list predicates like ‘append/2’ or ‘member/2’ we could write
something like:

     :- object(list).

         :- public(append/3).
         append([], L, L).
         append([H| T], L, [H| T2]) :-
             append(T, L, T2).

         :- public(member/2).
         member(H, [H| _]).
         member(H, [_| T]) :-
             member(H, T).

     :- end_object.

Note that, abstracting from the opening and closing object directives
and the scope directives, what we have written is also valid Prolog
code.  Calls in a predicate definition body default to the local
predicates unless we use the message-sending operators or the external
call operator.  This simplifies conversion from plain Prolog code to
Logtalk objects: often we just need to add the necessary encapsulation
and scope directives to the old code.


File: TheLogtalkHandbook-3.100.1.info,  Node: Category predicates,  Next: Meta-predicates,  Prev: Object predicates,  Up: Defining predicates

1.8.3.2 Category predicates
...........................

A category can only contain clauses for static predicates.  But there
are no restrictions in declaring and calling dynamic predicates from
inside a category.  Because a category can be imported by multiple
objects, dynamic predicates must be called either in the context of
*note self: 69, using the *note message to self: 17d. control structure,
*note (;;)/1: 5c, or in the context of *note this: 114. (i.e., in the
context of the object importing the category).  For example, if we want
to define a category implementing attributes using the dynamic database
of 'self' we could write:

     :- category(attributes).

         :- public(get/2).
         :- public(set/2).

         :- private(attribute_/2).
         :- dynamic(attribute_/2).

         get(Var, Value) :-
             ::attribute_(Var, Value).

         set(Var, Value) :-
             ::retractall(attribute_(Var, _)),
             ::asserta(attribute_(Var, Value).

     :- end_category.

In this case, the ‘get/2’ and ‘set/2’ predicates will always
access/update the correct definition, contained in the object receiving
the messages.

In alternative, if we want a category implementing attributes using the
dynamic database of 'this', we would write instead:

     :- category(attributes).

         :- public(get/2).
         :- public(set/2).

         :- private(attribute_/2).
         :- dynamic(attribute_/2).

         get(Var, Value) :-
             attribute_(Var, Value).

         set(Var, Value) :-
             retractall(attribute_(Var, _)),
             asserta(attribute_(Var, Value).

     :- end_category.

In this case, each object importing the category will have its own
clauses for the ‘attribute_/2’ private dynamic predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicates,  Next: Lambda expressions,  Prev: Category predicates,  Up: Defining predicates

1.8.3.3 Meta-predicates
.......................

Meta-predicates may be defined inside objects and categories as any
other predicate.  A meta-predicate is declared using the *note
meta_predicate/1: 152. directive as described earlier in this section.
When defining a meta-predicate, the arguments in the clause heads
corresponding to the meta-arguments must be variables.  All
meta-arguments are called in the context of the object or category
calling the meta-predicate.  In particular, when sending a message that
corresponds to a meta-predicate, the meta-arguments are called in the
context of the object or category sending the message.

The most simple example is a meta-predicate with a meta-argument that is
called as a goal.  E.g.  the *note ignore/1: 180. built-in predicate
could be defined as:

     :- public(ignore/1).
     :- meta_predicate(ignore(0)).

     ignore(Goal) :-
        (Goal -> true; true).

The ‘0’ in the meta-predicate template tells us that the meta-argument
is a goal that will be called by the meta-predicate.

Some meta-predicates have meta-arguments that are not goals but *note
closures: 14f.  Logtalk supports the definition of meta-predicates that
are called with closures instead of goals as long as the definition uses
the *note call/1-N: 181. built-in predicate to call the closure with the
additional arguments.  A classical example is a list mapping predicate:

     :- public(map/2).
     :- meta_predicate(map(1, *)).

     map(_, []).
     map(Closure, [Arg| Args]) :-
         call(Closure, Arg),
         map(Closure, Args).

Note that in this case the meta-predicate directive specifies that the
closure will be extended with exactly one additional argument.  When
calling a meta-predicate, a closure can correspond to a user-defined
predicate, a built-in predicate, a *note lambda expression: 182, or a
control construct.

In some cases, it is not a meta-argument but one of its sub-terms that
is called as a goal or used as a closure.  For example:

     :- public(call_all/1).
     :- meta_predicate(call_all(::)).

     call_all([]).
     call_all([Goal| Goals]) :-
         call(Goal),
         call_all(Goals).

The ‘::’ mode indicator in the meta-predicate template allows the
corresponding argument in the meta-predicate definition to be a
non-variable term and instructs the compiler to look into the argument
sub-terms for goal and closure *note meta-variables: 183.

When a meta-predicate calls another meta-predicate, both predicates
require ‘meta_predicate/1’ directives.  For example, the ‘map/2’
meta-predicate defined above is usually implemented by exchanging the
argument order to take advantage of first-argument indexing:

     :- meta_predicate(map(1, *)).
     map(Closure, List) :-
         map_(List, Closure).

     :- meta_predicate(map_(*, 1)).
     map_([], _).
     map_([Head| Tail], Closure) :-
         call(Closure, Head),
         map_(Tail, Closure).

Note that Logtalk, unlike most Prolog module systems, is not based on a
predicate prefixing mechanism.  Thus, the meta-argument calling context
is not part of the meta-argument itself.


File: TheLogtalkHandbook-3.100.1.info,  Node: Lambda expressions,  Next: Redefining built-in predicates,  Prev: Meta-predicates,  Up: Defining predicates

1.8.3.4 Lambda expressions
..........................

The use of lambda expressions(1) as meta-predicate goal and *note
closure: 14f. arguments often saves writing auxiliary predicates for the
sole purpose of calling the meta-predicates.  A simple example of a
lambda expression is:

     | ?- meta::map([X,Y]>>(Y is 2*X), [1,2,3], Ys).
     Ys = [2,4,6]
     yes

In this example, a lambda expression, ‘[X,Y]>>(Y is 2*X)’, is used as an
argument to the ‘map/3’ list mapping predicate, defined in the library
object ‘meta’, in order to double the elements of a list of integers.
Using a lambda expression avoids writing an auxiliary predicate for the
sole purpose of doubling the list elements.  The 'lambda parameters' are
represented by the list ‘[X,Y]’, which is connected to the 'lambda
goal', ‘(Y is 2*X)’, by the ‘(>>)/2’ operator.  The ‘map/3’ predicate
calls the lambda goal with fresh/unique variables, represented by the
‘X’ and ‘Y’ parameters, for each pair of elements of the second and
third list arguments.

Currying is supported.  I.e.  it is possible to write a lambda
expression whose goal is another lambda expression.  The above example
can be rewritten as:

     | ?- meta::map([X]>>([Y]>>(Y is 2*X)), [1,2,3], Ys).
     Ys = [2,4,6]
     yes

Lambda expressions may also contain 'lambda-free variables'.  I.e.
variables that are global to the lambda expression and shared with the
surrounding meta-call context.  Consider the following variant of the
previous example:

     | ?- between(1, 3, N), meta::map({N}/[X,Y]>>(Y is N*X), [1,2,3], L).
     N = 1, L = [1,2,3] ;
     N = 2, L = [2,4,6] ;
     N = 3, L = [3,6,9]
     yes

In this case, the lambda-free variable, ‘N’, bound by the ‘between/3’
goal, is fixed across all implicit calls made by the ‘map/3’ goal.

A second example of free variables in a lambda expression using GNU
Prolog as the backend compiler:

     | ?- meta::map({Z}/[X,Y]>>(Z#=X+Y), [1,2,3], Zs).
     Z = _#22(3..268435455)
     Zs = [_#3(2..268435454),_#66(1..268435453),_#110(0..268435452)]
     yes

The ISO Prolog construct ‘{}/1’ is used for representing the lambda-free
variables as this representation is often associated with set
representation.  Note that the order of the free variables is of no
consequence (on the other hand, a list is used for the lambda parameters
as their order does matter).

Both lambda free variables and lambda parameters can be any Prolog term.
Consider the following example by Markus Triska:

     | ?- meta::map([A-B,B-A]>>true, [1-a,2-b,3-c], Zs).
     Zs = [a-1,b-2,c-3]
     yes

Lambda expressions can be used, as expected, in non-deterministic
queries, as in the following example using SWI-Prolog as the backend
compiler and Markus Triska’s CLP(FD) library:

     | ?- meta::map({Z}/[X,Y]>>(clpfd:(Z#=X+Y)), Xs, Ys).
     Xs = [],
     Ys = [] ;
     Xs = [_G1369],
     Ys = [_G1378],
     _G1369+_G1378#=Z ;
     Xs = [_G1579, _G1582],
     Ys = [_G1591, _G1594],
     _G1582+_G1594#=Z,
     _G1579+_G1591#=Z ;
     Xs = [_G1789, _G1792, _G1795],
     Ys = [_G1804, _G1807, _G1810],
     _G1795+_G1810#=Z,
     _G1792+_G1807#=Z,
     _G1789+_G1804#=Z ;
     ...

As illustrated by the above examples, lambda expression syntax reuses
the ISO Prolog construct ‘{}/1’ and the standard operators ‘(/)/2’ and
‘(>>)/2’, thus avoiding defining new operators, which is always tricky
for a portable system such as Logtalk.  The operator ‘(>>)/2’ was chosen
as it suggests an arrow, similar to the syntax used in other languages
such as OCaml and Haskell to connect lambda parameters with lambda
functions.  This syntax was also chosen in order to simplify parsing,
error checking, and compilation of lambda expressions.  The full
specification of the lambda expression syntax can be found in the *note
language grammar: 185.

The compiler checks whenever possible that all variables in a lambda
expression are either classified as free variables or as lambda
parameters.  Non-classified variables in a lambda goal (including any
anonymous variables) should be regarded as a programming error.  The
compiler also checks whenever possible if a variable is classified as
both a free variable and a lambda parameter.  There are a few cases
where a variable playing a dual role is intended, but, in general, this
also results from a programming error.  A third check verifies that no
lambda parameter variable is used elsewhere in a clause.  Such cases are
either programming errors, when the variable appears before the lambda
expression, or bad programming style, when the variable is used after
the lambda expression.  These linter warnings are controlled by the
*note lambda_variables: 186. flag.  Note that the dynamic features of
the language and lack of sufficient information at compile-time may
prevent the compiler from checking all uses of lambda expressions.  To
improve linter coverage, compile code using lambda expressions with the
*note optimize flag: 8c. turned on, as that will result in additional
cases of meta-arguments being evaluated for possible optimizations.

     Warning: Variables listed in lambda parameters must not be shared
     with other goals in a clause.

An optimizing meta-predicate and lambda expression compiler, based on
the *note term-expansion mechanism: cb, is provided as a standard
library for practical performance.

A common use of lambda expressions as closure meta-arguments is to
workaround closures always being extended by 'appending' additional
arguments to construct a goal.  For example, assume that we want to
filter a list of atoms by a given length.  We can use the standard
‘atom_length/2’ predicate despite the argument order by writing:

     filter(Length, Atoms, Filtered) :-
         meta::include({Length}/[Atom]>>atom_length(Atom,Length), Atoms, Filtered).

But Logtalk supports a faster alternative by using predicate aliases to
change the argument order when calling library or built-in predicates:

     :- uses(user, [
        atom_length(Atom, Length) as length_atom(Length, Atom)
     ]).

     filter(Length, Atoms, Filtered) :-
         meta::include(length_atom(Length), Atoms, Filtered).

In this case, the performance is no longer dependent on compiling away
lambda expressions.  The resulting code is also easier to read (and thus
debug and maintain).  But the ‘uses/2’ directive is implicitly defining
an auxiliary predicate, which is exactly what we wanted to avoid in the
first place by using a lambda expression.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Lambda_calculus


File: TheLogtalkHandbook-3.100.1.info,  Node: Redefining built-in predicates,  Prev: Lambda expressions,  Up: Defining predicates

1.8.3.5 Redefining built-in predicates
......................................

Logtalk built-in predicates and Prolog built-in predicates can be
redefined inside objects and categories.  Although the redefinition of
Logtalk built-in predicates should be avoided, the support for
redefining Prolog built-in predicates is a practical requirement given
the different sets of proprietary built-in predicates provided by
backend Prolog systems.

The compiler supports a *note redefined_built_ins: 189. flag, whose
default value is ‘silent’, that can be set to ‘warning’ to alert the
user of any redefined Logtalk or Prolog built-in predicate.

The redefinition of Prolog built-in predicates can be combined with the
*note conditional compilation directives: 18a. when writing portable
applications where some of the supported backends don’t provide a
built-in predicate found in the other backends.  As an example, consider
the de facto standard ‘msort/2’ predicate (which sorts a list while
keeping duplicates).  This predicate is provided as a built-in predicate
in most but not all backends.  The ‘list’ library object includes the
code:

     :- if(predicate_property(msort(_, _), built_in)).

         msort(List, Sorted) :-
             {msort(List, Sorted)}.

     :- else.

         length(List, Length) :-
             ...

     :- endif.

I.e.  the object will use the built-in predicate when available.
Otherwise, it will use the predicate definition provided by the ‘list’
object.

The redefinition of built-in predicates can also be accomplished using
*note predicate shorthands: 161.  This can be useful when porting code
while minimizing the changes.  For example, assume that existing code
uses the ‘format/2’ de facto standard predicate for writing messages.
To convert the code to use the *note message printing mechanism: 18b, we
could write:

     :- uses(logtalk, [
         print_message(comment, core, Format+Arguments) as format(Format, Arguments)
     ]).

     process(Crate, Contents) :-
         format('Processing crate ~w...', [Crate]),
         ...,
         format('Filing with ~w...', [Contents]),
         ....

The predicate shorthand instructs the compiler to rewrite all ‘format/2’
goals as ‘logtalk::print_message/3’ goals, thus allowing us to reuse the
code without changes.


File: TheLogtalkHandbook-3.100.1.info,  Node: Definite clause grammar rules,  Next: Built-in methods,  Prev: Defining predicates,  Up: Predicates

1.8.4 Definite clause grammar rules
-----------------------------------

Definite clause grammar rules (DCGs) provide a convenient notation to
represent the parsing and rewrite rules common of most grammars in
Prolog.  In Logtalk, definite clause grammar rules can be encapsulated
in objects and categories.  Currently, the ISO/IEC WG17 group is working
on a draft specification for a definite clause grammars Prolog standard.
Therefore, in the meantime, Logtalk follows the common practice of
Prolog compilers supporting definite clause grammars, extending it to
support calling grammar rules contained in categories and objects.  A
common example of a definite clause grammar is the definition of a set
of rules for parsing simple arithmetic expressions:

     :- object(calculator).

         :- public(parse/2).

         parse(Expression, Value) :-
             phrase(expr(Value), Expression).

         expr(Z) --> term(X), "+", expr(Y), {Z is X + Y}.
         expr(Z) --> term(X), "-", expr(Y), {Z is X - Y}.
         expr(X) --> term(X).

         term(Z) --> number(X), "*", term(Y), {Z is X * Y}.
         term(Z) --> number(X), "/", term(Y), {Z is X / Y}.
         term(Z) --> number(Z).

         number(C) --> "+", number(C).
         number(C) --> "-", number(X), {C is -X}.
         number(X) --> [C], {0'0 =< C, C =< 0'9, X is C - 0'0}.

     :- end_object.

After compiling and loading this object, we can test the grammar rules
using the ‘parse/2’ message:

     | ?- calculator::parse("1+2-3*4", Result).

     Result = -9
     yes

The non-terminals can be called from predicates using the private
built-in methods *note phrase/2: 18e. and *note phrase/3: 18f. as shown
in the example above.  When we want to use the built-in methods
‘phrase/2’ and ‘phrase/3’, the non-terminal used as in the first
argument must be within the scope of the 'sender'.  For the above
example, assuming that we want the predicate corresponding to the
‘expr//1’ non-terminal to be public, the corresponding scope directive
would be:

     :- public(expr//1).

The ‘//’ infix operator used above tells the Logtalk compiler that the
scope directive refers to a grammar rule non-terminal, not to a
predicate.  The idea is that the predicate corresponding to the
translation of the ‘expr//1’ non-terminal will have a number of
arguments equal to one plus the number of additional arguments necessary
for processing the implicit difference list of tokens.

In the body of a grammar rule, we can call rules that are inherited from
ancestor objects, imported from categories, or contained in other
objects.  This is accomplished by using non-terminals as messages.
Using a non-terminal as a message to 'self' allows us to call grammar
rules in categories and ancestor objects.  To call grammar rules
encapsulated in other objects, we use a non-terminal as a message to
those objects.  Consider the following example, containing grammar rules
for parsing natural language sentences:

     :- object(sentence,
         imports(determiners, nouns, verbs)).

         :- public(parse/2).

         parse(List, true) :-
             phrase(sentence, List).
         parse(_, false).

         sentence --> noun_phrase, verb_phrase.

         noun_phrase --> ::determiner, ::noun.
         noun_phrase --> ::noun.

         verb_phrase --> ::verb.
         verb_phrase --> ::verb, noun_phrase.

     :- end_object.

The categories imported by the object would contain the necessary
grammar rules for parsing determiners, nouns, and verbs.  For example:

     :- category(determiners).

         :- private(determiner//0).

         determiner --> [the].
         determiner --> [a].

     :- end_category.

Along with the message-sending operators (‘(::)/1’, ‘(::)/2’, and
‘(^^)/1’), we may also use other control constructs such as ‘(<<)/2’,
‘(\+)/1’, ‘!/0’, ‘(;)/2’, ‘(->)/2’, ‘{}/1’, ‘call//1-N’, and ‘catch/3’
in the body of a grammar rule.  When using a backend Prolog compiler
that supports modules, we may also use the ‘(:)/2’ control construct.

     Warning: The semantics of ‘(\+)/1’ and ‘(->)/2’ control constructs
     in grammar rules with a terminal or a non-terminal in the 'first'
     argument are problematic due to unrestricted lookahead that may or
     may not be valid depending on the grammar rule implicit arguments.
     By default, the linter will print warnings for such calls
     (controlled by the *note grammar_rules: 190. flag).  Preferably
     restrict the use of the ‘(\+)/1’ control construct to ‘{}/1’
     arguments and the use of the ‘(->)/2’ control construct to ‘{}/1’
     test arguments.

In addition, grammar rules may contain meta-calls (a variable taking the
place of a non-terminal), which are translated to calls of the built-in
method ‘phrase//1’.  The *note meta_non_terminal/1: 153. directive
allows the declaration of non-terminals that have arguments that are
meta-called from grammar rules.  For example:

     :- meta_non_terminal(zero_or_more(1, *)).

     zero_or_more(Closure, [Terminal| Terminals]) -->
         call(Closure, Terminal), !, zero_or_more(Closure, Terminals).
     zero_or_more(_, []) -->
         [].

You may have noticed that Logtalk defines *note {}/1: 191. as a control
construct for bypassing the compiler when compiling a clause body goal.
As exemplified above, this is the same control construct that is used in
grammar rules for bypassing the expansion of rule body goals when a rule
is converted into a clause.  Both control constructs can be combined in
order to call a goal from a grammar rule body, while bypassing at the
same time the Logtalk compiler.  Consider the following example:

     bar :-
         write('bar predicate called'), nl.


     :- object(bypass).

         :- public(foo//0).

         foo --> {{bar}}.

     :- end_object.

After compiling and loading this code, we may try the following query:

     | ?- logtalk << phrase(bypass::foo, _, _).

     bar predicate called
     yes

This is the expected result, as the expansion of the grammar rule into a
clause leaves the ‘{bar}’ goal untouched, which, in turn, is converted
into the goal ‘bar’ when the clause is compiled.  Note that we tested
the ‘bypass::foo//0’ non-terminal by calling the ‘phrase/3’ built-in
method in the context of the ‘logtalk’ built-in object.  This workaround
is necessary due to the Prolog backend implementation of the ‘phrase/3’
predicate not being aware of the Logtalk ‘(::)/2’ message-sending
control construct semantics.

A grammar rule non-terminal may be declared as dynamic or discontiguous,
as any object predicate, using the same ‘Name//Arity’ notation
illustrated above for the scope directives.  In addition, grammar rule
non-terminals can be documented using the *note info/2: 168. directive,
as in the following example:

     :- public(sentence//0).

     :- info(sentence//0, [
         comment is 'Rewrites sentence into noun and verb phrases.'
     ]).

     Note: Future Logtalk versions may compile grammar rules differently
     from Prolog traditional compilation to prevent name clashes between
     non-terminals and predicates.  Therefore, you should always call
     non-terminals from predicates using the ‘phrase/2-3’ built-in
     methods and always call predicates from grammar rules using the
     ‘call//1’ built-in method.  This recommended practice, besides
     making your code forward compatible with future Logtalk versions,
     also makes the code more clear.  The linter prints warnings when
     these guidelines are not followed (notably, when a predicate is
     called as a non-terminal or a non-terminal is called as a
     predicate).


File: TheLogtalkHandbook-3.100.1.info,  Node: Built-in methods,  Next: Predicate properties,  Prev: Definite clause grammar rules,  Up: Predicates

1.8.5 Built-in methods
----------------------

Built-in methods are built-in object and category predicates.  These
include methods to access message execution context, to find sets of
solutions, to inspect objects, for database handling, for term and goal
expansion, and for printing messages.  Some of them are counterparts to
standard Prolog built-in predicates that take into account Logtalk
semantics.  Similar to Prolog built-in predicates, built-in methods
cannot be redefined.

* Menu:

* Logic and control methods::
* Execution context methods::
* Error handling and throwing methods::
* Database methods::
* Meta-call methods::
* All solutions methods::
* Reflection methods::
* Definite clause grammar parsing methods and non-terminals::


File: TheLogtalkHandbook-3.100.1.info,  Node: Logic and control methods,  Next: Execution context methods,  Up: Built-in methods

1.8.5.1 Logic and control methods
.................................

The *note !/0: 196, *note true/0: 197, *note fail/0: 198, *note false/0:
199, and *note repeat/0: 19a. standard control constructs and logic
predicates are interpreted as built-in public methods and thus can be
used as messages to any object.  In practice, they are only used as
messages when sending multiple messages to the same object (see the
section on *note message broadcasting: 84.).


File: TheLogtalkHandbook-3.100.1.info,  Node: Execution context methods,  Next: Error handling and throwing methods,  Prev: Logic and control methods,  Up: Built-in methods

1.8.5.2 Execution context methods
.................................

Logtalk defines five built-in private methods to access an object
execution context.  These methods are in the common usage scenarios
translated to a single unification performed at compile-time with a
clause head context argument.  Therefore, they can be freely used
without worrying about performance penalties.  When called from inside a
category, these methods refer to the execution context of the object
importing the category.  These methods are private and cannot be used as
messages to objects.

To find the object that received the message under execution, we may use
the *note self/1: 67. method.  We may also retrieve the object that has
sent the message under execution using the *note sender/1: 19d. method.

The method *note this/1: 68. enables us to retrieve the name of the
object for which the predicate clause whose body is being executed is
defined instead of using the name directly.  This helps to avoid
breaking the code if we decide to change the object name and forget to
change the name references.  This method may also be used from within a
category.  In this case, the method returns the object importing the
category on whose behalf the predicate clause is being executed.

Here is a short example including calls to these three object execution
context methods:

     :- object(test).

         :- public(test/0).

         test :-
             this(This),
             write('Calling predicate definition in '),
             writeq(This), nl,
             self(Self),
             write('to answer a message received by '),
             writeq(Self), nl,
             sender(Sender),
             write('that was sent by '),
             writeq(Sender), nl, nl.

     :- end_object.


     :- object(descendant,
         extends(test)).

     :- end_object.

After compiling and loading these two objects, we can try the following
goal:

     | ?- descendant::test.

     Calling predicate definition in test
     to answer a message received by descendant
     that was sent by user
     yes

Note that the goals ‘self(Self)’, ‘sender(Sender)’, and ‘this(This)’,
being translated to unifications with the clause head context arguments
at compile-time, are effectively removed from the clause body.
Therefore, a clause such as:

     predicate(Arg) :-
         self(Self),
         atom(Arg),
         ... .

is compiled with the goal ‘atom(Arg)’ as the first condition on the
clause body.  As such, the use of these context execution methods does
not interfere with the optimizations that some Prolog compilers perform
when the first clause body condition is a call to a built-in type-test
predicate or a comparison operator.

For parametric objects and categories, the method *note parameter/2: a2.
enables us to retrieve current parameter values (see the section on
*note parametric objects: 66. for a detailed description).  For example:

     :- object(block(_Color)).

         :- public(test/0).

         test :-
             parameter(1, Color),
             write('Color parameter value is '),
             writeq(Color), nl.

     :- end_object.

An alternative to the ‘parameter/2’ predicate is to use *note parameter
variables: a1.:

     :- object(block(_Color_)).

         :- public(test/0).

         test :-
             write('Color parameter value is '),
             writeq(_Color_), nl.

     :- end_object.

After compiling and loading either version of the object, we can try the
following goal:

     | ?- block(blue)::test.

     Color parameter value is blue
     yes

Calls to the ‘parameter/2’ method are translated to a compile-time
unification when the second argument is a variable.  When the second
argument is bound, the calls are translated to a call to the built-in
predicate ‘arg/3’.

When type-checking predicate arguments, it is often useful to include
the predicate execution context when reporting an argument error.  The
*note context/1: 19e. method provides access to that context.  For
example, assume a predicate ‘foo/2’ that takes an atom and an integer as
arguments.  We could type-check the arguments by writing (using the
library ‘type’ object):

     foo(A, N) :-
         % type-check arguments
         context(Context),
         type::check(atom, A, Context),
         type::check(integer, N, Context),
         % arguments are fine; go ahead
         ... .


File: TheLogtalkHandbook-3.100.1.info,  Node: Error handling and throwing methods,  Next: Database methods,  Prev: Execution context methods,  Up: Built-in methods

1.8.5.3 Error handling and throwing methods
...........................................

Besides the *note catch/3: 1a1. and *note throw/1: 1a2. methods
inherited from Prolog, Logtalk also provides a set of convenience
methods to throw standard ‘error/2’ exception terms: *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note existence_error/2:
1a7, *note permission_error/3: 1a8, *note representation_error/1: 1a9,
*note evaluation_error/1: 1aa, *note resource_error/1: 1ab, *note
syntax_error/1: 1ac, and *note system_error/0: 1ad.  When using these
methods, the second argument of the ‘error/2’ exception term is bound to
the execution context (as it would be provided by the *note context/1:
19e. method).


File: TheLogtalkHandbook-3.100.1.info,  Node: Database methods,  Next: Meta-call methods,  Prev: Error handling and throwing methods,  Up: Built-in methods

1.8.5.4 Database methods
........................

Logtalk provides a set of built-in methods for *note object database:
1b0. handling similar to the usual database Prolog predicates: *note
abolish/1: 1b1, *note asserta/1: 1b2, *note assertz/1: 1b3, *note
clause/2: 1b4, *note retract/1: 1b5, and *note retractall/1: 1b6.  These
methods always operate on the database of the object receiving the
corresponding message.  When called locally, these predicates take into
account any *note uses/2: 4b. or *note use_module/2: 4d. directives that
refer to the dynamic predicate being handled.  For example, in the
following object, the clauses for the ‘data/1’ predicate are retracted
and asserted in ‘user’ due to the ‘uses/2’ directive:

     :- object(an_object).

         :- uses(user, [data/1]).

         :- public(some_predicate/1).
         some_predicate(Arg) :-
             retractall(data(_)),
             assertz(data(Arg)).

     :- end_object.

When working with dynamic grammar rule non-terminals, you may use the
built-in method *note expand_term/2: 1b7. convert a grammar rule into a
clause that can then be used with the database methods.

Logtalk also supports ‘asserta/2’, ‘assertz/2’, ‘clause/3’, and
‘erase/1’ built-in methods when run with a backend that supports the
corresponding legacy built-in predicates that work with *note clause
references: 1b8.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-call methods,  Next: All solutions methods,  Prev: Database methods,  Up: Built-in methods

1.8.5.5 Meta-call methods
.........................

Logtalk supports the generalized *note call/1-N: 181. meta-predicate.
This built-in private meta-predicate must be used in the implementation
of meta-predicates that work with *note closures: 14f. instead of goals.
In addition, Logtalk supports the built-in private meta-predicates *note
ignore/1: 180, *note once/1: 1bb, and *note (\+)/1: 1bc.  These methods
cannot be used as messages to objects.


File: TheLogtalkHandbook-3.100.1.info,  Node: All solutions methods,  Next: Reflection methods,  Prev: Meta-call methods,  Up: Built-in methods

1.8.5.6 All solutions methods
.............................

The usual all solutions meta-predicates are built-in private methods in
Logtalk: *note bagof/3: 1bf, *note findall/3: 1c0, *note findall/4: 1c1,
and *note setof/3: 1c2.  There is also a *note forall/2: 1c3. method
that implements generate-and-test loops.  These methods cannot be used
as messages to objects.


File: TheLogtalkHandbook-3.100.1.info,  Node: Reflection methods,  Next: Definite clause grammar parsing methods and non-terminals,  Prev: All solutions methods,  Up: Built-in methods

1.8.5.7 Reflection methods
..........................

Logtalk provides a comprehensive set of built-in predicates and built-in
methods for querying about entities and predicates.  Some of the
information, however, requires that the source files are compiled with
the *note source_data: cc. flag turned on.

The *note reflection API: 48. supports two different views on entities
and their contents, which we may call the 'transparent box view' and the
'black box view'.  In the transparent box view, we look into an entity
disregarding how it will be used and returning all information available
on it, including predicate declarations and predicate definitions.  This
view is supported by the entity property built-in predicates.  In the
black box view, we look into an entity from a usage point of view using
built-in methods for inspecting object operators and predicates that are
within scope from where we are making the call: *note current_op/3: 15e,
which returns operator specifications; *note predicate_property/2: 142,
which returns predicate properties; and *note current_predicate/1: 141,
which enables us to query about user-defined predicate definitions.  See
below for a more detailed description of these methods.


File: TheLogtalkHandbook-3.100.1.info,  Node: Definite clause grammar parsing methods and non-terminals,  Prev: Reflection methods,  Up: Built-in methods

1.8.5.8 Definite clause grammar parsing methods and non-terminals
.................................................................

Logtalk supports two definite clause grammar parsing built-in private
methods, *note phrase/2: 18e. and *note phrase/3: 18f, with definitions
similar to the predicates with the same name found on most Prolog
compilers that support definite clause grammars.  These methods cannot
be used as messages to objects.

Logtalk also supports *note phrase//1: 1c8, *note call//1-N: 1c9, and
*note eos//0: 1ca. built-in non-terminals.  The ‘call//1-N’
non-terminals take a *note closure: 14f. (which can be a lambda
expression) plus zero or more additional arguments and are processed by
appending the input list of tokens and the list of remaining tokens to
the arguments.


File: TheLogtalkHandbook-3.100.1.info,  Node: Predicate properties,  Next: Finding declared predicates,  Prev: Built-in methods,  Up: Predicates

1.8.6 Predicate properties
--------------------------

We can find the properties of visible predicates by calling the *note
predicate_property/2: 142. built-in method.  For example:

     | ?- bar::predicate_property(foo(_), Property).

Note that this method takes into account the predicate’s scope
declarations.  In the above example, the call will only return
properties for public predicates.

An object’s set of visible predicates is the union of all the predicates
declared for the object with all the built-in methods and all the
Logtalk and Prolog built-in predicates.

The following predicate properties are supported:

‘scope(Scope)’

     The predicate scope (useful for finding the predicate scope with a
     single call to ‘predicate_property/2’)

‘public’, ‘protected’, ‘private’

     The predicate scope (useful for testing if a predicate has a
     specific scope)

‘static’, ‘dynamic’

     All predicates are either static or dynamic (note, however, that a
     dynamic predicate can only be abolished if it was dynamically
     declared)

‘logtalk’, ‘prolog’, ‘foreign’

     A predicate can be defined in Logtalk source code, Prolog code, or
     in foreign code (e.g., in C)

‘built_in’

     The predicate is a built-in predicate

‘multifile’

     The predicate is declared multifile (i.e., it can have clauses
     defined in multiple files or entities)

‘meta_predicate(Template)’

     The predicate is declared as a meta-predicate with the specified
     template

‘coinductive(Template)’

     The predicate is declared as a coinductive predicate with the
     specified template

‘declared_in(Entity)’

     The predicate is declared (using a scope directive) in the
     specified entity

‘defined_in(Entity)’

     The predicate definition is looked up in the specified entity (note
     that this property does not necessarily imply that clauses for the
     predicate exist in ‘Entity’; the predicate can simply be false as
     per the *note closed-world assumption: 6a.)

‘redefined_from(Entity)’

     The predicate is a redefinition of a predicate definition inherited
     from the specified entity

‘non_terminal(NonTerminal//Arity)’

     The predicate resulted from the compilation of the specified
     grammar rule non-terminal

‘alias_of(Predicate)’

     The predicate (name) is an alias for the specified predicate

‘alias_declared_in(Entity)’

     The predicate alias is declared in the specified entity

‘synchronized’

     The predicate is declared as synchronized (i.e., it’s a
     deterministic predicate synchronized using a mutex when using a
     backend Prolog compiler supporting a compatible multi-threading
     implementation)

Some properties are only available when the entities are defined in
source files and when those source files are compiled with the *note
source_data: cc. flag turned on:

‘recursive’

     The predicate definition includes at least one recursive rule

‘inline’

     The predicate definition is inlined

‘auxiliary’

     The predicate is not user-defined but rather automatically
     generated by the compiler or the *note term-expansion mechanism:
     cb.

‘mode(Mode, Solutions)’

     Instantiation, type, and determinism mode for the predicate (which
     can have multiple modes)

‘info(ListOfPairs)’

     Documentation key-value pairs as specified in the user-defined
     ‘info/2’ directive

‘number_of_clauses(N)’

     The number of clauses for the predicate existing at compilation
     time (note that this property is not updated at runtime when
     asserting and retracting clauses for dynamic predicates)

‘number_of_rules(N)’

     The number of rules for the predicate existing at compilation time
     (note that this property is not updated at runtime when asserting
     and retracting clauses for dynamic predicates)

‘declared_in(Entity, Line)’

     The predicate is declared (using a scope directive) in the
     specified entity in a source file at the specified line (if
     applicable)

‘defined_in(Entity, Line)’

     The predicate is defined in the specified entity in a source file
     at the specified line (if applicable)

‘redefined_from(Entity, Line)’

     The predicate is a redefinition of a predicate definition inherited
     from the specified entity, which is defined in a source file at the
     specified line (if applicable)

‘alias_declared_in(Entity, Line)’

     The *note predicate alias: ca. is declared in the specified entity
     in a source file at the specified line (if applicable)

The properties ‘declared_in/1-2’, ‘defined_in/1-2’, and
‘redefined_from/1-2’ do not apply to built-in methods and Logtalk or
Prolog built-in predicates.  Note that if a predicate is declared in a
category imported by the object, it will be the category name — not the
object name — that will be returned by the property ‘declared_in/1’.
The same is true for protocol declared predicates.

Some properties, such as line numbers, are only available when the
entity holding the predicates is defined in a source file compiled with
the *note source_data: cc. flag turned on.  Moreover, line numbers are
only supported in *note backend Prolog compilers: 34. that provide
access to the start line of a read term.  When such support is not
available, the value ‘-1’ is returned for the start and end lines.


File: TheLogtalkHandbook-3.100.1.info,  Node: Finding declared predicates,  Next: Calling Prolog predicates,  Prev: Predicate properties,  Up: Predicates

1.8.7 Finding declared predicates
---------------------------------

We can find, by backtracking, all visible user predicates by calling the
*note current_predicate/1: 141. built-in method.  This method takes into
account predicate scope declarations.  For example, the following call
will only return user predicates that are declared public:

     | ?- some_object::current_predicate(Name/Arity).

The predicate property ‘non_terminal/1’ may be used to retrieve all
grammar rule non-terminals declared for an object.  For example:

     current_non_terminal(Object, Name//Args) :-
         Object::current_predicate(Name/Arity),
         functor(Predicate, Functor, Arity),
         Object::predicate_property(Predicate, non_terminal(Name//Args)).

Usually, the non-terminal and the corresponding predicate share the same
functor, but users should not rely on this always being true.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling Prolog predicates,  Next: Defining Prolog multifile predicates,  Prev: Finding declared predicates,  Up: Predicates

1.8.8 Calling Prolog predicates
-------------------------------

Logtalk is designed for both 'robustness' and 'portability'.  In the
context of calling Prolog predicates, robustness requires that the
compilation of Logtalk source code must not have 'accidental'
dependencies on Prolog code that happens to be loaded at the time of the
compilation.  One immediate consequence is that only Prolog 'built-in'
predicates are visible from within objects and categories.  But Prolog
systems provide a widely diverse set of built-in predicates, easily
raising portability issues.  Relying on non-standard predicates is often
unavoidable, however, due to the narrow scope of Prolog standards.
Logtalk applications may also require calling user-defined Prolog
predicates, either in ‘user’ or in Prolog modules.

* Menu:

* Calling Prolog built-in predicates::
* Calling Prolog non-standard built-in meta-predicates::
* Calling Prolog foreign predicates::
* Calling Prolog user-defined plain predicates::
* Calling Prolog module predicates::
* Calling Prolog module meta-predicates::


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling Prolog built-in predicates,  Next: Calling Prolog non-standard built-in meta-predicates,  Up: Calling Prolog predicates

1.8.8.1 Calling Prolog built-in predicates
..........................................

In predicate clauses and object ‘initialization/1’ directives, predicate
calls that are not prefixed with a message-sending, super call, or
module qualification operator (‘::’, ‘^^’, or ‘:’), are compiled to
either calls to local predicates or as calls to Logtalk/Prolog built-in
predicates.  A predicate call is compiled as a call to a local predicate
if the object (or category) contains a scope directive, a multifile
directive, a dynamic directive, or a definition for the called
predicate.  When that is not the case, the compiler checks if the call
corresponds to a Logtalk or Prolog built-in predicate.  Consider the
following example:

     foo :-
         ...,
         write(bar),
         ...

The call to the ‘write/1’ predicate will be compiled as a call to the
corresponding Prolog standard built-in predicate unless the object (or
category) containing the above definition also contains a predicate
named ‘write/1’ or a directive for the predicate.

When calling non-standard Prolog built-in predicates or using
non-standard Prolog arithmetic functions, we may run into portability
problems while trying your applications with different backend Prolog
compilers.  We can use the compiler *note portability flag: 1d1. to
generate warnings for calls to non-standard predicates and arithmetic
functions.  We can also help document those calls using the *note
uses/2: 4b. directive.  For example, a few Prolog systems provide an
‘atom_string/2’ non-standard predicate.  We can write (in the object or
category calling the predicate):

     :- uses(user, [atom_string/2])

This directive is based on the fact that built-in predicates are visible
in plain Prolog (i.e., in ‘user’).  Besides helping to document the
dependency on a non-standard built-in predicate, this directive will
also silence the compiler portability warning.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling Prolog non-standard built-in meta-predicates,  Next: Calling Prolog foreign predicates,  Prev: Calling Prolog built-in predicates,  Up: Calling Prolog predicates

1.8.8.2 Calling Prolog non-standard built-in meta-predicates
............................................................

Prolog built-in meta-predicates may only be called locally within
objects or categories, i.e.  they cannot be used as messages.  Compiling
calls to non-standard, Prolog built-in meta-predicates can be tricky,
however, as there is no standard way of checking if a built-in predicate
is also a meta-predicate and finding out which are its meta-arguments.
But Logtalk supports overriding the original meta-predicate template
when not programmatically available or usable.  For example, assume a
‘det_call/1’ Prolog built-in meta-predicate that takes a goal as
argument.  We can add to the object (or category) calling it the
directive:

     :- meta_predicate(user::det_call(0)).

Another solution is to explicitly declare non-standard built-in Prolog
meta-predicates in the corresponding adapter file using the internal
predicate ‘'$lgt_prolog_meta_predicate'/3’.  For example:

     '$lgt_prolog_meta_predicate'(det_call(_), det_call(0), predicate).

The third argument can be either the atom ‘predicate’ or the atom
‘control_construct’, a distinction that is useful when compiling in
debug mode.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling Prolog foreign predicates,  Next: Calling Prolog user-defined plain predicates,  Prev: Calling Prolog non-standard built-in meta-predicates,  Up: Calling Prolog predicates

1.8.8.3 Calling Prolog foreign predicates
.........................................

Prolog systems often support defining ‘foreign’ predicates, i.e.
predicates defined using languages other than Prolog using a ‘foreign
language interface’.  There isn’t, however, any standard for defining,
making available, and recognizing foreign predicates.  From a Logtalk
perspective, the two most common scenarios are calling a foreign
predicate (from within an object or a category) and making a set of
foreign predicates available as part of an object (or category)
protocol.  Assuming, as this is the most common case, that foreign
predicates are globally visible once made available (using a Prolog
system-specific loading or linking procedure), we can simply call them
as user-defined plain predicates, as explained in the next section.
When defining an object (or category) that makes available foreign
predicates, the advisable solution is to name the predicates after the
object (or category) and then define object (or category) predicates
that call the foreign predicates.  Most backend adapter files include
support for recognizing foreign predicates that allows the Logtalk
compiler to inline calls to the predicates (thus avoiding call
indirection overheads).


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling Prolog user-defined plain predicates,  Next: Calling Prolog module predicates,  Prev: Calling Prolog foreign predicates,  Up: Calling Prolog predicates

1.8.8.4 Calling Prolog user-defined plain predicates
....................................................

User-defined Prolog plain predicates (i.e., predicates that are not
defined in a Prolog module) can be called from within objects or
categories by sending the corresponding message to ‘user’.  For example:

     foo :-
         ...,
         user::bar,
         ...

In alternative, we can use the *note uses/2: 4b. directive and write:

     :- uses(user, [bar/0]).

     foo :-
         ...,
         bar,
         ...

Note that ‘user’ is a pseudo-object in Logtalk containing all predicate
definitions that are not encapsulated (either in a Logtalk entity or a
Prolog module).

When the Prolog predicate is not a meta-predicate, we can also use the
*note {}/1: 191. compiler bypass control construct.  For example:

     foo :-
         ...,
         {bar},
         ...

But note that in this case the *note reflection API: 48. will not record
the dependency of the ‘foo/0’ predicate on the Prolog ‘bar/0’ predicate
as we are effectively bypassing the compiler.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling Prolog module predicates,  Next: Calling Prolog module meta-predicates,  Prev: Calling Prolog user-defined plain predicates,  Up: Calling Prolog predicates

1.8.8.5 Calling Prolog module predicates
........................................

Prolog module predicates can be called from within objects or categories
by using explicit qualification.  For example:

     foo :-
         ...,
         module:bar,
         ...

You can also use the *note use_module/2: 4d. directive to call the
module predicates using implicit qualification:

     :- use_module(module, [bar/0]).

     foo :-
         ...,
         bar,
         ...

Note that the first argument of the ‘use_module/2’ directive, when used
within an object or a category, is a 'module name', not a 'file
specification' (also be aware that Prolog modules are sometimes defined
in files with names that differ from the module names).

As loading a Prolog module varies between Prolog systems, the actual
loading directive or goal is preferably done from the application *note
loader file: 4f.  An advantage of this approach is that it contributes
to a clean separation between 'loading' and 'using' a resource, with the
loader file being the central point that loads all application resources
(complex applications often use a 'hierarchy' of loader files, but the
main idea remains the same).

As an example, assume that we need to call predicates defined in a
CLP(FD) Prolog library, which can be loaded using ‘library(clpfd)’ as
the file specification.  In the loader file, we would add:

     :- use_module(library(clpfd), []).

Specifying an empty import list is often used to avoid adding the
module-exported predicates to plain Prolog.  In the objects and
categories we can then call the library predicates, using implicit or
explicit qualification, as explained.  For example:

     :- object(puzzle).

         :- public(puzzle/1).

         :- use_module(clpfd, [
             all_different/1, ins/2, label/1,
             (#=)/2, (#\=)/2,
             op(700, xfx, #=), op(700, xfx, #\=)
         ]).

         puzzle([S,E,N,D] + [M,O,R,E] = [M,O,N,E,Y]) :-
             Vars = [S,E,N,D,M,O,R,Y],
             Vars ins 0..9,
             all_different(Vars),
                       S*1000 + E*100 + N*10 + D +
                       M*1000 + O*100 + R*10 + E #=
             M*10000 + O*1000 + N*100 + E*10 + Y,
             M #\= 0, S #\= 0,
             label([M,O,N,E,Y]).

     :- end_object.

     Warning: The actual module code 'must' be loaded prior to the
     compilation of Logtalk source code that uses it.  In particular,
     programmers should not expect that the module be auto-loaded
     (including when using a backend Prolog compiler that supports an
     auto-loading mechanism).

The module identifier argument can also be a *note parameter variable:
a1. when using the directive in a parametric object or a parametric
category.  In this case, dynamic binding will necessarily be used for
all listed predicates (and non-terminals).  The parameter variable must
be instantiated at runtime when the calls are made.

Logtalk supports the declaration of *note predicate aliases: ca. and
*note predicate shorthands: 161. in ‘use_module/2’ directives used
within objects and categories.  For example, the ECLiPSe IC Constraint
Solvers define a ‘(::)/2’ variable domain operator that clashes with the
Logtalk ‘(::)/2’ message-sending operator.  We can solve the conflict by
writing:

     :- use_module(ic, [(::)/2 as ins/2]).

With this directive, calls to the ‘ins/2’ predicate alias will be
automatically compiled by Logtalk to calls to the ‘(::)/2’ predicate in
the ‘ic’ module.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling Prolog module meta-predicates,  Prev: Calling Prolog module predicates,  Up: Calling Prolog predicates

1.8.8.6 Calling Prolog module meta-predicates
.............................................

The Logtalk library provides implementations of common meta-predicates,
which can be used in place of module meta-predicates (e.g., list mapping
meta-predicates).  If that is not the case, the Logtalk compiler may
need help to understand the module meta-predicate templates.  Despite
some recent progress in standardization of the syntax of
‘meta_predicate/1’ directives and of the ‘meta_predicate/1’ property
returned by the ‘predicate_property/2’ reflection predicate, portability
is still a major problem.  Thus, Logtalk allows the original
‘meta_predicate/1’ directive to be 'overridden' with a local directive
that Logtalk can make sense of.  It also allows providing a
‘meta_predicate/1’ directive when it’s missing from the module defining
the meta-predicate.  Note that Logtalk is not based on a predicate
prefixing mechanism as found in module systems.  This fundamental
difference precludes an automated solution at the Logtalk compiler
level.

As an example, assume that you want to call from an object (or a
category) a module meta-predicate with the following meta-predicate
directive:

     :- module(foo, [bar/2]).

     :- meta_predicate(bar(*, :)).

The ‘:’ meta-argument specifier is ambiguous.  It tell us that the
second argument of the meta-predicate is module sensitive, but it does
not tell us 'how'.  Some legacy module libraries and some Prolog systems
use ‘:’ to mean ‘0’ (i.e., a meta-argument that will be meta-called).
Some others use ‘:’ for meta-arguments that are not meta-called but that
still need to be augmented with module information.  Whichever the case,
the Logtalk compiler doesn’t have enough information to unambiguously
parse the directive and correctly compile the meta-arguments in the
meta-predicate call.  Therefore, the Logtalk compiler will generate an
error stating that ‘:’ is not a valid meta-argument specifier when
trying to compile a ‘foo:bar/2’ goal.  There are two alternative
solutions for this problem.  The advised solution is to override the
meta-predicate directive by writing, inside the object (or category)
where the meta-predicate is called:

     :- meta_predicate(foo:bar(*, *)).

or:

     :- meta_predicate(foo:bar(*, 0)).

depending on the true meaning of the second meta-argument.  The second
alternative, only usable when the meta-argument can be handled as a
normal argument, is to simply use the *note {}/1: 191. compiler bypass
control construct to call the meta-predicate as-is:

     ... :- {foo:bar(..., ...)}, ...

The downside of this alternative is that it hides the dependency on the
module library from the reflection API and thus from the developer
tools.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining Prolog multifile predicates,  Next: Asserting and retracting Prolog predicates,  Prev: Calling Prolog predicates,  Up: Predicates

1.8.9 Defining Prolog multifile predicates
------------------------------------------

Some Prolog module libraries, e.g.  constraint packages, expect clauses
for some library predicates to be defined in other modules.  This is
accomplished by declaring the library predicate 'multifile' and by
explicitly prefixing predicate clause heads with the library module
identifier.  For example:

     :- multifile(clpfd:run_propagator/2).
     clpfd:run_propagator(..., ...) :-
         ...

Logtalk supports the definition of Prolog module multifile predicates in
objects and categories.  While the clause head is compiled as-is, the
clause body is compiled in the same way as a regular object or category
predicate, thus allowing calls to local object or category predicates.
For example:

     :- object(...).

         :- multifile(clpfd:run_propagator/2).
         clpfd:run_propagator(..., ...) :-
             % calls to local object predicates
             ...

     :- end_object.

The Logtalk compiler will print a warning if the ‘multifile/1’ directive
is missing.  These multifile predicates may also be declared dynamic
using the same ‘Module:Name/Arity’ notation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Asserting and retracting Prolog predicates,  Prev: Defining Prolog multifile predicates,  Up: Predicates

1.8.10 Asserting and retracting Prolog predicates
-------------------------------------------------

To assert and retract clauses for Prolog dynamic predicates, we can use
an explicitly qualified module argument.  For example:

     :- object(...).

         :- dynamic(m:bar/1).

         foo(X) :-
             retractall(m:bar(_)),
             assertz(m:bar(X)),
             ...

     :- end_object.

In alternative, we can use *note use_module/2: 4d. directives to declare
the module predicates.  For example:

     :- object(...).

         :- use_module(m, [bar/1]).
         :- dynamic(m:bar/1).

         foo(X) :-
             % retract and assert bar/1 clauses in module m
             retractall(bar(_)),
             assertz(bar(X)),
             ...

     :- end_object.

When the Prolog dynamic predicates are defined in ‘user’, the
recommended and most portable practice (as not all backends support a
module system) is to use a *note uses/2: 4b. directive:

     :- object(...).

         :- uses(user, [bar/1]).
         :- dynamic(user::bar/1).

         foo(X) :-
             % retract and assert bar/1 clauses in user
             retractall(bar(_)),
             assertz(bar(X)),
             ...

     :- end_object.

Note that in the alternatives using ‘uses/2’ or ‘use_module/2’
directives, the argument of the database handling predicates must be
known at compile-time.  If that is not the case, you must use either an
explicitly-qualified argument or the *note {}/1: 191. control construct
instead.  For example:

     :- object(...).

         add(X) :-
             % assert clause X in module m
             assertz(m:X),
             ...

         remove(Y) :-
             % retract all clauses in user whose head unifies with Y
             {retractall(Y)},
             ...

     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inheritance,  Next: Event-driven programming,  Prev: Predicates,  Up: User Manual

1.9 Inheritance
===============

The inheritance mechanisms found in object-oriented programming
languages allow the specialization of previously defined objects,
avoiding the unnecessary repetition of code and allowing the definition
of common functionality for sets of objects.  In the context of logic
programming, we can interpret inheritance as a form of 'theory
extension': an object will virtually contain, besides its own
predicates, all the predicates inherited from other objects that are not
redefined locally.  Inheritance is not, however, the only mechanism for
theory extension.  Logtalk also supports 'composition' using *note
categories: 109.

Logtalk uses a depth-first lookup procedure for finding predicate
declarations and predicate definitions, as explained below, when a *note
message: 79. is sent to an object.  The lookup procedures locate the
entity holding the *note predicate declaration: 57. and the entity
holding the *note predicate definition: 58. using the predicate name and
arity.  The *note alias/2: 165. predicate directive may be used for
defining alternative names for inherited predicates, for solving
inheritance conflicts, and for giving access to all inherited
definitions (thus overriding the default lookup procedure).

The lookup procedures are used when sending a message (using the *note
(;;)/2: 7e, *note (;;)/1: 5c, and *note []/1: 81. control constructs)
and when making 'super' calls (using the *note (^^)/1: 5d. control
construct).  The exact details of the lookup procedures depend on the
*note role: 93. played by the object receiving the message or making the
'super' call, as explained next.  The lookup procedures are also used by
the *note current_predicate/1: 141. and *note predicate_property/2: 142.
reflection predicates.

* Menu:

* Protocol inheritance::
* Implementation inheritance::
* Public, protected, and private inheritance: Public protected and private inheritance.
* Multiple inheritance::
* Composition versus multiple inheritance::


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol inheritance,  Next: Implementation inheritance,  Up: Inheritance

1.9.1 Protocol inheritance
--------------------------

Protocol inheritance refers to the inheritance of predicate declarations
(*note scope directives: 1e4.).  These can be contained in objects,
protocols, or categories.  Logtalk supports single and multi-inheritance
of protocols: an object or a category may implement several protocols,
and a protocol may extend several protocols.

* Menu:

* Lookup order for prototype hierarchies::
* Lookup order for class hierarchies::


File: TheLogtalkHandbook-3.100.1.info,  Node: Lookup order for prototype hierarchies,  Next: Lookup order for class hierarchies,  Up: Protocol inheritance

1.9.1.1 Lookup order for prototype hierarchies
..............................................

The lookup order for predicate declarations is first the object, second
the implemented protocols (and the protocols that these may extend),
third the imported categories (and the protocols that they may
implement), and finally the objects that the object extends (following
their declaration order).  This lookup is performed in depth-first
order.  When an object inherits two different declarations for the same
predicate, by default, only the first one will be considered.


File: TheLogtalkHandbook-3.100.1.info,  Node: Lookup order for class hierarchies,  Prev: Lookup order for prototype hierarchies,  Up: Protocol inheritance

1.9.1.2 Lookup order for class hierarchies
..........................................

The lookup order for predicate declarations is first the object classes
(following their declaration order), second the classes implemented
protocols (and the protocols that these may extend), third the classes
imported categories (and the protocols that they may implement), and
finally the superclasses of the object classes.  This lookup is
performed in depth-first order.  If the object inherits two different
declarations for the same predicate, by default, only the first one will
be considered.


File: TheLogtalkHandbook-3.100.1.info,  Node: Implementation inheritance,  Next: Public protected and private inheritance,  Prev: Protocol inheritance,  Up: Inheritance

1.9.2 Implementation inheritance
--------------------------------

Implementation inheritance refers to the inheritance of predicate
definitions.  These can be contained in objects or in categories.
Logtalk supports multi-inheritance of implementation: an object may
import several categories or extend, specialize, or instantiate several
objects.

* Menu:

* Lookup order for prototype hierarchies: Lookup order for prototype hierarchies<2>.
* Lookup order for class hierarchies: Lookup order for class hierarchies<2>.
* Redefining inherited predicate definitions::
* Specializing inherited predicate definitions::
* Union of inherited and local predicate definitions::
* Selective inheritance of predicate definitions::


File: TheLogtalkHandbook-3.100.1.info,  Node: Lookup order for prototype hierarchies<2>,  Next: Lookup order for class hierarchies<2>,  Up: Implementation inheritance

1.9.2.1 Lookup order for prototype hierarchies
..............................................

The lookup order for predicate definitions is similar to the lookup for
predicate declarations, except that implemented protocols are ignored
(as they can only contain predicate directives).


File: TheLogtalkHandbook-3.100.1.info,  Node: Lookup order for class hierarchies<2>,  Next: Redefining inherited predicate definitions,  Prev: Lookup order for prototype hierarchies<2>,  Up: Implementation inheritance

1.9.2.2 Lookup order for class hierarchies
..........................................

The lookup order for predicate definitions is similar to the lookup for
predicate declarations, except that implemented protocols are ignored
(as they can only contain predicate directives) and that the lookup
starts at the instance itself (that received the message) before
proceeding, if no predicate definition is found there, to the instance
classes imported categories and then to the class superclasses.


File: TheLogtalkHandbook-3.100.1.info,  Node: Redefining inherited predicate definitions,  Next: Specializing inherited predicate definitions,  Prev: Lookup order for class hierarchies<2>,  Up: Implementation inheritance

1.9.2.3 Redefining inherited predicate definitions
..................................................

When we define a predicate that is already inherited from an ancestor
object or an imported category, the inherited definition is hidden by
the new definition.  This is called inheritance overriding: a local
definition overrides any inherited definitions.  For example, assume
that we have the following two objects:

     :- object(root).

         :- public(bar/1).
         bar(root).

         :- public(foo/1).
         foo(root).

     :- end_object.


     :- object(descendant,
         extends(root)).

         foo(descendant).

     :- end_object.

After compiling and loading these objects, we can check the overriding
behavior by trying the following queries:

     | ?- root::(bar(Bar), foo(Foo)).

     Bar = root
     Foo = root
     yes


     | ?- descendant::(bar(Bar), foo(Foo)).

     Bar = root
     Foo = descendant
     yes

However, we can explicitly code other behaviors.  Some examples follow.


File: TheLogtalkHandbook-3.100.1.info,  Node: Specializing inherited predicate definitions,  Next: Union of inherited and local predicate definitions,  Prev: Redefining inherited predicate definitions,  Up: Implementation inheritance

1.9.2.4 Specializing inherited predicate definitions
....................................................

Specialization of inherited definitions: the new definition calls the
inherited definition and makes additional calls.  This is accomplished
by calling the *note (^^)/1: 5d. 'super call' operator in the new
definition.  For example, assume a ‘init/0’ predicate that must account
for object specific initializations along the inheritance chain:

     :- object(root).

         :- public(init/0).

         init :-
             write('root init'), nl.

     :- end_object.


     :- object(descendant,
         extends(root)).

         init :-
             write('descendant init'), nl,
             ^^init.

     :- end_object.

     | ?- descendant::init.

     descendant init
     root init
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Union of inherited and local predicate definitions,  Next: Selective inheritance of predicate definitions,  Prev: Specializing inherited predicate definitions,  Up: Implementation inheritance

1.9.2.5 Union of inherited and local predicate definitions
..........................................................

Union of the new with the inherited definitions: all the definitions are
taken into account, the calling order being defined by the inheritance
mechanisms.  This can be accomplished by writing a clause that just
calls, using the *note (^^)/1: 5d. 'super call' operator, the inherited
definitions.  The relative position of this clause among the other
definition clauses sets the calling order for the local and inherited
definitions.  For example:

     :- object(root).

         :- public(foo/1).

         foo(1).
         foo(2).

     :- end_object.


     :- object(descendant,
         extends(root)).

         foo(3).
         foo(Foo) :-
             ^^foo(Foo).

     :- end_object.

     | ?- descendant::foo(Foo).

     Foo = 3 ;
     Foo = 1 ;
     Foo = 2 ;
     no


File: TheLogtalkHandbook-3.100.1.info,  Node: Selective inheritance of predicate definitions,  Prev: Union of inherited and local predicate definitions,  Up: Implementation inheritance

1.9.2.6 Selective inheritance of predicate definitions
......................................................

Selective inheritance of predicate definitions (also known as
differential inheritance) is normally used in the representation of
exceptions to inherited default definitions.  We can use the *note
(^^)/1: 5d. 'super call' operator to test and possibly reject some of
the inherited definitions.  A common example is representing flightless
birds:

     :- object(bird).

         :- public(mode/1).

         mode(walks).
         mode(flies).

     :- end_object.


     :- object(penguin,
         extends(bird)).

         mode(swims).
         mode(Mode) :-
             ^^mode(Mode),
             Mode \== flies.

     :- end_object.

     | ?- penguin::mode(Mode).

     Mode = swims ;
     Mode = walks ;
     no


File: TheLogtalkHandbook-3.100.1.info,  Node: Public protected and private inheritance,  Next: Multiple inheritance,  Prev: Implementation inheritance,  Up: Inheritance

1.9.3 Public, protected, and private inheritance
------------------------------------------------

To make all *note public predicates: 53. declared via implemented
protocols, imported categories, or ancestor objects *note protected
predicates: 54. or to make all public and protected predicates *note
private predicates: 55, we prefix the entity’s name with the
corresponding keyword.  For example:

     :- object(Object,
         implements(private::Protocol)).

         % all the Protocol public and protected
         % predicates become private predicates
         % for the Object clients

         ...

     :- end_object.

or:

     :- object(Class,
         specializes(protected::Superclass)).

         % all the Superclass public predicates become
         % protected predicates for the Class clients

         ...

     :- end_object.

Omitting the scope keyword is equivalent to using the public scope
keyword.  For example:

     :- object(Object,
         imports(public::Category)).

         ...

     :- end_object.

This is the same as:

     :- object(Object,
         imports(Category)).

         ...

     :- end_object.

This way we ensure backward compatibility with older Logtalk versions
and a simplified syntax when protected or private inheritance is not
used.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multiple inheritance,  Next: Composition versus multiple inheritance,  Prev: Public protected and private inheritance,  Up: Inheritance

1.9.4 Multiple inheritance
--------------------------

Logtalk supports multiple inheritance by enabling an object to extend,
instantiate, or specialize more than one object.  Likewise, a protocol
may extend multiple protocols, and a category may extend multiple
categories.  In this case, the depth-first lookup algorithms described
above traverse the list of entities per relation from left to right.
Consider as an example the following object opening directive:

     :- object(foo,
         extends((bar, baz))).

The lookup procedure will look first into the parent object ‘bar’ and
its related entities before looking into the parent object ‘baz’.  The
*note alias/2: 165. predicate directive can always be used to solve
multiple inheritance conflicts.  It should also be noted that the
multi-inheritance support does not affect performance when we use single
inheritance.


File: TheLogtalkHandbook-3.100.1.info,  Node: Composition versus multiple inheritance,  Prev: Multiple inheritance,  Up: Inheritance

1.9.5 Composition versus multiple inheritance
---------------------------------------------

It is not possible to discuss inheritance mechanisms without referring
to the long and probably endless debate on single versus multiple
inheritance.  The single inheritance mechanism can be implemented
efficiently, but it imposes several limitations on reusing, even if the
multiple characteristics we intend to inherit are orthogonal.  On the
other hand, the multiple inheritance mechanisms are attractive in their
apparent capability of modeling complex situations.  However, they
include a potential for conflict between inherited definitions whose
variety does not allow a single and satisfactory solution for all the
cases.

No solution that we might consider satisfactory for all the problems
presented by the multiple inheritance mechanisms has been found.  From
the simplicity of some extensions that use the Prolog search strategy,
such as *note [McCabe92]: 28. or *note [Moss94]: 1fc, to the
sophisticated algorithms of CLOS *note [Bobrow_et_al_88]: 1fd, there is
no adequate solution for all the situations.  Besides, the use of
multiple inheritance carries some complex problems in the domain of
software engineering, particularly in the reuse and maintenance of the
applications.  All these problems are substantially reduced if we
preferably use in our software development composition mechanisms
instead of specialization mechanisms *note [Taenzer89]: 1fe.  Multiple
inheritance is best used as an analysis and project abstraction, rather
than as an implementation technique *note [Shan_et_al_93]: 1ff.  Note
that Logtalk provides first-class support for composition using *note
categories: 109.


File: TheLogtalkHandbook-3.100.1.info,  Node: Event-driven programming,  Next: Multi-threading programming,  Prev: Inheritance,  Up: User Manual

1.10 Event-driven programming
=============================

The addition of event-driven programming capacities to the Logtalk
language *note [Moura94]: 9d. is based on a simple but powerful idea:

     The computations must result not only from message-sending but also
     from the 'observation' of message-sending.

The need to associate computations to the occurrence of events was very
early recognized in knowledge representation languages, programming
languages *note [Stefik_et_al_86]: 202, *note [Moon86]: 10a, operative
systems *note [Tanenbaum87]: 203, and graphical user interfaces.

With the integration between object-oriented and event-driven
programming, we intend to achieve the following goals:

   * Minimize the 'coupling' between objects.  An object should only
     contain what is intrinsic to it.  If an object observes another
     object, that means that it should depend only on the public
     protocol of the object observed and not on the implementation of
     that protocol.

   * Provide a mechanism for building 'reflexive systems' in Logtalk
     based on the dynamic behavior of objects in complement to the
     reflective information on object predicates and relations.

   * Provide a mechanism for easily defining method 'pre- and
     post-conditions' that can be toggled using the *note events: 89.
     compiler flag.  The pre- and post-conditions may be defined in the
     same object containing the methods or distributed between several
     objects acting as method monitors.

   * Provide a 'publish-subscribe' mechanism where public messages play
     the role of events.

* Menu:

* Definitions::
* Event generation::
* Communicating events to monitors::
* Performance concerns::
* Monitor semantics::
* Activation order of monitors::
* Event handling::


File: TheLogtalkHandbook-3.100.1.info,  Node: Definitions,  Next: Event generation,  Up: Event-driven programming

1.10.1 Definitions
------------------

The words 'event' and 'monitor' have multiple meanings in computer
science.  To avoid misunderstandings, we start by defining them in the
Logtalk context.

* Menu:

* Event::
* Monitor::


File: TheLogtalkHandbook-3.100.1.info,  Node: Event,  Next: Monitor,  Up: Definitions

1.10.1.1 Event
..............

In an object-oriented system, all computations start through message
sending.  It thus becomes quite natural to declare that the only event
that can occur in this kind of system is precisely the sending of a
message.  An event can thus be represented by the ordered tuple
‘(Object, Message, Sender)’.

If we consider message processing an indivisible activity, we can
interpret the sending of a message and the return of the control to the
object that has sent the message as two distinct events.  This
distinction allows us to have more precise control over a system’s
dynamic behavior.  In Logtalk, these two types of events have been named
‘before’ and ‘after’, respectively for sending a message and for
returning control to the sender.  Therefore, we refine our event
representation using the ordered tuple ‘(Event, Object, Message,
Sender)’.

The implementation of events in Logtalk enjoys the following properties:

Independence between the two types of events

     We can choose to watch only one event type or to process each one
     of the events associated with a message-sending goal in an
     independent way.

All events are automatically generated by the message-sending mechanism

     The task of generating events is transparently accomplished by the
     message-sending mechanism.  The user only needs to define the
     events that will be monitored.

The events watched at any moment can be dynamically changed during program execution

     The notion of event allows the user not only to have the
     possibility of observing but also of controlling and modifying an
     application behavior, namely by dynamically changing the observed
     events during program execution.  It is our goal to provide the
     user with the possibility of modeling the largest number of
     situations.


File: TheLogtalkHandbook-3.100.1.info,  Node: Monitor,  Prev: Event,  Up: Definitions

1.10.1.2 Monitor
................

Complementary to the notion of event is the notion of monitor.  A
monitor is an object that is automatically notified by the
message-sending mechanism whenever a registered event occurs.  Any
object that defines the event-handling predicates can play the role of a
monitor.

The implementation of monitors in Logtalk enjoys the following
properties:

Any object can act as a monitor

     The monitor status is a role that any object can perform during its
     existence.  The minimum protocol necessary is declared in the
     built-in monitoring(1) protocol.  Strictly speaking, the reference
     to this protocol is only needed when specializing event handlers.
     Nevertheless, it is considered good programming practice to always
     refer to the protocol when defining event handlers.

Unlimited number of monitors for each event

     Several monitors can observe the same event for distinct reasons.
     Therefore, the number of monitors per event is bounded only by the
     available computing resources.

The monitor status of an object can be dynamically changed at runtime

     This property does not imply that an object must be dynamic to act
     as a monitor (the monitor status of an object is not stored in the
     object).

Event handlers cannot modify the event arguments

     Notably, if the message contains unbound variables, these cannot be
     bound by the calls to the monitor event handlers.

   ---------- Footnotes ----------

   (1) ../../apis/monitoring_0.html#monitoring-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Event generation,  Next: Communicating events to monitors,  Prev: Definitions,  Up: Event-driven programming

1.10.2 Event generation
-----------------------

Assuming that the *note events: 89. flag is set to ‘allow’ for the
object (or category) sending the messages we want to observe, for each
message that is sent using the *note (;;)/2: 7e. control construct, the
runtime system automatically generates two events.  The first — 'before
event' — is generated when the message is sent.  The second — 'after
event' — is generated after the message has successfully been executed.

Note that 'self' messages (using the *note (;;)/1: 5c. control
construct) and 'super' calls (using the *note (^^)/1: 5d. control
construct) don’t generate events.


File: TheLogtalkHandbook-3.100.1.info,  Node: Communicating events to monitors,  Next: Performance concerns,  Prev: Event generation,  Up: Event-driven programming

1.10.3 Communicating events to monitors
---------------------------------------

Whenever a spied event occurs, the message-sending mechanism calls the
corresponding event handlers directly for all registered monitors.
These calls are internally made, thus bypassing the message-sending
primitives in order to avoid potential endless loops.  The event
handlers consist of user definitions for the public predicates declared
in the built-in monitoring(1) protocol (see below for more details).

   ---------- Footnotes ----------

   (1) ../../apis/monitoring_0.html#monitoring-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Performance concerns,  Next: Monitor semantics,  Prev: Communicating events to monitors,  Up: Event-driven programming

1.10.4 Performance concerns
---------------------------

Ideally, the existence of monitored messages should not affect the
processing of the remaining messages.  On the other hand, for each
message that has been sent, the system must verify if its respective
event is monitored.  Whenever possible, this verification should be
performed in constant time and independently of the number of monitored
events.  The representation of events takes advantage of the first
argument indexing performed by most Prolog compilers, which ensure — in
the general case — access in constant time.

Event support can be turned off on a per-object (or per-category) basis
using the *note events: 89. compiler flag.  With event support turned
off, Logtalk uses optimized code for processing message-sending calls
that skips the checking of monitored events, resulting in a small but
measurable performance improvement.


File: TheLogtalkHandbook-3.100.1.info,  Node: Monitor semantics,  Next: Activation order of monitors,  Prev: Performance concerns,  Up: Event-driven programming

1.10.5 Monitor semantics
------------------------

The established semantics for monitor actions consists of considering
its success as a necessary condition so that a message can succeed:

   - All actions associated with events of type ‘before’ must succeed so
     that the message processing can start.

   - All actions associated with events of type ‘after’ also have to
     succeed so that the message itself succeeds.  The failure of any
     action associated with an event of type ‘after’ forces backtracking
     over the message execution (the failure of a monitor never causes
     backtracking over the preceding monitor actions).

Note that this is the most general choice.  If we require a transparent
presence of monitors in a message processing, we just have to define the
monitor actions in such a way that they never fail (which is very simple
to accomplish).


File: TheLogtalkHandbook-3.100.1.info,  Node: Activation order of monitors,  Next: Event handling,  Prev: Monitor semantics,  Up: Event-driven programming

1.10.6 Activation order of monitors
-----------------------------------

Ideally, whenever there are several monitors defined for the same event,
the calling order should not interfere with the result.  However, this
is not always possible.  In the case of an event of type ‘before’, the
failure of a monitor prevents a message from being sent and prevents the
execution of the remaining monitors.  In the case of an event of type
‘after’, a monitor failure will force backtracking over message
execution.  Different orders of monitor activation can therefore lead to
different results if the monitor actions imply object modifications
unrecoverable in case of backtracking.  Therefore, the order for monitor
activation should be assumed as arbitrary.  In effect, to assume or to
try to impose a specific sequence requires a global knowledge of an
application dynamics, which is not always possible.  Furthermore, that
knowledge can reveal itself as incorrect if there is any change in the
execution conditions.  Note that, given the independence between
monitors, it does not make sense that a failure forces backtracking over
the actions previously executed.


File: TheLogtalkHandbook-3.100.1.info,  Node: Event handling,  Prev: Activation order of monitors,  Up: Event-driven programming

1.10.7 Event handling
---------------------

Logtalk provides three built-in predicates for event handling.  These
predicates support defining, enumerating, and abolishing events.
Applications that use events extensively usually define a set of objects
that use these built-in predicates to implement more sophisticated and
higher-level behavior.

* Menu:

* Defining new events::
* Abolishing defined events::
* Finding defined events::
* Defining event handlers::


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining new events,  Next: Abolishing defined events,  Up: Event handling

1.10.7.1 Defining new events
............................

New events can be defined using the *note define_events/5: 218. built-in
predicate:

     | ?- define_events(Event, Object, Message, Sender, Monitor).

Note that if any of the ‘Event’, ‘Object’, ‘Message’, and ‘Sender’
arguments is a free variable or contains free variables, this call will
define a 'set' of matching events.


File: TheLogtalkHandbook-3.100.1.info,  Node: Abolishing defined events,  Next: Finding defined events,  Prev: Defining new events,  Up: Event handling

1.10.7.2 Abolishing defined events
..................................

Events that are no longer needed may be abolished using the *note
abolish_events/5: 21b. built-in predicate:

     | ?- abolish_events(Event, Object, Message, Sender, Monitor).

If called with free variables, this goal will remove all matching
events.


File: TheLogtalkHandbook-3.100.1.info,  Node: Finding defined events,  Next: Defining event handlers,  Prev: Abolishing defined events,  Up: Event handling

1.10.7.3 Finding defined events
...............................

The events that are currently defined can be retrieved using the *note
current_event/5: 21e. built-in predicate:

     | ?- current_event(Event, Object, Message, Sender, Monitor).

Note that this predicate will return 'sets' of matching events if some
of the returned arguments are free variables or contain free variables.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining event handlers,  Prev: Finding defined events,  Up: Event handling

1.10.7.4 Defining event handlers
................................

The monitoring(1) built-in protocol declares two public predicates,
*note before/3: 101. and *note after/3: 102, that are automatically
called to handle ‘before’ and ‘after’ events.  Any object that plays the
role of monitor must define one or both of these event handler methods:

     before(Object, Message, Sender) :-
         ... .

     after(Object, Message, Sender) :-
         ... .

The arguments in both methods are instantiated by the message-sending
mechanism when a monitored event occurs.  For example, assume that we
want to define a monitor called ‘tracer’ that will track any message
sent to an object by printing a descriptive text to the standard output.
Its definition could be something like:

     :- object(tracer,
         % built-in protocol for event handler methods
         implements(monitoring)).

         before(Object, Message, Sender) :-
             write('call: '), writeq(Object),
             write(' <-- '), writeq(Message),
             write(' from '), writeq(Sender), nl.

         after(Object, Message, Sender) :-
             write('exit: '), writeq(Object),
             write(' <-- '), writeq(Message),
             write(' from '), writeq(Sender), nl.

     :- end_object.

Assume that we also have the following object:

     :- object(any).

         :- public(bar/1).
         bar(bar).

         :- public(foo/1).
         foo(foo).

     :- end_object.

After compiling and loading both objects and setting the *note events:
89. flag to ‘allow’, we can start tracing every message sent to any
object by calling the *note define_events/5: 218. built-in predicate:

     | ?- set_logtalk_flag(events, allow).

     yes

     | ?- define_events(_, _, _, _, tracer).

     yes

From now on, every message sent from ‘user’ to any object will be traced
to the standard output stream:

     | ?- any::bar(X).

     call: any <-- bar(X) from user
     exit: any <-- bar(bar) from user
     X = bar

     yes

To stop tracing, we can use the *note abolish_events/5: 21b. built-in
predicate:

     | ?- abolish_events(_, _, _, _, tracer).

     yes

The monitoring(2) protocol declares the event handlers as public
predicates.  If necessary, *note protected or private implementation of
the protocol: f7. may be used in order to change the scope of the event
handler predicates.  Note that the message-sending processing mechanism
is able to call the event handlers irrespective of their scope.
Nevertheless, the scope of the event handlers may be restricted in order
to prevent other objects from calling them.

The pseudo-object *note user: cf. can also act as a monitor.  This
object expects the ‘before/3’ and ‘after/3’ predicates to be defined in
the plain Prolog database.  To avoid predicate existence errors when
setting ‘user’ as a monitor, this object declares the predicates
multifile.  Thus, any plain Prolog code defining the predicates should
include the directives:

     :- multifile(before/3).
     :- multifile(after/3).

   ---------- Footnotes ----------

   (1) ../../apis/monitoring_0.html#monitoring-0

   (2) ../../apis/monitoring_0.html#monitoring-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading programming,  Next: Error handling,  Prev: Event-driven programming,  Up: User Manual

1.11 Multi-threading programming
================================

Logtalk provides 'experimental' support for multi-threading programming
on selected Prolog compilers.  Logtalk makes use of the low-level Prolog
built-in predicates that implement message queues and interface with
POSIX threads and mutexes (or a suitable emulation), providing a small
set of high-level predicates and directives that allows programmers to
easily take advantage of modern multi-processor and multi-core computers
without worrying about the tricky details of creating, synchronizing, or
communicating with threads, mutexes, and message queues.  Logtalk
multi-threading programming integrates with object-oriented programming
by providing a 'threaded engines' API, enabling objects and categories
to prove goals concurrently, and supporting synchronous and asynchronous
messages.

* Menu:

* Enabling multi-threading support::
* Enabling objects to make multi-threading calls::
* Multi-threading built-in predicates::
* One-way asynchronous calls::
* Asynchronous calls and synchronized predicates::
* Synchronizing threads through notifications::
* Threaded engines::
* Multi-threading performance::


File: TheLogtalkHandbook-3.100.1.info,  Node: Enabling multi-threading support,  Next: Enabling objects to make multi-threading calls,  Up: Multi-threading programming

1.11.1 Enabling multi-threading support
---------------------------------------

Multi-threading support may be disabled by default.  It can be enabled
on the Prolog adapter files of supported compilers by setting the
read-only *note threads: 225. compiler flag to ‘supported’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Enabling objects to make multi-threading calls,  Next: Multi-threading built-in predicates,  Prev: Enabling multi-threading support,  Up: Multi-threading programming

1.11.2 Enabling objects to make multi-threading calls
-----------------------------------------------------

The *note threaded/0: 228. object directive is used to enable an object
to make multi-threading calls:

     :- threaded.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading built-in predicates,  Next: One-way asynchronous calls,  Prev: Enabling objects to make multi-threading calls,  Up: Multi-threading programming

1.11.3 Multi-threading built-in predicates
------------------------------------------

Logtalk provides a small set of built-in predicates for multi-threading
programming.  For simple tasks where you simply want to prove a set of
goals, each one in its own thread, Logtalk provides a *note threaded/1:
22b. built-in predicate.  The remaining predicates allow for
fine-grained control, including postponing retrieval of thread goal
results at a later time, supporting non-deterministic thread goals, and
making 'one-way' asynchronous calls.  Together, these predicates provide
high-level support for multi-threading programming, covering most common
use cases.

* Menu:

* Proving goals concurrently using threads::
* Proving goals asynchronously using threads::


File: TheLogtalkHandbook-3.100.1.info,  Node: Proving goals concurrently using threads,  Next: Proving goals asynchronously using threads,  Up: Multi-threading built-in predicates

1.11.3.1 Proving goals concurrently using threads
.................................................

A set of goals may be proved concurrently by calling the Logtalk
built-in predicate *note threaded/1: 22b.  Each goal in the set runs in
its own thread.

When the ‘threaded/1’ predicate argument is a 'conjunction' of goals,
the predicate call is akin to 'and-parallelism'.  For example, assume
that we want to find all the prime numbers in a given interval, ‘[N,
M]’.  We can split the interval into two parts and then span two threads
to compute the prime numbers in each sub-interval:

     prime_numbers(N, M, Primes) :-
         M > N,
         N1 is N + (M - N) // 2,
         N2 is N1 + 1,
         threaded((
             prime_numbers(N2, M, [], Acc),
             prime_numbers(N, N1, Acc, Primes)
         )).

     prime_numbers(N, M, Acc, Primes) :-
         ...

The ‘threaded/1’ call terminates when the two implicit threads
terminate.  In a computer with two or more processors (or with a
processor with two or more cores), the code above can be expected to
provide better computation times when compared with single-threaded code
for sufficiently large intervals.

When the ‘threaded/1’ predicate argument is a 'disjunction' of goals,
the predicate call is akin to 'or-parallelism', here reinterpreted as a
set of goals 'competing' to find a solution.  For example, consider the
different methods that we can use to find the roots of real functions.
Depending on the function, some methods will be faster than others.
Some methods will converge to the solution while others may diverge and
never find it.  We can try all the methods simultaneously by writing:

     find_root(Function, A, B, Error, Zero) :-
         threaded((
             bisection::find_root(Function, A, B, Error, Zero)
         ;   newton::find_root(Function, A, B, Error, Zero)
         ;   muller::find_root(Function, A, B, Error, Zero)
         )).

The above ‘threaded/1’ goal succeeds when one of the implicit threads
succeeds in finding the function root, leading to the termination of all
the remaining competing threads.

The ‘threaded/1’ built-in predicate is most useful for lengthy,
independent, deterministic computations where the computational costs of
each goal outweigh the overhead of the implicit thread creation and
management.


File: TheLogtalkHandbook-3.100.1.info,  Node: Proving goals asynchronously using threads,  Prev: Proving goals concurrently using threads,  Up: Multi-threading built-in predicates

1.11.3.2 Proving goals asynchronously using threads
...................................................

A goal may be proved asynchronously using a new thread by calling the
*note threaded_call/1-2: 230. built-in predicate .  Calls to this
predicate are always true and return immediately (assuming a callable
argument).  The term representing the goal is copied, not shared with
the thread.  The thread computes the first solution to the goal, posts
it to the implicit message queue of the object from where the
‘threaded_call/1’ predicate was called, and suspends waiting for either
a request for an alternative solution or for the program to commit to
the current solution.

The results of proving a goal asynchronously in a new thread may be
later retrieved by calling the *note threaded_exit/1-2: 231. built-in
predicate within the same object where the call to the ‘threaded_call/1’
predicate was made.  The ‘threaded_exit/1’ calls suspend execution until
the results of the ‘threaded_call/1’ calls are sent back to the object
message queue.

The ‘threaded_exit/1’ predicate allows us to retrieve alternative
solutions through backtracking (if you want to commit to the first
solution, you may use the *note threaded_once/1-2: 232. predicate
instead of the ‘threaded_call/1’ predicate).  For example, assuming a
‘lists’ object implementing the usual ‘member/2’ predicate, we could
write:

     | ?- threaded_call(lists::member(X, [1,2,3])).

     X = _G189
     yes

     | ?- threaded_exit(lists::member(X, [1,2,3])).

     X = 1 ;
     X = 2 ;
     X = 3 ;
     no

In this case, the ‘threaded_call/1’ and the ‘threaded_exit/1’ calls are
made within the pseudo-object ‘user’.  The implicit thread running the
‘lists::member/2’ goal suspends itself after providing a solution,
waiting for a request for an alternative solution; the thread is
automatically terminated when the runtime engine detects that
backtracking to the ‘threaded_exit/1’ call is no longer possible.

Calls to the ‘threaded_exit/1’ predicate block the caller until the
object message queue receives the reply to the asynchronous call.  The
predicate *note threaded_peek/1-2: 233. may be used to check if a reply
is already available without removing it from the thread queue.  The
‘threaded_peek/1’ predicate call succeeds or fails immediately without
blocking the caller.  However, keep in mind that repeated use of this
predicate is equivalent to polling a message queue, which may hurt
performance.

Be careful when using the ‘threaded_exit/1’ predicate inside
failure-driven loops.  When all the solutions have been found (and the
thread generating them is therefore terminated), re-calling the
predicate will generate an exception.  Note that failing instead of
throwing an exception is not an acceptable solution, as it could be
misinterpreted as a failure of the ‘threaded_call/1’ argument.

The example in the previous section with prime numbers could be
rewritten using the ‘threaded_call/1’ and ‘threaded_exit/1’ predicates:

     prime_numbers(N, M, Primes) :-
         M > N,
         N1 is N + (M - N) // 2,
         N2 is N1 + 1,
         threaded_call(prime_numbers(N2, M, [], Acc)),
         threaded_call(prime_numbers(N, N1, Acc, Primes)),
         threaded_exit(prime_numbers(N2, M, [], Acc)),
         threaded_exit(prime_numbers(N, N1, Acc, Primes)).

     prime_numbers(N, M, Acc, Primes) :-
         ...

When using asynchronous calls, the link between a ‘threaded_exit/1’ call
and the corresponding ‘threaded_call/1’ call is established using
unification.  If there are multiple ‘threaded_call/1’ calls for a
matching ‘threaded_exit/1’ call, the connection can potentially be
established with any of them (this is akin to what happens with
tabling).  Nevertheless, you can easily use a call 'tag' by using the
alternative *note threaded_call/2: 230, *note threaded_once/2: 232, and
*note threaded_exit/2: 231. built-in predicates.  For example:

     ?- threaded_call(member(X, [1,2,3]), Tag).

     Tag = 1
     yes

     ?- threaded_call(member(X, [1,2,3]), Tag).

     Tag = 2
     yes

     ?- threaded_exit(member(X, [1,2,3]), 2).

     X = 1 ;
     X = 2 ;
     X = 3
     yes

When using these predicates, the tags shall be considered as an opaque
term; users shall not rely on its type.  Tagged asynchronous calls can
be canceled by using the *note threaded_cancel/1: 234. predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: One-way asynchronous calls,  Next: Asynchronous calls and synchronized predicates,  Prev: Multi-threading built-in predicates,  Up: Multi-threading programming

1.11.4 One-way asynchronous calls
---------------------------------

Sometimes we want to prove a goal in a new thread without caring about
the results.  This may be accomplished by using the built-in predicate
*note threaded_ignore/1: 237.  For example, assume that we are
developing a multi-agent application where an agent may send a “happy
birthday” message to another agent.  We could write:

     ..., threaded_ignore(agent::happy_birthday), ...

The call succeeds with no reply of the goal success, failure, or even
exception ever being sent back to the object making the call.  Note that
this predicate implicitly performs a deterministic call of its argument.


File: TheLogtalkHandbook-3.100.1.info,  Node: Asynchronous calls and synchronized predicates,  Next: Synchronizing threads through notifications,  Prev: One-way asynchronous calls,  Up: Multi-threading programming

1.11.5 Asynchronous calls and synchronized predicates
-----------------------------------------------------

Proving a goal asynchronously using a new thread may lead to problems
when the goal results in side effects such as input/output operations or
modifications to an *note object database: 1b0.  For example, if a new
thread is started with the same goal before the first one finished its
job, we may end up with mixed output, a corrupted database, or
unexpected goal failures.  In order to solve this problem, predicates
(and grammar rule non-terminals) with side effects can be declared as
'synchronized' by using the *note synchronized/1: 74. predicate
directive.  Proving a query to a synchronized predicate (or synchronized
non-terminal) is internally protected by a mutex, thus allowing for easy
thread synchronization.  For example:

     % ensure thread synchronization
     :- synchronized(db_update/1).

     db_update(Update) :-
         % predicate with side-effects
         ...

A second example: assume an object defining two predicates for writing,
respectively, even and odd numbers in a given interval to the standard
output.  Given a large interval, a goal such as:

     | ?- threaded_call(obj::odd_numbers(1,100)),
          threaded_call(obj::even_numbers(1,100)).

     1 3 2 4 6 8 5 7 10 ...
     ...

will most likely result in a mixed-up output.  By declaring the
‘odd_numbers/2’ and ‘even_numbers/2’ predicates synchronized:

     :- synchronized([
         odd_numbers/2,
         even_numbers/2]).

one goal will only start after the other one finished:

     | ?- threaded_ignore(obj::odd_numbers(1,99)),
          threaded_ignore(obj::even_numbers(1,99)).

     1 3 5 7 9 11 ...
     ...
     2 4 6 8 10 12 ...
     ...

Note that, in a more realistic scenario, the two ‘threaded_ignore/1’
calls would be made concurrently from different objects.  Using the same
synchronized directive for a set of predicates implies that they all use
the same mutex, as required for this example.

As each Logtalk entity is independently compiled, this directive must be
included in every object or category that contains a definition for the
described predicate, even if the predicate declaration is inherited from
another entity, in order to ensure proper compilation.  Note that a
synchronized predicate cannot be declared dynamic.  To ensure atomic
updates of a dynamic predicate, declare as synchronized the predicate
performing the update.

Synchronized predicates may be used as wrappers for messages sent to
objects that are not multi-threading aware.  For example, assume a ‘log’
object defining a ‘write_log_entry/2’ predicate that writes log entries
to a file, thus using side effects on its implementation.  We can
specify and define, for example, a ‘sync_write_log_entry/2’ predicate as
follows:

     :- synchronized(sync_write_log_entry/2).

     sync_write_log_entry(File, Entry) :-
         log::write_log_entry(File, Entry).

and then call the ‘sync_write_log_entry/2’ predicate instead of the
‘write_log_entry/2’ predicate from multi-threaded code.

The synchronization directive may be used when defining objects that may
be reused in both single-threaded and multi-threaded Logtalk
applications.  The directive simply makes calls to the synchronized
predicates deterministic when the objects are used in a single-threaded
application.


File: TheLogtalkHandbook-3.100.1.info,  Node: Synchronizing threads through notifications,  Next: Threaded engines,  Prev: Asynchronous calls and synchronized predicates,  Up: Multi-threading programming

1.11.6 Synchronizing threads through notifications
--------------------------------------------------

Declaring a set of predicates as synchronized can only ensure that they
are not executed at the same time by different threads.  Sometimes we
need to suspend a thread not on a synchronization lock but on some
condition that must hold true for a thread goal to proceed.  I.e.  we
want a thread goal to be suspended until a condition becomes true
instead of simply failing.  The built-in predicate *note
threaded_wait/1: 23b. allows us to suspend a predicate execution
(running in its own thread) until a notification is received.
Notifications are posted using the built-in predicate *note
threaded_notify/1: 23c.  A notification is a Prolog term that a
programmer chooses to represent some condition becoming true.  Any
Prolog term can be used as a notification argument for these predicates.
Related calls to the ‘threaded_wait/1’ and ‘threaded_notify/1’ must be
made within the same object, 'this', as the object message queue is used
internally for posting and retrieving notifications.

Each notification posted by a call to the ‘threaded_notify/1’ predicate
is consumed by a single ‘threaded_wait/1’ predicate call (i.e., these
predicates implement a peer-to-peer mechanism).  Care should be taken to
avoid deadlocks when two (or more) threads both wait and post
notifications to each other.


File: TheLogtalkHandbook-3.100.1.info,  Node: Threaded engines,  Next: Multi-threading performance,  Prev: Synchronizing threads through notifications,  Up: Multi-threading programming

1.11.7 Threaded engines
-----------------------

Threaded engines provide an alternative to the multi-threading
predicates described in the previous sections.  An 'engine' is a
computing thread whose solutions can be lazily computed and retrieved.
In addition, an engine also supports a term queue that allows passing
arbitrary terms to the engine.

An engine is created by calling the *note threaded_engine_create/3: 23f.
built-in predicate.  For example:

     | ?- threaded_engine_create(X, member(X, [1,2,3]), worker).
     yes

The first argument is an 'answer template' to be used for retrieving
solution bindings.  The user can name the engine, as in this example
where the atom ‘worker’ is used, or have the runtime generate a name,
which should be treated as an opaque term.

Engines are scoped by the object within which the
‘threaded_engine_create/3’ call takes place.  Thus, different objects
can create engines with the same names with no conflicts.  Moreover,
engines share the visible predicates of the object creating them.

The engine computes the first solution of its goal argument and suspends
waiting for it to be retrieved.  Solutions can be retrieved one at a
time using the *note threaded_engine_next/2: 240. built-in predicate:

     | ?- threaded_engine_next(worker, X).
     X = 1
     yes

The call blocks until a solution is available and fails if there are no
solutions left.  After returning a solution, this predicate signals the
engine to start computing the next one.  Note that this predicate is
deterministic.  In contrast with the ‘threaded_exit/1-2’ built-in
predicates, retrieving the next solution requires calling the predicate
again instead of backtracking into its call.  For example:

     collect_all(Engine, [Answer| Answers]) :-
         threaded_engine_next(Engine, Answer),
         !,
         collect_all(Engine, Answers).
     collect_all(_, []).

There is also a reified alternative version of the predicate, *note
threaded_engine_next_reified/2: 241, which returns ‘the(Answer)’, ‘no’,
and ‘exception(Error)’ terms as answers.  Using this predicate,
collecting all solutions to an engine uses a different programming
pattern:

     ... :-
         ...,
         threaded_engine_next_reified(Engine, Reified),
         collect_all_reified(Reified, Engine, Answers),
         ...

     collect_all_reified(no, _, []).
     collect_all_reified(the(Answer), Engine, [Answer| Answers]) :-
         threaded_engine_next_reified(Engine, Reified),
         collect_all_reified(Reified, Engine, Answers).

Engines must be explicitly terminated using the *note
threaded_engine_destroy/1: 242. built-in predicate:

     | ?- threaded_engine_destroy(worker).
     yes

A common usage pattern for engines is to define a recursive predicate
that uses the engine term queue to retrieve a task to be performed.  For
example, assume we define the following predicate:

     loop :-
         threaded_engine_fetch(Task),
         handle(Task),
         loop.

The *note threaded_engine_fetch/1: 243. built-in predicate fetches a
task for the engine term queue.  The engine clients would use the *note
threaded_engine_post/2: 244. built-in predicate to post tasks into the
engine term queue.  The engine would be created using the call:

     | ?- threaded_engine_create(none, loop, worker).

     yes

The ‘handle/1’ predicate, after performing a task, can use the *note
threaded_engine_yield/1: 245. built-in predicate to make the task
results available for consumption using the ‘threaded_engine_next/2’ and
‘threaded_engine_next_reified/2’ built-in predicates.  Blocking
semantics are used by these two predicates: the
‘threaded_engine_yield/1’ predicate blocks until the returned solution
is consumed, while the ‘threaded_engine_next/2’ predicate blocks until a
solution becomes available.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading performance,  Prev: Threaded engines,  Up: Multi-threading programming

1.11.8 Multi-threading performance
----------------------------------

The performance of multi-threading applications is highly dependent on
the *note backend Prolog compiler: 34, the operating-system, and the use
of *note dynamic binding: 36. and dynamic predicates.  All compatible
backend Prolog compilers that support multi-threading features make use
of POSIX threads or 'pthreads'.  The performance of the underlying
pthreads implementation can exhibit significant differences between
operating systems.  An important point is synchronized access to dynamic
predicates.  As different threads may try to simultaneously access and
update dynamic predicates, these operations may use a lock-free
algorithm or be protected by a lock, usually implemented using a mutex.
In the latter case, poor mutex lock operating-system performance,
combined with a large number of collisions by several threads trying to
acquire the same lock, can result in severe performance penalties.
Thus, whenever possible, avoid using dynamic predicates and dynamic
binding.


File: TheLogtalkHandbook-3.100.1.info,  Node: Error handling,  Next: Reflection,  Prev: Multi-threading programming,  Up: User Manual

1.12 Error handling
===================

Error handling is accomplished in Logtalk by using the standard
‘catch/3’ and ‘throw/1’ predicates *note [ISO95]: 31. together with a
set of built-in methods that simplify generating errors decorated with
expected context.

Errors thrown by Logtalk have, whenever possible, the following format:

     error(Error, logtalk(Goal, ExecutionContext))

In this exception term, ‘Goal’ is the goal that triggered the error
‘Error’ and ‘ExecutionContext’ is the context in which ‘Goal’ is called.
For example:

     error(
         permission_error(modify,private_predicate,p/0),
         logtalk(foo::abolish(p/0), _)
     )

Note, however, that ‘Goal’ and ‘ExecutionContext’ can be unbound or only
partially instantiated when the corresponding information is not
available (e.g., due to compiler optimizations that throw away the
necessary error context information).  The ‘ExecutionContext’ argument
is an opaque term that can be decoded using the
logtalk::execution_context/7(1) predicate.

* Menu:

* Raising Exceptions::
* Type-checking::
* Expected terms::
* Compiler warnings and errors::
* Runtime errors::

   ---------- Footnotes ----------

   (1) ../../apis/logtalk_0.html#logtalk-0-execution-context-7


File: TheLogtalkHandbook-3.100.1.info,  Node: Raising Exceptions,  Next: Type-checking,  Up: Error handling

1.12.1 Raising Exceptions
-------------------------

The *note error handling section: 24c. in the reference manual lists a
set of convenient built-in methods that generate ‘error/2’ exception
terms with the expected context argument.  For example, instead of
manually constructing a type error as in:

     ...,
     context(Context),
     throw(error(type_error(atom, 42), Context)).

we can simply write:

     ...,
     type_error(atom, 42).

The provided error built-in methods cover all standard error types found
in the ISO Prolog Core standard.


File: TheLogtalkHandbook-3.100.1.info,  Node: Type-checking,  Next: Expected terms,  Prev: Raising Exceptions,  Up: Error handling

1.12.2 Type-checking
--------------------

One of the most common cases where errors may be generated is when
type-checking predicate arguments and input data before processing it.
The standard library includes a type(1) object that defines an extensive
set of types, together with predicates for validating and checking
terms.  The set of types is user extensible.  New types can be defined
by adding clauses for the ‘type/1’ and ‘check/2’ multifile predicates.
For example, assume that we want to be able to check 'temperatures'
expressed in Celsius, Fahrenheit, or Kelvin scales.  We start by
declaring (in an object or category) the new type:

     :- multifile(type::type/1).
     type::type(temperature(_Unit)).

Next, we need to define the actual code that would verify that a
temperature is valid.  As the different scales use a different value for
absolute zero, we can write:

     :- multifile(type::check/2).
     type::check(temperature(Unit), Term) :-
         check_temperature(Unit, Term).

     % given that temperature has only a lower bound, we make use of the library
     % property/2 type to define the necessary test expression for each unit
     check_temperature(celsius, Term) :-
         type::check(property(float, [Temperature]>>(Temperature >= -273.15)), Term).
     check_temperature(fahrenheit, Term) :-
         type::check(property(float, [Temperature]>>(Temperature >= -459.67)), Term).
     check_temperature(kelvin, Term) :-
         type::check(property(float, [Temperature]>>(Temperature >= 0.0)), Term).

With this definition, a term is first checked that it is a float value
before checking that it is in the expected open interval.  But how do we
use this new type?  If we just want to test if a temperature is valid,
we can write:

     ..., type::valid(temperature(celsius), 42.0), ...

The type::valid/2(2) predicate succeeds or fails depending on the second
argument being of the type specified in the first argument.  If instead
of success or failure we want to generate an error for invalid values,
we can use the type::check/2(3) predicate instead:

     ..., type::check(temperature(celsius), 42.0), ...

If we require an ‘error/2’ exception term with the error context, we can
use instead the type::check/3(4) predicate:

     ...,
     context(Context),
     type::check(temperature(celsius), 42.0, Context),
     ...

Note that ‘context/1’ calls are inlined and messages to the library
‘type’ object use *note static binding: 35. when compiling with the
*note optimize flag: 8c. turned on, thus enabling efficient
type-checking.

   ---------- Footnotes ----------

   (1) ../../apis/type_0.html#type-0

   (2) ../../apis/type_0.html#type-0-valid-2

   (3) ../../apis/type_0.html#type-0-check-2

   (4) ../../apis/type_0.html#type-0-check-3


File: TheLogtalkHandbook-3.100.1.info,  Node: Expected terms,  Next: Compiler warnings and errors,  Prev: Type-checking,  Up: Error handling

1.12.3 Expected terms
---------------------

Support for representing and handling 'expected terms' is provided by
the *note expecteds: 24f. library.  Expected terms allow deferring
errors to later stages of an application in lieu to raising an exception
as soon as an error is detected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiler warnings and errors,  Next: Runtime errors,  Prev: Expected terms,  Up: Error handling

1.12.4 Compiler warnings and errors
-----------------------------------

The current Logtalk compiler uses the standard ‘read_term/3’ built-in
predicate to read and compile a Logtalk source file.  This improves the
compatibility with *note backend Prolog compilers: 34. and their
proprietary syntax extensions and standard compliance quirks.  But one
consequence of this design choice is that invalid Prolog terms or syntax
errors may abort the compilation process with limited information given
to the user (due to the inherent limitations of the ‘read_term/3’
predicate).

Assuming that all the terms in a source file are valid, there is a set
of errors and potential errors, described below, that the compiler will
try to detect and report, depending on the used compiler flags (see the
*note Compiler flags: 251. section of this manual on lint flags for
details).

* Menu:

* Unknown entities::
* Singleton variables::
* Redefinition of Prolog built-in predicates::
* Redefinition of Logtalk built-in predicates::
* Redefinition of Logtalk built-in methods::
* Misspell calls of local predicates::
* Portability warnings::
* Deprecated elements::
* Missing directives::
* Duplicated directives::
* Duplicated clauses::
* Goals that are always true or false::
* Trivial fails::
* Suspicious calls::
* Lambda variables::
* Redefinition of predicates declared in uses/2 or use_module/2 directives::
* Other warnings and errors::


File: TheLogtalkHandbook-3.100.1.info,  Node: Unknown entities,  Next: Singleton variables,  Up: Compiler warnings and errors

1.12.4.1 Unknown entities
.........................

The Logtalk compiler warns about any referenced entity that is not
currently loaded.  The warning may reveal a misspelled entity name or
just an entity that will be loaded later.  Out-of-order loading should
be avoided when possible as it prevents some code optimizations, such as
*note static binding: 35. of messages to methods.


File: TheLogtalkHandbook-3.100.1.info,  Node: Singleton variables,  Next: Redefinition of Prolog built-in predicates,  Prev: Unknown entities,  Up: Compiler warnings and errors

1.12.4.2 Singleton variables
............................

Singleton variables in a clause are often misspelled variables and, as
such, are one of the most common errors when programming in Prolog.
Assuming that the *note backend Prolog compiler: 34. implementation of
the ‘read_term/3’ predicate supports the standard ‘singletons/1’ option,
the compiler warns about any singleton variable found while compiling a
source file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Redefinition of Prolog built-in predicates,  Next: Redefinition of Logtalk built-in predicates,  Prev: Singleton variables,  Up: Compiler warnings and errors

1.12.4.3 Redefinition of Prolog built-in predicates
...................................................

The Logtalk compiler will warn us of any redefinition of a Prolog
built-in predicate inside an object or category.  Sometimes the
redefinition is intended.  In other cases, the user may not be aware
that a particular *note backend Prolog compiler: 34. may already provide
the predicate as a built-in predicate or may want to ensure code
portability among several Prolog compilers with different sets of
built-in predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Redefinition of Logtalk built-in predicates,  Next: Redefinition of Logtalk built-in methods,  Prev: Redefinition of Prolog built-in predicates,  Up: Compiler warnings and errors

1.12.4.4 Redefinition of Logtalk built-in predicates
....................................................

Similar to the redefinition of Prolog built-in predicates, the Logtalk
compiler will warn us if we try to redefine a Logtalk built-in.  But the
redefinition will probably be an error in most (if not all) cases.


File: TheLogtalkHandbook-3.100.1.info,  Node: Redefinition of Logtalk built-in methods,  Next: Misspell calls of local predicates,  Prev: Redefinition of Logtalk built-in predicates,  Up: Compiler warnings and errors

1.12.4.5 Redefinition of Logtalk built-in methods
.................................................

An error will be thrown if we attempt to redefine a Logtalk built-in
method inside an entity.  The default behavior is to report the error
and abort the compilation of the offending entity.


File: TheLogtalkHandbook-3.100.1.info,  Node: Misspell calls of local predicates,  Next: Portability warnings,  Prev: Redefinition of Logtalk built-in methods,  Up: Compiler warnings and errors

1.12.4.6 Misspell calls of local predicates
...........................................

A warning will be reported if Logtalk finds (in the body of a predicate
definition) a call to a local predicate that is not defined, built-in
(either in Prolog or in Logtalk) or declared dynamic.  In most cases
these calls are simple misspell errors.


File: TheLogtalkHandbook-3.100.1.info,  Node: Portability warnings,  Next: Deprecated elements,  Prev: Misspell calls of local predicates,  Up: Compiler warnings and errors

1.12.4.7 Portability warnings
.............................

A warning will be reported if a predicate clause contains a call to a
non-standard built-in predicate or arithmetic function.  Portability
warnings are also reported for non-standard flags or flag values.  These
warnings often cannot be avoided due to the limited scope of the ISO
Prolog standard.


File: TheLogtalkHandbook-3.100.1.info,  Node: Deprecated elements,  Next: Missing directives,  Prev: Portability warnings,  Up: Compiler warnings and errors

1.12.4.8 Deprecated elements
............................

A warning will be reported if a deprecated directive, control construct,
or predicate is used.  These warnings should be fixed as soon as
possible, as support for any deprecated features will likely be
discontinued in future versions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Missing directives,  Next: Duplicated directives,  Prev: Deprecated elements,  Up: Compiler warnings and errors

1.12.4.9 Missing directives
...........................

A warning will be reported for any missing dynamic, discontiguous,
meta-predicate, and public predicate directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Duplicated directives,  Next: Duplicated clauses,  Prev: Missing directives,  Up: Compiler warnings and errors

1.12.4.10 Duplicated directives
...............................

A warning will be reported for any duplicated scope, multifile, dynamic,
discontiguous, meta-predicate, and meta-non-terminal directives.  Note
that conflicting directives for the same predicate are handled as
errors, not as duplicated directive warnings.


File: TheLogtalkHandbook-3.100.1.info,  Node: Duplicated clauses,  Next: Goals that are always true or false,  Prev: Duplicated directives,  Up: Compiler warnings and errors

1.12.4.11 Duplicated clauses
............................

A warning will be reported for any duplicated entity clauses.  This
check is computationally heavy, however, and usually turned off by
default.


File: TheLogtalkHandbook-3.100.1.info,  Node: Goals that are always true or false,  Next: Trivial fails,  Prev: Duplicated clauses,  Up: Compiler warnings and errors

1.12.4.12 Goals that are always true or false
.............................................

A warning will be reported for any goal that is always true or false.
This is usually caused by typos in the code.  For example, writing ‘X ==
y’ instead of ‘X == Y’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Trivial fails,  Next: Suspicious calls,  Prev: Goals that are always true or false,  Up: Compiler warnings and errors

1.12.4.13 Trivial fails
.......................

A warning will be reported for any call to a local static predicate with
no matching clause.


File: TheLogtalkHandbook-3.100.1.info,  Node: Suspicious calls,  Next: Lambda variables,  Prev: Trivial fails,  Up: Compiler warnings and errors

1.12.4.14 Suspicious calls
..........................

A warning will be reported for calls that are syntactically correct but
most likely a semantic error.  An example is *note (;;)/1: 5c. calls in
clauses that apparently are meant to implement recursive predicate
definitions where the user intention is to call the local predicate
definition.


File: TheLogtalkHandbook-3.100.1.info,  Node: Lambda variables,  Next: Redefinition of predicates declared in uses/2 or use_module/2 directives,  Prev: Suspicious calls,  Up: Compiler warnings and errors

1.12.4.15 Lambda variables
..........................

A warning will be reported for *note lambda expressions: 182. with
unclassified variables (not listed as either *note lambda free: 270. or
*note lambda parameter: 271. variables), for variables playing a dual
role (as both lambda free and lambda parameter variables), and for
lambda parameters used elsewhere in a clause.


File: TheLogtalkHandbook-3.100.1.info,  Node: Redefinition of predicates declared in uses/2 or use_module/2 directives,  Next: Other warnings and errors,  Prev: Lambda variables,  Up: Compiler warnings and errors

1.12.4.16 Redefinition of predicates declared in ‘uses/2’ or ‘use_module/2’ directives
......................................................................................

A error will be reported for any attempt to define locally a predicate
that is already declared in an *note uses/2: 4b. or *note use_module/2:
4d. directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Other warnings and errors,  Prev: Redefinition of predicates declared in uses/2 or use_module/2 directives,  Up: Compiler warnings and errors

1.12.4.17 Other warnings and errors
...................................

The Logtalk compiler will throw an error if it finds a predicate clause
or a directive that cannot be parsed.  The default behavior is to report
the error and abort the compilation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Runtime errors,  Prev: Compiler warnings and errors,  Up: Error handling

1.12.5 Runtime errors
---------------------

This section briefly describes runtime errors that result from misuse of
Logtalk built-in predicates, built-in methods, or from message-sending.
For a complete and detailed description of runtime errors, please
consult the Reference Manual.

* Menu:

* Logtalk built-in predicates::
* Logtalk built-in methods::
* Message sending::


File: TheLogtalkHandbook-3.100.1.info,  Node: Logtalk built-in predicates,  Next: Logtalk built-in methods,  Up: Runtime errors

1.12.5.1 Logtalk built-in predicates
....................................

Most Logtalk built-in predicates check the type and mode of the calling
arguments, throwing an exception in case of misuse.


File: TheLogtalkHandbook-3.100.1.info,  Node: Logtalk built-in methods,  Next: Message sending,  Prev: Logtalk built-in predicates,  Up: Runtime errors

1.12.5.2 Logtalk built-in methods
.................................

Most Logtalk built-in method check the type and mode of the calling
arguments, throwing an exception in case of misuse.


File: TheLogtalkHandbook-3.100.1.info,  Node: Message sending,  Prev: Logtalk built-in methods,  Up: Runtime errors

1.12.5.3 Message sending
........................

The message-sending mechanisms always check if the receiver of a message
is a defined object and if the message corresponds to a declared
predicate within the scope of the sender.  The built-in protocol
forwarding(1) declares a predicate, *note forward/1: 105, which is
automatically called (if defined) by the runtime for any message that
the receiving object does not understand.  The usual definition for this
error handler is to delegate or forward the message to another object
that might be able to answer it:

     forward(Message) :-
         % forward the message while preserving the sender
         [Object::Message].

If preserving the original sender is not required, this definition can
be simplified to:

     forward(Message) :-
         Object::Message.

More sophisticated definitions are, of course, possible.

   ---------- Footnotes ----------

   (1) ../../apis/forwarding_0.html#forwarding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Reflection,  Next: Writing and running applications,  Prev: Error handling,  Up: User Manual

1.13 Reflection
===============

Logtalk provides support for both 'structural' and 'behavioral'
reflection.  Structural reflection supports computations over an
application structure.  Behavioral reflection supports computations over
what an application does while running.  The structural and behavioral
reflection APIs are used by all the *note developer tools: 280, which
are regular applications.

* Menu:

* Structural reflection::
* Behavioral reflection::


File: TheLogtalkHandbook-3.100.1.info,  Node: Structural reflection,  Next: Behavioral reflection,  Up: Reflection

1.13.1 Structural reflection
----------------------------

Structural reflection allows querying the properties of objects,
categories, protocols, and predicates.  This API provides two views on
the structure of an application: a 'transparent-box view' and a
'black-box view', described next.

* Menu:

* Transparent-box view::
* Black-box view::


File: TheLogtalkHandbook-3.100.1.info,  Node: Transparent-box view,  Next: Black-box view,  Up: Structural reflection

1.13.1.1 Transparent-box view
.............................

The transparent-box view provides a structural view of the contents and
properties of entities, predicates, and source files akin to accessing
the corresponding source code.  I.e.  this is the view we use when
asking questions such as: 'What predicates are declared in this
protocol?'  'Which predicates are called by this predicate?'  'Where are
clauses for this multifile predicate defined?'

For entities, built-in predicates are provided for *note enumerating
entities: 284, *note enumerating entity properties: 6f. (including
entity declared, defined, called, and updated predicates; i.e.  full
predicate cross-referencing data), and *note enumerating entity
relations: 285. (for full entity cross-referencing data).  For a
detailed description of the supported entity properties, see the
sections on *note object properties: c5, *note protocol properties: f3,
and *note category properties: 12a.  For examples of querying entity
relations, see the sections on *note object relations: bc, *note
protocol relations: ef, and *note category relations: 127.

     Note: Some entity and predicate properties are only available when
     the source files are compiled with the *note source_data: cc. flag
     turned on.

The logtalk(1) built-in object provides predicates for querying loaded
source files and their properties.

   ---------- Footnotes ----------

   (1) ../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Black-box view,  Prev: Transparent-box view,  Up: Structural reflection

1.13.1.2 Black-box view
.......................

The black-box view provides a view that takes into account entity
encapsulation and thus only allows querying about predicates and
operators that are within the scope of the entity calling the reflection
methods.  This is the view we use when asking questions such as: 'What
messages can be sent to this object?'

Built-in methods are provided for querying the *note predicates that are
declared and can be called or used as messages: 141. and for querying
the *note predicate properties: 142.  It is also possible to enumerate
*note entity operators: 15e.  See the sections on *note finding declared
predicates: 1ce. and on *note predicate properties: 1cc. for more
details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Behavioral reflection,  Prev: Structural reflection,  Up: Reflection

1.13.2 Behavioral reflection
----------------------------

Behavioral reflection provides insight on what an application does when
running.  Specifically, by observing and acting on the messages being
exchanged between objects.  See the section on *note event-driven
programming: 6d. for details.  There is also a *note dependents: 289.
library that provides an implementation of Smalltalk dependents
mechanism.

For use in debugging tools, there is also a small reflection API
providing *note trace and debug event predicates: d5. provided by the
logtalk(1) built-in object.

   ---------- Footnotes ----------

   (1) ../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Writing and running applications,  Next: Printing messages and asking questions,  Prev: Reflection,  Up: User Manual

1.14 Writing and running applications
=====================================

For successful programming in Logtalk, you need a good working knowledge
of Prolog and an understanding of the principles of object-oriented
programming.  Most guidelines for writing good Prolog code apply as well
to Logtalk programming.  To those guidelines, you should add the basics
of good object-oriented design.

One of the advantages of a system like Logtalk is that it enables us to
use the currently available object-oriented methodologies, tools, and
metrics *note [Champaux92]: 28d. in logic programming.  That said,
writing applications in Logtalk is similar to writing applications in
Prolog: we define new predicates describing what is true about our
domain objects, about our problem solution.  We encapsulate our
predicate directives and definitions inside new objects, categories, and
protocols that we create by hand with a text editor or by using the
Logtalk built-in predicates.  Some of the information collected during
the analysis and design phases can be integrated into the objects,
categories, and protocols that we define by using the available entity
and predicate documenting directives.

* Menu:

* Starting Logtalk::
* Running parallel Logtalk processes::
* Source files::
* Multi-pass compiler::
* Compiling and loading your applications::
* Compiler errors, warnings, and comments: Compiler errors warnings and comments.
* Loader files::
* Libraries of source files::
* Settings files::
* Compiler linter::
* Compiler flags::
* Reloading source files::
* Batch processing::
* Optimizing performance::
* Portable applications::
* Conditional compilation::
* Avoiding common errors::
* Coding style guidelines::


File: TheLogtalkHandbook-3.100.1.info,  Node: Starting Logtalk,  Next: Running parallel Logtalk processes,  Up: Writing and running applications

1.14.1 Starting Logtalk
-----------------------

We run Logtalk inside a normal Prolog session, after loading the
necessary files.  Logtalk extends but does not modify your Prolog
compiler.  We can freely mix Prolog queries with the sending of
messages, and our applications can be made of both normal Prolog clauses
and object definitions.

Depending on your Logtalk installation, you may use a script or a
shortcut to start Logtalk with your chosen Prolog compiler.  On POSIX
operating-systems, Bash shell integration scripts should be available
from the command-line.  On Windows, PowerShell integration scripts
should be available from the command-line and integration shortcuts
should be available from the Start Menu.  Scripts are named upon the
used backend Prolog compilers.

For example, assuming a POSIX operating-system and GNU Prolog as the
backend:

     $ gplgt
     ...

Depending on your Logtalk installation, you may need to type instead
‘gplgt.sh’.  On Windows, using PowerShell 7.2 or a later version and
ECLiPSe as the backend:

     PS> eclipselgt.ps1
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Running parallel Logtalk processes,  Next: Source files,  Prev: Starting Logtalk,  Up: Writing and running applications

1.14.2 Running parallel Logtalk processes
-----------------------------------------

Running parallel Logtalk processes is enabled by setting the *note
clean: 292. flag to ‘on’.  This is the default flag value in the backend
adapter files.  With this setting, the intermediate Prolog files
generated by the Logtalk compiler include the process identifier in the
names, thus preventing file name clashes when running parallel
processes.  When the flag is turned off, the generated intermediate
Prolog file names don’t include the process identifier and are kept
between runs.  This is usually done to avoid repeated recompilation of
stable code when developing large applications or when running multiple
test sets for performance (by avoiding repeated recompilation of the
*note lgtunit: 146. tool).

To run parallel Logtalk processes with the ‘clean’ flag turned off, each
process must use its own *note scratch directory: 293.  This is
accomplished by defining the ‘scratch_directory’ library alias to a
per-process location 'before' loading the compiler/runtime.  For
example, assuming we’re using GNU Prolog as the backend, a possible
definition could be:

     :- multifile(logtalk_library_path/2).
     :- dynamic(logtalk_library_path/2).

     logtalk_library_path(scratch_directory, Directory) :-
         temporary_name(lgtXXXXXX, Name),
         decompose_file_name(Name, _, Prefix, _),
         atom_concat('/tmp/', Prefix, Directory),
         (   file_exists(Directory) ->
             true
         ;   make_directory(Directory)
         ).

Assuming the code above is saved in a
‘parallel_logtalk_processes_setup.pl’ file, we would then start Logtalk
using:

     $ gplgt --init-goal "consult('parallel_logtalk_processes_setup.pl')"

The details on how to define and load the definition of the
‘scratch_directory’ library alias are, however, backend specific (due to
the lack of Prolog standardization) and possibly also operating-system
specific (different locations for the temporary directory).  The Logtalk
library includes a ‘parallel_logtalk_processes_setup.pl’ file with
support for selected backends and usage instructions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Source files,  Next: Multi-pass compiler,  Prev: Running parallel Logtalk processes,  Up: Writing and running applications

1.14.3 Source files
-------------------

Logtalk source files may define any number of entities (objects,
categories, or protocols).  Source files may also contain Prolog code
interleaved with Logtalk entity definitions.  Plain Prolog code is
usually copied as-is to the corresponding Prolog output file (except, of
course, if subject to the *note term-expansion mechanism: cb.).  Prolog
modules are compiled as objects.  The following Prolog directives are
processed when read (thus affecting the compilation of the source code
that follows): ‘ensure_loaded/1’, ‘use_module/1-2’, ‘op/3’, and
‘set_prolog_flag/2’.  The *note initialization/1: 42. directive may be
used for defining an initialization goal to be executed when loading a
source file.

Logtalk source files can include the text of other files by using the
*note include/1: b8. directive.  Although there is also a standard
Prolog ‘include/1’ directive, any occurrences of this directive in a
Logtalk source file is handled by the Logtalk compiler, not by the *note
backend Prolog compiler: 34, to improve portability.

When writing a Logtalk source file, the following advice applies:

   - When practical and when performance is critical, define each entity
     on its own source file.

   - Source file loading order can impact performance (e.g., if an
     object imports a category defined in a source file loaded after the
     object source file, no static binding optimizations will be
     possible).

   - Initialization directives that result in the compilation and
     loading of other source files (e.g., libraries) should preferably
     be written in the application loader file to ensure the
     availability of the entities they define when compiling the
     application source files (thus enabling static binding
     optimizations).

Note that you can use the logtalk::loaded_files_topological_sort/1(1)
and logtalk::loaded_files_topological_sort/2(2) predicates to find an
optimal file loading order to eliminate compilation warnings due to
files being loaded before their dependencies.  In the case of simple
applications with no library dependencies:

     ?- {loader}.  % load you application code
     ...

     ?- logtalk::loaded_files_topological_sort(Sorted).
     Sorted = [...]

Use the file basenames from the returned list to update the application
driver files (typically, ‘loader.lgt’ and ‘tester.lgt’).

In more complex applications with external library dependencies, define
a library alies for your application (e.g., ‘my_app’) and use ot get an
initial list of your application files:

     ?- {my_app(loader)}.  % load you application code
     ...

     ?- findall(Path, logtalk::loaded_file_property(Path, library(my_app)), Paths),
        logtalk::loaded_files_topological_sort(Paths, Sorted).
        Sorted = [...]

Note that the ‘Sorted’ list will include the loader file itself.

* Menu:

* Naming conventions::
* Source file text encoding::

   ---------- Footnotes ----------

   (1) 
../../apis/logtalk_0.html#logtalk-0-loaded-files-topological-sort-1

   (2) 
../../apis/logtalk_0.html#logtalk-0-loaded-files-topological-sort-2


File: TheLogtalkHandbook-3.100.1.info,  Node: Naming conventions,  Next: Source file text encoding,  Up: Source files

1.14.3.1 Naming conventions
...........................

When defining each entity in its own source file, it is recommended that
the source file be named after the entity identifier.  For parametric
objects, the identifier arity can be appended to the identifier functor.
By default, all Logtalk source files use the extension ‘.lgt’ but this
is optional and can be set in the adapter files.  For example, we may
define an object named ‘vehicle’ and save it in a ‘vehicle.lgt’ source
file.  A ‘sort(_)’ parametric object would be saved it on a ‘sort_1.lgt’
source file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Source file text encoding,  Prev: Naming conventions,  Up: Source files

1.14.3.2 Source file text encoding
..................................

The text encoding used in a source file may be declared using the *note
encoding/1: 298. directive when running Logtalk with backend Prolog
compilers that support multiple encodings (check the *note
encoding_directive: 299. flag in the adapter file of your Prolog
compiler).


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-pass compiler,  Next: Compiling and loading your applications,  Prev: Source files,  Up: Writing and running applications

1.14.4 Multi-pass compiler
--------------------------

Logtalk is implemented using a 'multi-pass' compiler.  In comparison,
some Prolog systems use a multi-pass compiler while others use a
single-pass compiler.  While there are pros and cons with each solution,
the most relevant consequence in this context is for the content of
source files.  In Logtalk, entities and predicates only become available
(for the runtime system) after the source file is successfully compiled
and loaded.  This may prevent some compiler optimizations, notably *note
static binding: 35, if some of the referred entities are defined in the
same source file.  On the other hand, the order of predicate directives
and predicate definitions is irrelevant.  In contrast, in a system
implemented using a single-pass compiler, the order of the source file
terms can and often is significant for proper and successful
compilation.  In these systems, predicates may become available for
calling as soon as they are compiled, even if the rest of the source
file is yet to be compiled.

The Logtalk compiler reads source files using the Prolog standard
‘read_term/3’ predicate.  This ensures compatibility with any syntax
extensions that the used backend may implement.  In the first compiler
stage, all source file terms are read, and data about all defined
entities, directives, predicates, and grammar rules is collected.  Any
defined *note term-expansion rules: cb. are applied to the read terms.
Grammar rules are expanded into predicate clauses unless expanded by
user-defined term-expansion rules.  The second stage compiles all
initialization goals and clause bodies, taking advantage of the data
collected in the first stage and applying any defined goal-expansion
rules.  Depending on the compilation mode, the generated code can be
instrumented for debugging tools or optimized for performance.  Linter
checks are performed during these two first stages.  The final step in
the second stage is to write the generated intermediate Prolog code into
a temporary file.  In the third and final stage, this intermediate
Prolog file is compiled and loaded by the used backend.  These
intermediate files are deleted by default after loading (see the *note
clean: 292. flag description for details).


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiling and loading your applications,  Next: Compiler errors warnings and comments,  Prev: Multi-pass compiler,  Up: Writing and running applications

1.14.5 Compiling and loading your applications
----------------------------------------------

Your applications will be made of source files containing your objects,
protocols, and categories.  The source files can be compiled to disk by
calling the *note logtalk_compile/1: 29e. built-in predicate:

     | ?- logtalk_compile([source_file1, source_file2, ...]).

This predicate runs the compiler on each file and, if no fatal errors
are found, outputs Prolog source files that can then be consulted or
compiled in the usual way by your Prolog compiler.

To compile to disk and also load into memory the source files, we can
use the *note logtalk_load/1: 46. built-in predicate:

     | ?- logtalk_load([source_file1, source_file2, ...]).

This predicate works in the same way as the predicate
‘logtalk_compile/1’ but also loads the compiled files into memory.

Both predicates expect a source file name or a list of source file names
as an argument.  The Logtalk source file name extension, as defined in
the adapter file (by default, ‘.lgt’), can be omitted.

If you have more than a few source files, then you may want to use a
*note loader file: 4f. helper file containing the calls to the
‘logtalk_load/1-2’ predicates.  Consulting or compiling the loader file
will then compile and load all your Logtalk entities into memory (see
below for details).

With most *note backend Prolog compilers: 34, you can use the shorthand
‘{File}’ for ‘logtalk_load(File)’ and ‘{File1, File2, ...}’ for
‘logtalk_load([File1, File2, ...])’.  The use these shorthands should be
restricted to the Logtalk/Prolog top-level interpreter, as they are not
part of the language specification and may be commented out in case of
conflicts with backend Prolog compiler features.

The built-in predicate *note logtalk_make/0: 29f. can be used to reload
all modified source files.  With most backend Prolog compilers, you can
also use the ‘{*}’ top-level shortcut.  Files are also reloaded when the
compilation mode changes.  An extended version of this predicate, *note
logtalk_make/1: 2a0, accepts multiple targets, including ‘all’, ‘clean’,
‘check’, ‘circular’, ‘documentation’, ‘caches’, ‘debug’, ‘normal’, and
‘optimal’.  For example, assume that you have loaded your application
files and found a bug.  You can easily recompile the files in debug mode
by using the ‘logtalk_make(debug)’ goal.  After debugging and fixing the
bug, you can reload the files in normal mode using the
‘logtalk_make(normal)’ or in optimized mode using the
‘logtalk_make(optimal)’ goal.  See the predicates documentation for a
complete list of targets and top-level shortcuts.  In particular, the
‘logtalk_make(clean)’ goal can be specially useful before switching
backend Prolog compilers, as the generated intermediate files may not be
compatible.  The ‘logtalk_make(caches)’ goal is usually used when
benchmarking compiler performance improvements.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiler errors warnings and comments,  Next: Loader files,  Prev: Compiling and loading your applications,  Up: Writing and running applications

1.14.6 Compiler errors, warnings, and comments
----------------------------------------------

Following a Prolog tradition inherited from Quintus Prolog, the compiler
prefixes (by default) errors with a ‘!’ and warnings with a ‘*’.  For
example:

     !     Existence error: directive object/1 does not exist
     !       in directive end_object/0
     !       in file /home/jdoe/logtalk/examples/errors/unmatched_directive.lgt at or above line 27

     *     No matching clause for goal: baz(a)
     *       while compiling object main_include_compiler_warning
     *       in file /home/jdoe/logtalk/examples/errors/include_compiler_warning.lgt between lines 38-39

Compiler comments are prefixed by ‘%’.  For example:

     ?- {ack(loader)}.
     % [ /home/jdoe/logtalk/examples/ack/ack.lgt loaded ]
     % [ /home/jdoe/logtalk/examples/ack/loader.lgt loaded ]
     % (0 warnings)
     true.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loader files,  Next: Libraries of source files,  Prev: Compiler errors warnings and comments,  Up: Writing and running applications

1.14.7 Loader files
-------------------

If you look into the Logtalk distribution, you will notice that most
source code directories (e.g., of tools, libraries, and examples)
contain a 'driver file' that can be used to load all included source
files and any required libraries.  These loader files are usually named
‘loader.lgt’ or contain the word 'loader' in their name.  Loader files
are ordinary source files and thus compiled and loaded like any source
file.  By also defining a loader file for your project, you can then
load it by simply typing:

     | ?- {loader}.

Another driver file, usually named ‘tester.lgt’ (or containing the word
'tester' in its name) is commonly used to load and run tests.  By also
defining a tester file for your project, you can then run its tests by
simply typing:

     | ?- {tester}.

Usually these driver files contain calls to the built-in predicates
*note set_logtalk_flag/2: 51. (e.g., for setting global,
'project-specific', flag values) and *note logtalk_load/1: 46. or *note
logtalk_load/2: 4e. (for loading project files), wrapped inside a Prolog
‘initialization/1’ directive for portability.  For instance, if your
code is split into three source files named ‘source1.lgt’,
‘source2.lgt’, and ‘source3.lgt’, then the contents of your loader file
could be:

     :- initialization((
         % set project-specific global flags
         set_logtalk_flag(events, allow),
         % load the project source files
         logtalk_load([source1, source2, source3])
     )).

Another example of directives that are often used in a loader file would
be ‘op/3’ directives declaring global operators needed by your project.
Loader files are also often used for setting source file-specific
compiler flags (this is useful even when you only have a single source
file if you always load it with the same set of compiler flags).  For
example:

     :- initialization((
         % set project-specific global flags
         set_logtalk_flag(source_data, off),
         % load the project source files
         logtalk_load(
             [source1, source2, source3],
             % source file-specific flags
             [portability(warning)]),
         logtalk_load(
             [source4, source5],
             % source file-specific flags
             [portability(silent)])
     )).

To take the best advantage of loader and tester files, define a clause
for the multifile and dynamic ‘logtalk_library_path/2’ predicate for the
directory containing your source files as explained in the next section.

When your project also uses Prolog module resources, the loader file is
also the advised place to load them, preferably without any exports.
For example:

     :- use_module(library(clpfd), []).
     ...

     :- initialization((
         ...
     )).

Complex projects often use a main loader file that loads the loader
files of each of the project components.  Thus, loader files provide a
central point to understand a project organization and dependencies.

It is worth mentioning a common mistake when writing the first loader
files.  New users sometimes try to set compiler flags using
‘logtalk_load/2’ when loading a loader file.  For example, by writing:

     | ?- logtalk_load(loader, [optimize(on)]).

This will not work as you might expect, as the compiler flags will only
be used in the compilation of the ‘loader.lgt’ file itself and will not
affect the compilation of files loaded through the ‘initialization/1’
directive contained on the loader file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Libraries of source files,  Next: Settings files,  Prev: Loader files,  Up: Writing and running applications

1.14.8 Libraries of source files
--------------------------------

Logtalk defines a 'library' simply as a directory containing source
files.  Library locations can be specified by defining or asserting
clauses for the dynamic and multifile predicate *note
logtalk_library_path/2: 2a7.  For example:

     :- multifile(logtalk_library_path/2).
     :- dynamic(logtalk_library_path/2).

     logtalk_library_path(shapes, '$LOGTALKUSER/examples/shapes/').

The first argument of the predicate is used as an alias for the path on
the second argument.  Library aliases may also be used on the second
argument.  For example:

     :- multifile(logtalk_library_path/2).
     :- dynamic(logtalk_library_path/2).

     logtalk_library_path(lgtuser, '$LOGTALKUSER/').
     logtalk_library_path(examples, lgtuser('examples/')).
     logtalk_library_path(viewpoints, examples('viewpoints/')).

This allows us to load a library source file without the need to first
change the current working directory to the library directory and then
back to the original directory.  For example, in order to load a
‘loader.lgt’ file, contained in a library named ‘viewpoints’, we just
need to type:

     | ?- logtalk_load(viewpoints(loader)).

The best way to take advantage of this feature is to load at startup a
source file containing clauses for the ‘logtalk_library_path/2’
predicate needed for all available libraries (typically, using a *note
settings file: 49, as discussed below).  This allows us to load library
source files or entire libraries without worrying about library paths,
improving code portability.  The directory paths on the second argument
should always end with the path directory separator character.  Most
backend Prolog compilers allow the use of environment variables in the
second argument of the ‘logtalk_library_path/2’ predicate.  Use of POSIX
relative paths (e.g., ‘'../'’ or ‘'./'’) for top-level library
directories (e.g., ‘lgtuser’ in the example above) is not advised, as
different backend Prolog compilers may start with different initial
working directories, which may result in portability problems of your
loader files.

This *note library notation: 2a8. provides functionality inspired by the
‘file_search_path/2’ mechanism introduced by Quintus Prolog and later
adopted by some other Prolog compilers but with a key difference: there
is no fragile search mechanism, and the Logtalk ‘make’ can be used to
check for duplicated library aliases.  Multiple definitions for the same
alias are problematic when using external dependencies, as any
third-party update to those dependencies can introduce file name
clashes.  Note that the potential for these clashes cannot be reliably
minimized by a careful ordering of the ‘logtalk_library_path/2’
predicate clauses due to this predicate being multifile and dynamic.


File: TheLogtalkHandbook-3.100.1.info,  Node: Settings files,  Next: Compiler linter,  Prev: Libraries of source files,  Up: Writing and running applications

1.14.9 Settings files
---------------------

Although it is always possible to edit the *note backend Prolog
compiler: 34. adapter files, the recommended solution to customize
compiler flags is to create a ‘settings.lgt’ file in the Logtalk user
folder or in the user home folder.  Depending on the backend Prolog
compiler and the operating-system, is also possible to define
per-project settings files by creating a ‘settings.lgt’ file in the
project directory and by starting Logtalk from this directory.  At
startup, Logtalk tries to load a ‘settings.lgt’ file from the following
directories, searched in sequence:

   - Startup directory (‘$LOGTALK_STARTUP_DIRECTORY’)

   - Logtalk user directory (‘$LOGTALKUSER’)

   - User home directory (‘$HOME’; ‘%USERPROFILE%’ on Windows if
     ‘%HOME%’ is not defined)

   - Application data directory (‘%APPDATA%\Logtalk’; only on Windows)

   - Config directory (‘$XDG_CONFIG_HOME/logtalk’)

   - Default config directory (‘$HOME/.config/logtalk/’)

The startup directory is only searched when the read-only *note
settings_file: 2ab. flag is set to ‘allow’.  When no settings files are
found, Logtalk will use the default compiler flag values set on the
backend Prolog compiler adapter files.  When limitations of the backend
Prolog compiler or the operating-system prevent Logtalk from finding the
settings files, these can always be loaded manually after Logtalk
startup.

Settings files are normal Logtalk source files (although when
automatically loaded by Logtalk they are compiled and loaded silently
with any errors being reported but otherwise ignored).  The usual
contents is an ‘initialization/1’ Prolog directive containing calls to
the *note set_logtalk_flag/2: 51. Logtalk built-in predicate and
asserting clauses for the *note logtalk_library_path/2: 2a7. multifile
dynamic predicate.  Note that the *note set_logtalk_flag/2: 50.
directive cannot be used as its scope is local to the source file being
compiled.

One of the troubles of writing portable applications is the different
feature sets of Prolog compilers.  Using the Logtalk support for
conditional compilation and the *note prolog_dialect: 2ac. flag we can
write a single settings file that can be used with several *note backend
Prolog compilers: 34.:

     :- if(current_logtalk_flag(prolog_dialect, yap)).

         % YAP specific settings
         ...

     :- elif(current_logtalk_flag(prolog_dialect, gnu)).

         % GNU Prolog specific settings
         ...

     :- else.

         % generic Prolog settings

     :- endif.

The Logtalk distribution includes a ‘samples/settings-sample.lgt’ sample
file with commented out code snippets for common settings.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiler linter,  Next: Compiler flags,  Prev: Settings files,  Up: Writing and running applications

1.14.10 Compiler linter
-----------------------

The compiler includes a *note linter: 2af. that checks for a wide range
of possible problems in source files.  Notably, the compiler checks for
unknown entities, unknown predicates, undefined predicates (i.e.,
predicates that are declared but not defined), missing directives
(including missing ‘dynamic/1’ and ‘meta_predicate/1’ directives),
redefined built-in predicates, calls to non-portable predicates,
singleton variables, goals that are always true or always false (i.e.,
goals that can be replaced by ‘true’ or ‘fail’), and trivial fails
(i.e., calls to predicates with no match clauses).  Most of the linter
warnings are controlled by *note compiler flags: 2b0.  See the next
section for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiler flags,  Next: Reloading source files,  Prev: Compiler linter,  Up: Writing and running applications

1.14.11 Compiler flags
----------------------

The *note logtalk_load/1: 46. and *note logtalk_compile/1: 29e. always
use the current set of default compiler flags as specified in your
settings file and the Logtalk adapter files or changed for the current
session using the built-in predicate *note set_logtalk_flag/2: 51.
Although the default flag values cover the usual cases, you may want to
use a different set of flag values while compiling or loading some of
your Logtalk source files.  This can be accomplished by using the *note
logtalk_load/2: 4e. or the *note logtalk_compile/2: 2b2. built-in
predicates.  These two predicates accept a list of options affecting how
a Logtalk source file is compiled and loaded:

     | ?- logtalk_compile(Files, Options).

or:

     | ?- logtalk_load(Files, Options).

In fact, the ‘logtalk_load/1’ and ‘logtalk_compile/1’ predicates are
just shortcuts to the extended versions called with the default compiler
flag values.  The options are represented by a compound term where the
functor is the flag name and the sole argument is the flag value.

We may also change the default flag values from the ones loaded from the
adapter file by using the *note set_logtalk_flag/2: 51. built-in
predicate.  For example:

     | ?- set_logtalk_flag(unknown_entities, silent).

The current default flags values can be enumerated using the *note
current_logtalk_flag/2: 2b3. built-in predicate:

     | ?- current_logtalk_flag(unknown_entities, Value).

     Value = silent
     yes

Logtalk also implements a *note set_logtalk_flag/2: 50. directive, which
can be used to set flags within a source file or within an entity.  For
example:

     % compile objects in this source file with event support
     :- set_logtalk_flag(events, allow).

     :- object(foo).

         % compile this object with support
         % for dynamic predicate declarations
         :- set_logtalk_flag(dynamic_declarations, allow).
         ...

     :- end_object.

     ...

Note that the scope of the ‘set_logtalk_flag/2’ directive is local to
the entity or to the source file containing it.

     Note: Applications should never rely on default flag values for
     working properly.  Whenever the compilation of a source file or an
     entity requires a specific flag value, the flag should be set
     explicitly in the entity, in the source file, or in the loader
     file.

* Menu:

* Read-only flags::
* Version flags::
* Lint flags::
* Optional features compilation flags::
* Backend Prolog compiler and loader flags::
* Other flags::
* User-defined flags::


File: TheLogtalkHandbook-3.100.1.info,  Node: Read-only flags,  Next: Version flags,  Up: Compiler flags

1.14.11.1 Read-only flags
.........................

Some flags have read-only values and thus cannot be changed at runtime.
Their values are defined in the Prolog backend *note adapter files: 154.
These are:

‘settings_file’

     Allows or disables loading of a *note settings file: 49. at
     startup.  Possible values are ‘allow’, ‘restrict’, and ‘deny’.  The
     usual default value is ‘allow’ but it can be changed by editing the
     adapter file when e.g.  embedding Logtalk in a compiled
     application.  With a value of ‘allow’, settings files are searched
     in the startup directory, in the Logtalk user directory, in the
     user home directory, in the ‘APPDATA’ if running on Windows, and in
     the XDG configuration directory.  With a value of ‘restrict’, the
     search for the settings files skips the startup directory.

‘prolog_dialect’

     Identifier of the *note backend Prolog compiler: 34. (an atom).
     This flag can be used for *note conditional compilation: 18a. of
     Prolog compiler specific code.

‘prolog_version’

     Version of the *note backend Prolog compiler: 34. (a compound term,
     ‘v(Major, Minor, Patch)’, whose arguments are integers).  This flag
     availability depends on the Prolog compiler.  Checking the value of
     this flag fails for any Prolog compiler that does not provide
     access to version data.

‘prolog_compatible_version’

     Compatible version of the *note backend Prolog compiler: 34. (a
     compound term, usually with the format ‘@>=(v(Major, Minor,
     Patch))’, whose arguments are integers).  This flag availability
     depends on the Prolog compiler.  Checking the value of this flag
     fails for any Prolog compiler that does not provide access to
     version data.

‘unicode’

     Informs Logtalk if the *note backend Prolog compiler: 34. supports
     the Unicode standard.  Possible flag values are ‘unsupported’,
     ‘full’ (all Unicode planes supported), and ‘bmp’ (supports only the
     Basic Multilingual Plane).

‘encoding_directive’

     Informs Logtalk if the *note backend Prolog compiler: 34. supports
     the *note encoding/1: 298. directive.  This directive is used for
     declaring the text encoding of source files.  Possible flag values
     are ‘unsupported’, ‘full’ (can be used in both Logtalk source files
     and compiler generated Prolog files), and ‘source’ (can be used
     only in Logtalk source files).

‘tabling’

     Informs Logtalk if the *note backend Prolog compiler: 34. provides
     tabling programming support.  Possible flag values are
     ‘unsupported’ and ‘supported’.

‘engines’

     Informs if the *note backend Prolog compiler: 34. provides the
     required low level multi-threading programming support for Logtalk
     *note threaded engines: 2ba.  Possible flag values are
     ‘unsupported’ and ‘supported’.

‘threads’

     Informs if the *note backend Prolog compiler: 34. provides the
     required low level multi-threading programming support for all
     high-level Logtalk *note multi-threading features: 73.  Possible
     flag values are ‘unsupported’ and ‘supported’.

‘modules’

     Informs Logtalk if the *note backend Prolog compiler: 34. provides
     suitable module support.  Possible flag values are ‘unsupported’
     and ‘supported’ (independently of this flag, Logtalk provides
     limited support for compiling Prolog modules as objects).

‘coinduction’

     Informs Logtalk if the *note backend Prolog compiler: 34. provides
     the required minimal support for cyclic terms necessary for working
     with *note coinductive predicates: 170.  Possible flag values are
     ‘unsupported’ and ‘supported’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Version flags,  Next: Lint flags,  Prev: Read-only flags,  Up: Compiler flags

1.14.11.2 Version flags
.......................

‘version_data(Value)’

     Read-only flag whose value is the compound term
     ‘logtalk(Major,Minor,Patch,Status)’.  The first three arguments are
     integers and the last argument is an atom, possibly empty,
     representing version status: ‘aN’ for alpha versions, ‘bN’ for beta
     versions, ‘rcN’ for release candidates (with ‘N’ being a natural
     number), and ‘stable’ for stable versions.  The ‘version_data’ flag
     is also a de facto standard for Prolog compilers.


File: TheLogtalkHandbook-3.100.1.info,  Node: Lint flags,  Next: Optional features compilation flags,  Prev: Version flags,  Up: Compiler flags

1.14.11.3 Lint flags
....................

‘linter(Option)’

     Meta-flag for managing the values of all the linter flags as a
     group.  Possible option values are ‘on’ to set all the individual
     linter flags to ‘warning’, ‘off’ to set all the individual linter
     flags to ‘silent’, and ‘default’ to set all the individual linter
     flag values to their defaults as defined in the backend adapter
     files (the usual default).  This flag 'must' always be defined in
     the backend adapter files with the value of ‘default’.

‘unknown_entities(Option)’

     Controls the unknown entity warnings, resulting from loading an
     entity that references some other entity that is not currently
     loaded.  Possible option values are ‘warning’ (the usual default)
     and ‘silent’.  Note that these warnings are not always avoidable,
     specially when using reflective designs of class-based hierarchies.

‘unknown_predicates(Option)’

     Defines the compiler behavior when unknown messages or calls to
     unknown predicates (or non-terminals) are found.  An unknown
     message is a message sent to an object that is not part of the
     object protocol.  An unknown predicate is a called predicate that
     is neither locally declared or defined.  Possible option values are
     ‘error’, ‘warning’ (the usual default), and ‘silent’ (not
     recommended).

‘undefined_predicates(Option)’

     Defines the compiler behavior when calls to declared but undefined
     predicates (or non-terminals) are found.  Note that these calls
     will fail at runtime as per closed-world assumption.  Possible
     option values are ‘error’, ‘warning’ (the usual default), and
     ‘silent’ (not recommended).

‘steadfastness(Option)’

     Controls warnings about 'possible' non *note steadfast: 2c4.
     predicate definitions due to variable aliasing at a clause head and
     a cut in the clause body.  Possible option values are ‘warning’ and
     ‘silent’ (the usual default due to the possibility of false
     positives).

‘portability(Option)’

     Controls the non-ISO specified Prolog built-in predicate and
     non-ISO specified Prolog built-in arithmetic function calls
     warnings plus use of non-standard Prolog flags and/or flag values.
     Possible option values are ‘warning’ and ‘silent’ (the usual
     default).

‘deprecated(Option)’

     Controls the deprecated predicate warnings.  Possible option values
     are ‘warning’ (the usual default) and ‘silent’.

‘missing_directives(Option)’

     Controls the missing predicate directive warnings.  Possible option
     values are ‘warning’ (the usual default) and ‘silent’ (not
     recommended).

‘duplicated_directives(Option)’

     Controls the duplicated predicate directive warnings.  Possible
     option values are ‘warning’ (the usual default) and ‘silent’ (not
     recommended).  Note that conflicting directives for the same
     predicate are handled as errors, not as duplicated directive
     warnings.

‘trivial_goal_fails(Option)’

     Controls the printing of warnings for calls to local static
     predicates with no matching clauses.  Possible option values are
     ‘warning’ (the usual default) and ‘silent’ (not recommended).

‘always_true_or_false_goals(Option)’

     Controls the printing of warnings for goals that are always true or
     false.  Possible option values are ‘warning’ (the usual default)
     and ‘silent’ (not recommended).  A unexpected exception in the goal
     being checked is also reported.

‘grammar_rules(Option)’

     Controls the printing of grammar rules related warnings.  Possible
     option values are ‘warning’ (the usual default) and ‘silent’ (not
     recommended).

‘arithmetic_expressions(Option)’

     Controls the printing of arithmetic expressions related warnings.
     Possible option values are ‘warning’ (the usual default) and
     ‘silent’ (not recommended).

‘lambda_variables(Option)’

     Controls the printing of lambda variable related warnings.
     Possible option values are ‘warning’ (the usual default) and
     ‘silent’ (not recommended).

‘suspicious_calls(Option)’

     Controls the printing of suspicious call warnings.  Possible option
     values are ‘warning’ (the usual default) and ‘silent’ (not
     recommended).

‘redefined_built_ins(Option)’

     Controls the Logtalk and Prolog built-in predicate redefinition
     warnings.  Possible option values are ‘warning’ and ‘silent’ (the
     usual default).  Warnings about redefined Prolog built-in
     predicates are often the result of running a Logtalk application on
     several Prolog compilers, as each Prolog compiler defines its set
     of built-in predicates.

‘redefined_operators(Option)’

     Controls the Logtalk and Prolog built-in operator redefinition
     warnings.  Possible option values are ‘warning’ (the usual default)
     and ‘silent’.  Redefining Logtalk operators or standard Prolog
     operators can break term parsing, causing syntax errors or change
     how terms are parsed, introducing bugs.

‘singleton_variables(Option)’

     Controls the singleton variable warnings.  Possible option values
     are ‘warning’ (the usual default) and ‘silent’ (not recommended).

‘naming(Option)’

     Controls warnings about entity, predicate, and variable names per
     official coding guidelines (which advise using underscores for
     entity and predicate names and camel case for variable names).
     Additionally, variable names should not differ only in case.
     Possible option values are ‘warning’ and ‘silent’ (the usual
     default due to the current limitation to ASCII names and the
     computational cost of the checks).

‘duplicated_clauses(Option)’

     Controls warnings of duplicated entity clauses (and duplicated
     entity grammar rules).  Possible option values are ‘warning’ and
     ‘silent’ (the usual default due to the required heavy
     computations).  When the term-expansion mechanism is used and
     results in duplicated clauses, the reported line numbers are for
     lines of the original clauses that were expanded.

‘disjunctions(Option)’

     Controls warnings on clauses where the body is a disjunction.
     Possible option values are ‘warning’ (the usual default) and
     ‘silent’.  As per coding guidelines, in most cases, these clauses
     can be rewritten using a clause per disjunction branch for improved
     code readability.

‘conditionals(Option)’

     Controls warnings on if-then-else and soft-cut control constructs.
     Possible option values are ‘warning’ (the usual default) and
     ‘silent’.  Warnings include misuse of cuts, potential bugs in the
     test part, and missing else part (lack of compliance with coding
     guidelines).

‘catchall_catch(Option)’

     Controls warnings on ‘catch/3’ goals that catch all exceptions.
     Possible option values are ‘warning’ and ‘silent’ (the usual
     default).  Lack of standardization often makes it tricky or
     cumbersome to avoid too generic ‘catch/3’ goals when writing
     portable code.

‘left_recursion(Option)’

     Controls warnings of left-recursion on clauses and grammar rules.
     Specifically, when the clause or grammar rule head and the leftmost
     goal in the body are variants.  Possible option values are
     ‘warning’ (the usual default) and ‘silent’.

‘tail_recursive(Option)’

     Controls warnings of non-tail recursive predicate (and
     non-terminal) definitions.  The lint check does not detect all
     cases of non-tail recursive predicate definitions, however.  Also,
     definitions that make two or more recursive calls are not reported
     as usually they cannot be changed to be tail recursive.  Possible
     option values are ‘warning’ and ‘silent’ (the usual default).

‘encodings(Option)’

     Controls the source file text encoding warnings.  Possible option
     values are ‘warning’ (the usual default) and ‘silent’.

‘general(Option)’

     Controls warnings that are not controlled by a specific flag.
     Possible option values are ‘warning’ (the usual default) and
     ‘silent’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Optional features compilation flags,  Next: Backend Prolog compiler and loader flags,  Prev: Lint flags,  Up: Compiler flags

1.14.11.4 Optional features compilation flags
.............................................

‘complements(Option)’

     Allows objects to be compiled with support for complementing
     categories turned off in order to improve performance and security.
     Possible option values are ‘allow’ (allow complementing categories
     to override local object predicate declarations and definitions),
     ‘restrict’ (allow complementing categories to add predicate
     declarations and definitions to an object but not to override
     them), and ‘deny’ (ignore complementing categories; the usual
     default).  This option can be used on a per-object basis.  Note
     that changing this option is of no consequence for objects already
     compiled and loaded.

‘dynamic_declarations(Option)’

     Allows objects to be compiled with support for dynamic declaration
     of new predicates turned off in order to improve performance and
     security.  Possible option values are ‘allow’ and ‘deny’ (the usual
     default).  This option can be used on a per-object basis.  Note
     that changing this option is of no consequence for objects already
     compiled and loaded.  This option is only checked when sending an
     *note asserta/1: 1b2. or *note assertz/1: 1b3. message to an
     object.  Local asserting of new predicates is always allowed.

‘events(Option)’

     Allows message-sending calls to be compiled with or without *note
     event-driven programming: 6d. support.  Possible option values are
     ‘allow’ and ‘deny’ (the usual default).  Objects (and categories)
     compiled with this option set to ‘deny’ use optimized code for
     message-sending calls that do not trigger events.  As such, this
     option can be used on a per-object (or per-category) basis.  Note
     that changing this option is of no consequence for objects already
     compiled and loaded.

‘context_switching_calls(Option)’

     Allows context-switching calls (‘(<<)/2’) to be either allowed or
     denied.  Possible option values are ‘allow’ and ‘deny’.  The
     default flag value is ‘allow’.  Note that changing this option is
     of no consequence for objects already compiled and loaded.


File: TheLogtalkHandbook-3.100.1.info,  Node: Backend Prolog compiler and loader flags,  Next: Other flags,  Prev: Optional features compilation flags,  Up: Compiler flags

1.14.11.5 Backend Prolog compiler and loader flags
..................................................

‘underscore_variables(Option)’

     Controls the interpretation of variables that start with an
     underscore (excluding the anonymous variable) that occur once in a
     term as either don’t care variables or singleton variables.
     Possible option values are ‘dont_care’ (the default for all
     supported backends) and ‘singletons’.  Although a changeable flag,
     its value is backend dependent and thus expected to be set only in
     the backend adapter files.

‘prolog_compiler(Flags)’

     List of compiler flags for the generated Prolog files.  The valid
     flags are specific to the used Prolog backend compiler.  The usual
     default is the empty list.  These flags are passed to the backend
     Prolog compiler built-in predicate that is responsible for
     compiling to disk a Prolog file.  For Prolog compilers that don’t
     provide separate predicates for compiling and loading a file, use
     instead the *note prolog_loader: 2dd. flag.

‘prolog_loader(Flags)’

     List of loader flags for the generated Prolog files.  The valid
     flags are specific to the used Prolog backend compiler.  The usual
     default is the empty list.  These flags are passed to the backend
     Prolog compiler built-in predicate that is responsible for loading
     a (compiled) Prolog file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Other flags,  Next: User-defined flags,  Prev: Backend Prolog compiler and loader flags,  Up: Compiler flags

1.14.11.6 Other flags
.....................

‘scratch_directory(Directory)’

     Sets the directory to be used to store the temporary files
     generated when compiling Logtalk source files.  This directory can
     be specified using an atom or using *note library notation: 2a8.
     The directory must always end with a slash.  The default value is a
     sub-directory of the source files directory, either ‘'./lgt_tmp/'’
     or ‘'./.lgt_tmp/'’ (depending on the backend Prolog compiler and
     operating-system).  Relative directories must always start with
     ‘'./'’ due to the lack of a portable solution to check if a path is
     relative or absolute.  The default value set on the *note backend
     Prolog compiler: 34. adapter file can be overridden by defining the
     ‘scratch_directory’ library alias (see the *note
     logtalk_library_path/2: 2a7. predicate documentation for details).

‘report(Option)’

     Controls the default printing of messages.  Possible option values
     are ‘on’ (by usual default, print all messages that are not
     intercepted by the user), ‘warnings’ (only print warning and error
     messages that are not intercepted by the user), and ‘off’ (do not
     print any messages that are not intercepted by the user).

‘code_prefix(Character)’

     Enables the definition of prefix for all functors of Prolog code
     generated by the Logtalk compiler.  The option value must be a
     single character atom.  Its default value is ‘'$'’.  Specifying a
     code prefix provides a way to solve possible conflicts between
     Logtalk compiled code and other Prolog code.  In addition, some
     Prolog compilers automatically hide predicates whose functor starts
     with a specific prefix, such as the character ‘$’.  Although this
     is not a read-only flag, it should only be changed at startup time
     and 'before' loading any source files.  When changing this flag
     (e.g., from a *note settings file: 49.), restart with the *note
     clean: 292. flag turned on to ensure that any compiled files using
     the old ‘code_prefix’ value will be recompiled.

‘optimize(Option)’

     Controls the compiler optimizations.  Possible option values are
     ‘on’ (used by default for deployment) and ‘off’ (used by default
     for development).  Compiler optimizations include the use of static
     binding whenever possible, the removal of redundant calls to
     ‘true/0’ from predicate clauses, the removal of redundant
     unifications when compiling grammar rules, and inlining of
     predicate definitions with a single clause that links to a local
     predicate, to a plain Prolog built-in (or foreign) predicate, or to
     a Prolog module predicate with the same arguments.  Care should be
     taken when developing applications with this flag turned on as
     changing and reloading a file may render *note static binding: 35.
     optimizations invalid for code defined in other loaded files.
     Turning on this flag automatically turns off the *note debug: 2e2.
     flag.

‘source_data(Option)’

     Defines how much information is retained when compiling a source
     file.  Possible option values are ‘on’ (the usual default for
     development) and ‘off’.  With this flag set to ‘on’, Logtalk will
     keep the information represented using documenting directives plus
     source location data (including source file names and line
     numbers).  This information can be retrieved using the *note
     reflection API: 48. and is useful for documenting, debugging, and
     integration with third-party development tools.  This flag can be
     turned off in order to generate more compact code.

‘debug(Option)’

     Controls the compilation of source files in debug mode (the Logtalk
     default debugger can only be used with files compiled in this
     mode).  Also controls, by default, printing of ‘debug>’ and
     ‘debug(Topic)’ messages.  Possible option values are ‘on’ and ‘off’
     (the usual default).  Turning on this flag automatically turns off
     the *note optimize: 8c. flag.

‘reload(Option)’

     Defines the reloading behavior for source files.  Possible option
     values are ‘skip’ (skip reloading of already loaded files; this
     value can be used to get similar functionality to the Prolog
     directive ‘ensure_loaded/1’ but should be used only with fully
     debugged code), ‘changed’ (the usual default; reload files only
     when they are changed since last loaded, provided that any explicit
     flags and the compilation mode are the same as before), and
     ‘always’ (always reload files).

‘relative_to(Directory)’

     Defines a base directory for resolving relative source file paths.
     The default value is the directory of the source file being
     compiled.

‘hook(Object)’

     Allows the definition of an object (which can be the pseudo-object
     user(1)) implementing the expanding(2) built-in protocol.  The hook
     object must be compiled and loaded when this option is used.  It’s
     also possible to specify a Prolog module instead of a Logtalk
     object, but the module must be pre-loaded, and its identifier must
     be different from any object identifier.

‘clean(Option)’

     Controls cleaning of the intermediate Prolog files generated when
     compiling Logtalk source files.  Possible option values are ‘off’
     and ‘on’ (the usual default).  When turned on, intermediate files
     are deleted after loading, and all source files are recompiled
     disregarding any existing intermediate files.  When turned off, the
     intermediate files are kept.  This is useful when embedding
     applications, which requires collecting the intermediate code, and
     when working on large applications to avoid repeated recompilation
     of stable code.  The flag must be turned on when changing
     compilation modes, changing flags such as *note code_prefix: 2e1,
     or when turning on linter flags that are off by default without at
     the same time making changes to the application source files
     themselves, as any existing intermediate files would not be
     recompiled as necessary due to file timestamps not changing.

   ---------- Footnotes ----------

   (1) ../../apis/user_0.html#user-0

   (2) ../../apis/expanding_0.html#expanding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: User-defined flags,  Prev: Other flags,  Up: Compiler flags

1.14.11.7 User-defined flags
............................

Logtalk provides a *note create_logtalk_flag/3: 2e6. predicate that can
be used for defining new flags.


File: TheLogtalkHandbook-3.100.1.info,  Node: Reloading source files,  Next: Batch processing,  Prev: Compiler flags,  Up: Writing and running applications

1.14.12 Reloading source files
------------------------------

As a general rule, reloading source files should never occur in
production code and should be handled with care in development code.
Reloading a Logtalk source file usually requires reloading the
intermediate Prolog file that is generated by the Logtalk compiler.  The
problem is that there is no standard behavior for reloading Prolog
files.  For static predicates, almost all Prolog compilers replace the
old definitions with the new ones.  However, for dynamic predicates, the
behavior depends on the Prolog compiler.  Most compilers replace the old
definitions, but some of them simply append the new ones, which usually
leads to trouble.  See the compatibility notes for the backend Prolog
compiler you intend to use for more information.  There is an additional
potential problem when using multi-threading programming.  Reloading a
threaded object does not recreate from scratch its old message queue,
which may still be in use (e.g., threads may be waiting on it).

When using library entities and stable code, you can avoid reloading the
corresponding source files (and, therefore, recompiling them) by setting
the *note reload: 2e3. compiler flag to ‘skip’.  For code under
development, you can turn off the *note clean: 292. flag to avoid
recompiling files that have not been modified since the last compilation
(assuming that backend Prolog compiler that you are using supports
retrieving file modification dates).  You can disable deleting the
intermediate files generated when compiling source files by changing the
default flag value in your settings file, by using the corresponding
compiler flag with the compiling and loading built-in predicates, or,
for the remaining of a working session, by using the call:

     | ?- set_logtalk_flag(clean, off).

Some caveats that you should be aware of.  First, some warnings that
might be produced when compiling a source file will not show up if the
corresponding object file is up-to-date because the source file is not
being (re)compiled.  Second, if you are using several Prolog compilers
with Logtalk, be sure to perform the first compilation of your source
files with the ‘clean’ flag turned off: the intermediate Prolog files
generated by the Logtalk compiler may not be compatible across Prolog
compilers or even for the same Prolog compiler across operating systems
(e.g., due to the use of different character encodings or end-of-line
characters).


File: TheLogtalkHandbook-3.100.1.info,  Node: Batch processing,  Next: Optimizing performance,  Prev: Reloading source files,  Up: Writing and running applications

1.14.13 Batch processing
------------------------

When doing batch processing, you probably want to turn off the *note
report: 2e0. flag to suppress all messages of type ‘banner’, ‘comment’,
‘comment(_)’, ‘warning’, and ‘warning(_)’ that are normally printed.
Note that error messages and messages providing information requested by
the user will still be printed.


File: TheLogtalkHandbook-3.100.1.info,  Node: Optimizing performance,  Next: Portable applications,  Prev: Batch processing,  Up: Writing and running applications

1.14.14 Optimizing performance
------------------------------

The default compiler flag settings are appropriate for the 'development'
but not necessarily for the 'deployment' of applications.  To minimize
the generated code size, turn the *note source_data: cc. flag off.  To
optimize runtime performance, turn on the *note optimize: 8c. flag.
Your chosen backend Prolog compiler may also provide performance-related
flags; check its documentation.

Pay special attention to file compilation/loading order.  Whenever
possible, compile and load your files by taking into account file
dependencies.  By default, the compiler will print a warning whenever a
file references an entity that is not yet loaded.  Solving these
warnings is key for optimal performance by enabling *note static
binding: 35. optimizations.  For a clear picture of file dependencies,
use the *note diagrams: 2ed. tool to generate a file dependency diagram
for your application.

Minimize the use of dynamic predicates.  Parametric objects can often be
used in alternative.  When dynamic predicates cannot be avoided, try to
make them private.  Declaring a dynamic predicate also as a private
predicate allows the compiler to optimize local calls to the database
methods (e.g., *note assertz/1: 1b3. and *note retract/1: 1b5.) that
modify the predicate.

Sending a *note message to self: 17d. implies *note dynamic binding: 36,
but there are often cases where *note (;;)/1: 5c. is misused to call an
imported or inherited predicate that is never going to be redefined in a
descendant.  In these cases, a *note super call: 115, *note (^^)/1: 5d,
can be used instead with the benefit of often enabling static binding.
Most of the guidelines for writing efficient Prolog code also apply to
Logtalk code.  In particular, define your predicates to take advantage
of first-argument indexing.  In the case of recursive predicates, define
them as tail-recursive predicates whenever possible.

See the *note section on performance: 38. for a detailed discussion on
Logtalk performance.


File: TheLogtalkHandbook-3.100.1.info,  Node: Portable applications,  Next: Conditional compilation,  Prev: Optimizing performance,  Up: Writing and running applications

1.14.15 Portable applications
-----------------------------

Logtalk is compatible with most modern standards-compliant Prolog
compilers.  However, this does not necessarily imply that your Logtalk
applications will have the same level of portability.  If possible, you
should only use in your applications Logtalk built-in predicates and ISO
Prolog-specified built-in predicates and arithmetic functions.  If you
need to use built-in predicates (or built-in arithmetic functions) that
may not be available in other Prolog compilers, you should try to
encapsulate the non-portable code in a small number of objects and
provide a portable 'interface' for that code through the use of Logtalk
protocols.  An example will be code that access operating-system
specific features.  The Logtalk compiler can warn you of the use of
non-ISO-specified built-in predicates and arithmetic functions by using
the *note portability: 1d1. compiler flag.


File: TheLogtalkHandbook-3.100.1.info,  Node: Conditional compilation,  Next: Avoiding common errors,  Prev: Portable applications,  Up: Writing and running applications

1.14.16 Conditional compilation
-------------------------------

Logtalk supports conditional compilation within source files using the
*note if/1: 2f2, *note elif/1: 2f3, *note else/0: 2f4, and *note
endif/0: 2f5. directives.  This support is similar to the support found
in several Prolog systems such as ECLiPSe, GNU Prolog, SICStus Prolog,
SWI-Prolog, XSB, and YAP.


File: TheLogtalkHandbook-3.100.1.info,  Node: Avoiding common errors,  Next: Coding style guidelines,  Prev: Conditional compilation,  Up: Writing and running applications

1.14.17 Avoiding common errors
------------------------------

Try to write objects and protocol documentation 'before' writing any
other code; if you are having trouble documenting a predicate, perhaps
you need to go back to the design stage.

Try to avoid lengthy hierarchies.  Composition is often a better choice
over inheritance for defining new objects (Logtalk supports
component-based programming through the use of *note categories: 109.).
In addition, prototype-based hierarchies are semantically simpler than
class-based hierarchies.

Dynamic predicates or dynamic entities are sometimes needed, but we
should always try to minimize the use of non-logical features such as
asserts and retracts.

Since each Logtalk entity is independently compiled, if an object
inherits a dynamic or a meta-predicate predicate, then the respective
directives must be repeated to ensure a correct compilation.

In general, Logtalk does not verify if a user predicate call/return
arguments comply with the declared modes.  On the other hand, Logtalk
built-in predicates, built-in methods, and message-sending control
structures are fully checked for calling mode errors.

Logtalk error handling strongly depends on the ISO compliance of the
chosen Prolog compiler.  For instance, the error terms that are
generated by some Logtalk built-in predicates assume that the Prolog
built-in predicates behave as defined in the ISO standard regarding
error conditions.  In particular, if your Prolog compiler does not
support a ‘read_term/3’ built-in predicate compliant with the ISO Prolog
Standard definition, then the current version of the Logtalk compiler
may not be able to detect misspelled variables in your source code.


File: TheLogtalkHandbook-3.100.1.info,  Node: Coding style guidelines,  Prev: Avoiding common errors,  Up: Writing and running applications

1.14.18 Coding style guidelines
-------------------------------

It is suggested that all code between an entity opening and closing
directives be indented by one tab stop.  When defining entity code, both
directives and predicates, Prolog coding style guidelines may be
applied.  All Logtalk source files, examples, and standard library
entities use tabs (the recommended setting is a tab width equivalent to
4 spaces) for laying out code.  Closely related entities can be defined
in the same source file.  However, for the best performance, is often
necessary to have an entity per source file.  Entities that might be
useful in different contexts (such as library entities) are best defined
in their own source files.

A detailed coding style guide is available at the Logtalk official
website.


File: TheLogtalkHandbook-3.100.1.info,  Node: Printing messages and asking questions,  Next: Term and goal expansion,  Prev: Writing and running applications,  Up: User Manual

1.15 Printing messages and asking questions
===========================================

Applications, components, and libraries often print all sorts of
messages.  These include banners, logging, debugging, and computation
results messages.  But also, in some cases, user interaction messages.
However, the authors of applications, components, and libraries often
cannot anticipate the context where their software will be used and thus
decide which and when messages should be displayed, suppressed, or
diverted.  Consider the different components in a Logtalk application
development and deployment.  At the base level, you have the Logtalk
compiler and runtime.  The compiler writes messages related to e.g.
compiling and loading files, compiling entities, and compilation
warnings and errors.  The runtime may write banner messages or throw
execution errors that may result in printing human-level messages.  The
development environment can be console-based, or you may be using a GUI
tool such as PDT. In the latter case, PDT needs to intercept the Logtalk
compiler and runtime messages to present the relevant information using
its GUI. Then you have all the other components in a typical
application.  For example, your own libraries and third-party libraries.
The libraries may want to print messages on their own, e.g.  banners,
debugging information, or logging information.  As you assemble all your
application components, you want to have the final word on which
messages are printed, where, and when.  Uncontrolled message printing by
libraries could potentially disrupt application flow, expose
implementation details, spam the user with irrelevant details, or break
user interfaces.

The solution is to decouple the calls to print a message from the actual
printing of the output text.  The same is true for calls to read user
input.  By decoupling the call to input some data from the actual read
of the data, we can easily switch from, for example, a command-line
interface to a GUI input dialog or even automate providing the data
(e.g., when automating testing of the user interaction).

Logtalk provides a solution based on the 'structured message printing
mechanism' that was introduced by Quintus Prolog, where it was
apparently implemented by Dave Bowen (thanks to Richard O’Keefe for the
historical bits).  This mechanism gives the programmer full control of
message printing, allowing it to filter, rewrite, or redirect any
message.  Variations of this mechanism can also be found in some Prolog
systems, including SICStus Prolog, SWI-Prolog, and YAP. Based on this
mechanism, Logtalk introduces an extension that also allows abstracting
asking a user for input.  Both mechanisms are implemented by the
logtalk(1) built-in object and described in this section.  The message
printing mechanism is extensively used by the Logtalk compiler itself
and by the developer tools.  The question-asking mechanism is used e.g.
in the *note debugger: 2fc. tool.

* Menu:

* Printing messages::
* Message tokenization::
* Meta-messages::
* Defining message prefixes and output streams::
* Defining message prefixes and output files::
* Intercepting messages::
* Asking questions::
* Intercepting questions::
* Multi-threading applications: Multi-threading applications<4>.

   ---------- Footnotes ----------

   (1) ../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Printing messages,  Next: Message tokenization,  Up: Printing messages and asking questions

1.15.1 Printing messages
------------------------

The main predicate for printing a message is *note
logtalk;;print_message/3: 2fe.  A simple example, using the Logtalk
runtime, is:

     | ?- logtalk::print_message(banner, core, banner).

     Logtalk 3.23.0
     Copyright (c) 1998-2018 Paulo Moura
     yes

The first argument of the predicate is the kind of message that we want
to print.  In this case, we use ‘banner’ to indicate that we are
printing a product name and copyright banner.  An extensive list of
message kinds is supported by default:

‘banner’

     banner messages (used e.g.  when loading tools or main application
     components; can be suppressed by setting the *note report: 2e0.
     flag to ‘warnings’ or ‘off’)

‘help’

     messages printed in reply to the user asking for help (mostly for
     helping port existing Prolog code)

‘information’ and ‘information(Group)’

     messages usually printed in reply to a user’s request for
     information

‘silent’ and ‘silent(Group)’

     not printed by default (but can be intercepted using the
     ‘message_hook/4’ predicate)

‘comment’ and ‘comment(Group)’

     useful but usually not essential messages (can be suppressed by
     setting the *note report: 2e0. flag to ‘warnings’ or ‘off’)

‘warning’ and ‘warning(Group)’

     warning messages (generated e.g.  by the compiler; can be
     suppressed by turning off the *note report: 2e0. flag)

‘error’ and ‘error(Group)’

     error messages (generated e.g.  by the compiler)

‘debug, debug(Group)’

     debugging messages (by default, only printed when the *note debug:
     2e2. flag is turned on; the ‘print_message/3’ goals for these
     messages are suppressed by the compiler when the *note optimize:
     8c. flag is turned on)

‘question, question(Group)’

     questions to a user

Using a compound term allows easy partitioning of messages of the same
kind in different groups.  Note that you can define your own alternative
message kind identifiers for your own components, together with suitable
definitions for their associated prefixes and output streams.

The second argument of ‘print_message/3’ represents the 'component'
defining the message being printed.  In this context, 'component' is a
generic term that can designate, e.g., a tool, a library, or some
sub-system in a large application.  In our example, the component name
is ‘core’, identifying the Logtalk compiler/runtime.  This argument was
introduced to provide multiple namespaces for message terms and thus
simplify programming-in-the-large by allowing easy filtering of all
messages from a specific component and also avoiding conflicts when two
components happen to define the same message term (e.g., ‘banner’).
Users should choose and use a unique name for a component, which usually
is the name of the component itself.  For example, all messages from the
*note lgtunit: 146. tool use ‘lgtunit’ for the component argument.  The
compiler and runtime are interpreted as a single component designated as
‘core’.

The third argument of ‘print_message/3’ is the message itself,
represented by a term.  In the above example, the message term is
‘banner’.  Using a term to represent a message instead of a string with
the message text itself has significant advantages.  Notably, it allows
using a compound term for easy parameterization of the message text and
simplifies machine processing, localization of applications, and message
interception.  For example:

     | ?- logtalk::print_message(comment, core, redefining_entity(object, foo)).

     % Redefining object foo
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Message tokenization,  Next: Meta-messages,  Prev: Printing messages,  Up: Printing messages and asking questions

1.15.2 Message tokenization
---------------------------

The use of message terms requires a solution for generating the actual
text of the messages.  This is supported by defining grammar rules for
the *note logtalk;;message_tokens//2: 300. multifile non-terminal, which
translates a message term, for a given component, to a list of tokens.
For example:

     :- multifile(logtalk::message_tokens//2).
     :- dynamic(logtalk::message_tokens//2).

     logtalk::message_tokens(redefining_entity(Type, Entity), core) -->
         ['Redefining ~w ~q'-[Type, Entity], nl].

The following tokens can be used when translating a message:

‘at_same_line’

     Signals a following part to a multi-part message with no line break
     in between; this token is ignored when it’s not the first in the
     list of tokens

‘tab(Expression)’

     Evaluate the argument as an arithmetic expression and write the
     resulting number of spaces; this token is ignored when the number
     of spaces is not positive

‘nl’

     Change line in the output stream

‘flush’

     Flush the output stream (by calling the ‘flush_output/1’ standard
     predicate)

‘Format-Arguments’

     ‘Format’ must be an atom and ‘Arguments’ must be a list of format
     arguments (the token arguments are passed to a call to the
     ‘format/3’ de facto standard predicate)

‘term(Term, Options)’

     ‘Term’ can be any term and ‘Options’ must be a list of valid
     ‘write_term/3’ output options (the token arguments are passed to a
     call to the ‘write_term/3’ standard predicate)

‘ansi(Attributes, Format, Arguments)’

     Taken from SWI-Prolog; by default, do nothing; can be used for
     styled output

‘begin(Kind, Var)’

     Taken from SWI-Prolog; by default, do nothing; can be used together
     with ‘end(Var)’ to wrap a sequence of message tokens

‘end(Var)’

     Taken from SWI-Prolog; by default, do nothing

The ‘logtalk’ object also defines public predicates for printing a list
of tokens, for hooking into printing an individual token, and for
setting default output streams and message prefixes.  For example, the
SWI-Prolog adapter file uses the print message token hook predicate to
enable coloring of messages printed on a console.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-messages,  Next: Defining message prefixes and output streams,  Prev: Message tokenization,  Up: Printing messages and asking questions

1.15.3 Meta-messages
--------------------

Defining tokenization rules for every message is not always necessary,
however.  Logtalk defines several 'meta-messages' that are handy for
simple cases and temporary messages only used during application
development, notably debugging messages.  See the *note Debugging
messages: 302. section and the logtalk built-in object(1) remarks
section for details.

   ---------- Footnotes ----------

   (1) ../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining message prefixes and output streams,  Next: Defining message prefixes and output files,  Prev: Meta-messages,  Up: Printing messages and asking questions

1.15.4 Defining message prefixes and output streams
---------------------------------------------------

The *note logtalk;;message_prefix_stream/4: 304. hook predicate can be
used to define a message line prefix and an output stream for printing
messages of a given kind and component.  For example:

     :- multifile(logtalk::message_prefix_stream/4).
     :- dynamic(logtalk::message_prefix_stream/4).

     logtalk::message_prefix_stream(comment, my_app, '% ', user_output).
     logtalk::message_prefix_stream(warning, my_app, '* ', user_error).

A single clause at most is expected per message kind and component pair.
When this predicate is not defined for a given kind and component pair,
the following defaults are used:

     kind_prefix_stream(banner,         '',       user_output).
     kind_prefix_stream(help,           '',       user_output).
     kind_prefix_stream(question,       '',       user_output).
     kind_prefix_stream(question(_),    '',       user_output).
     kind_prefix_stream(information,    '% ',     user_output).
     kind_prefix_stream(information(_), '% ',     user_output).
     kind_prefix_stream(comment,        '% ',     user_output).
     kind_prefix_stream(comment(_),     '% ',     user_output).
     kind_prefix_stream(warning,        '*     ', user_error).
     kind_prefix_stream(warning(_),     '*     ', user_error).
     kind_prefix_stream(error,          '!     ', user_error).
     kind_prefix_stream(error(_),       '!     ', user_error).
     kind_prefix_stream(debug,          '>>> ',   user_error).
     kind_prefix_stream(debug(_),       '>>> ',   user_error).

When the message kind is unknown, ‘information’ is used instead.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining message prefixes and output files,  Next: Intercepting messages,  Prev: Defining message prefixes and output streams,  Up: Printing messages and asking questions

1.15.5 Defining message prefixes and output files
-------------------------------------------------

Some applications require copying and saving messages without diverting
them from their default stream.  For simple cases, this can be
accomplished by intercepting the messages using the *note
logtalk;;message_hook/4: 306. multifile hook predicate (see next
section).  In more complex cases, where messages are already intercepted
for a different purpose, it can be tricky to use multiple definitions of
the ‘message_hook/4’ predicate as the order of the clauses of a multiple
predicate cannot be assumed in general (for all ‘message_hook/4’
predicate definitions to run, all but the last one to be called must
fail).  Using a single 'master' definition is also not ideal as it would
result in strong coupling instead of a clean separation of concerns.

The experimental *note logtalk;;message_prefix_file/6: 307. hook
predicate can be used to define a message line prefix and an output file
for copying messages of a given kind and component pair.  For example:

     :- multifile(logtalk::message_prefix_file/6).
     :- dynamic(logtalk::message_prefix_file/6).

     logtalk::message_prefix_file(error,   app, '! ', 'log.txt', append, []).
     logtalk::message_prefix_file(warning, app, '! ', 'log.txt', append, []).

A single clause at most is expected per message kind and component pair.

This predicate is called by default by the message printing mechanism.
Definitions of the ‘message_hook/4’ hook predicate are free to decide if
the ‘logtalk::message_prefix_file/6’ predicate should be called and
acted upon.


File: TheLogtalkHandbook-3.100.1.info,  Node: Intercepting messages,  Next: Asking questions,  Prev: Defining message prefixes and output files,  Up: Printing messages and asking questions

1.15.6 Intercepting messages
----------------------------

Calls to the *note logtalk;;print_message/3: 2fe. predicate can be
intercepted by defining clauses for the *note logtalk;;message_hook/4:
306. multifile hook predicate.  This predicate can suppress, rewrite,
and divert messages.

As a first example, assume that you want to make Logtalk startup less
verbose by suppressing printing of the default compiler flag values.
This can be easily accomplished by defining the following category in a
settings file:

     :- category(my_terse_logtalk_startup_settings).

         :- multifile(logtalk::message_hook/4).
         :- dynamic(logtalk::message_hook/4).

         logtalk::message_hook(default_flags, comment(settings), core, _).

     :- end_category.

The printing message mechanism automatically calls the ‘message_hook/4’
hook predicate.  When this call succeeds, the mechanism assumes that the
message has been successfully handled.

As another example, assume that you want to print all otherwise silent
compiler messages:

     :- category(my_verbose_logtalk_message_settings).

         :- multifile(logtalk::message_hook/4).
         :- dynamic(logtalk::message_hook/4).

         logtalk::message_hook(_Message, silent, core, Tokens) :-
             logtalk::message_prefix_stream(comment, core, Prefix, Stream),
             logtalk::print_message_tokens(Stream, Prefix, Tokens).

         logtalk::message_hook(_Message, silent(Key), core, Tokens) :-
             logtalk::message_prefix_stream(comment(Key), core, Prefix, Stream),
             logtalk::print_message_tokens(Stream, Prefix, Tokens).

     :- end_category.


File: TheLogtalkHandbook-3.100.1.info,  Node: Asking questions,  Next: Intercepting questions,  Prev: Intercepting messages,  Up: Printing messages and asking questions

1.15.7 Asking questions
-----------------------

Logtalk 'structured question-asking' mechanism complements the message
printing mechanism.  It provides an abstraction for the common task of
asking a user a question and reading back its reply.  By default, this
mechanism writes the question, writes a prompt, and reads the answer
using the current user input and output streams but allows all steps to
be intercepted, filtered, rewritten, and redirected.  Two typical
examples are using a GUI dialog for asking questions and automatically
providing answers to specific questions.

The question-asking mechanism works in tandem with the message printing
mechanism, using it to print the question text and a prompt.  It
provides an asking predicate and a hook predicate, both declared and
defined in the ‘logtalk’ built-in object.  The asking predicate, *note
logtalk;;ask_question/5: 30b, is used for asking a question and reading
the answer.  Assume that we defined the following message tokenization
and question prompt and stream:

     :- category(hitchhikers_guide_to_the_galaxy).

         :- multifile(logtalk::message_tokens//2).
         :- dynamic(logtalk::message_tokens//2).

         % abstract the question text using the atom ultimate_question;
         % the second argument, hitchhikers, is the application component
         logtalk::message_tokens(ultimate_question, hitchhikers) -->
             ['The answer to the ultimate question of life, the universe and everything is?'-[], nl].

        :- multifile(logtalk::question_prompt_stream/4).
        :- dynamic(logtalk::question_prompt_stream/4).

        % the prompt is specified here instead of being part of the question text
        % as it will be repeated if the answer doesn't satisfy the question closure
        logtalk::question_prompt_stream(question, hitchhikers, '> ', user_input).

     :- end_category.

After compiling and loading this category, we can now ask the ultimate
question:

     | ?- logtalk::ask_question(question, hitchhikers, ultimate_question, '=='(42), N).

     The answer to the ultimate question of life, the universe and everything is?
     > 42.

     N = 42
     yes

Note that the fourth argument, ‘'=='(42)’ in our example, is a *note
closure: 14f. that is used to check the answers provided by the user.
The question is repeated until the goal constructed by extending the
closure with the user answer succeeds.  For example:

     | ?- logtalk::ask_question(question, hitchhikers, ultimate_question, '=='(42), N).
     The answer to the ultimate question of life, the universe and everything is?
     > icecream.
     > tea.
     > 42.

     N = 42
     yes

Practical usage examples of this mechanism can be found, e.g., in the
‘debugger’ tool where it’s used to abstract the user interaction when
tracing a goal execution in debug mode.


File: TheLogtalkHandbook-3.100.1.info,  Node: Intercepting questions,  Next: Multi-threading applications<4>,  Prev: Asking questions,  Up: Printing messages and asking questions

1.15.8 Intercepting questions
-----------------------------

Calls to the *note logtalk;;ask_question/5: 30b. predicate can be
intercepted by defining clauses for the *note logtalk;;question_hook/6:
30d. multifile hook predicate.  This predicate can suppress, rewrite,
and divert questions.  For example, assume that we want to automate
testing and thus cannot rely on someone manually providing answers:

     :- category(hitchhikers_fixed_answers).

         :- multifile(logtalk::question_hook/6).
         :- dynamic(logtalk::question_hook/6).

         logtalk::question_hook(ultimate_question, question, hitchhikers, _, _, 42).

     :- end_category.

After compiling and loading this category, trying the question again
will now skip asking the user:

     | ?- logtalk::ask_question(question, hitchhikers, ultimate_question, '=='(42), N).

     N = 42
     yes

In a practical case, the fixed answer would be used for follow-up goals
being tested.  The question-answer read loop (which calls the question
check closure) is not used when a fixed answer is provided using the
‘logtalk::question_hook/6’ predicate thus preventing the creation of
endless loops.  For example, the following query succeeds:

     | ?- logtalk::ask_question(question, hitchhikers, ultimate_question, '=='(41), N).

     N = 42
     yes

Note that the ‘logtalk::question_hook/6’ predicate takes as argument the
closure specified in the ‘logtalk::ask_question/5’ call, allowing a
fixed answer to be checked before being returned.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading applications<4>,  Prev: Intercepting questions,  Up: Printing messages and asking questions

1.15.9 Multi-threading applications
-----------------------------------

When writing multi-threading applications, user-defined predicates
calling methods such as ‘print_message/3’ or ‘ask_question/5’ may need
to be declared synchronized in order to avoid race conditions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Term and goal expansion,  Next: Documenting,  Prev: Printing messages and asking questions,  Up: User Manual

1.16 Term and goal expansion
============================

Logtalk supports a 'term and goal expansion mechanism' that can be used
to define source-to-source transformations.  Two common uses are the
definition of language extensions and domain-specific languages.

Logtalk improves upon the term-expansion mechanism found on some Prolog
systems by providing the user with fine-grained control on 'if', 'when',
and 'how' expansions are applied.  It allows declaring in a source file
itself which expansions, if any, will be used when compiling it.  It
allows declaring which expansions will be used when compiling a file
using compile and loading predicate options.  It also allows defining a
default expansion for all source files.  It defines a concept of 'hook
objects' that can be used as building blocks to create custom and
reusable 'expansion workflows' with explicit and well-defined semantics.
It prevents the simple act of loading expansion rules affecting
subsequent compilation of files.  It prevents conflicts between groups
of expansion rules of different origins.  It avoids a set of buggy
expansion rules from breaking other sets of expansion rules.

* Menu:

* Defining expansions::
* Expanding grammar rules::
* Bypassing expansions::
* Hook objects::
* Virtual source file terms and loading context::
* Default compiler expansion workflow::
* User defined expansion workflows::
* Using Prolog defined expansions::
* Debugging expansions::


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining expansions,  Next: Expanding grammar rules,  Up: Term and goal expansion

1.16.1 Defining expansions
--------------------------

Term and goal expansions are defined using, respectively, the predicates
*note term_expansion/2: fc. and *note goal_expansion/2: fd, which are
declared in the expanding(1) built-in protocol.  Note that, unlike
Prolog systems also providing these two predicates, they are 'not'
declared as *note multifile predicates: 16b. in the protocol.  This
design decision is key for giving the programmer full control of the
expansion process and preventing the problems inflicting most of the
Prolog systems that provide a term-expansion mechanism.

An example of an object defining expansion rules:

     :- object(an_object,
         implements(expanding)).

         term_expansion(ping, pong).
         term_expansion(
             colors,
             [white, yellow, blue, green, read, black]
         ).

         goal_expansion(a, b).
         goal_expansion(b, c).
         goal_expansion(X is Expression, true) :-
             catch(X is Expression, _, fail).

     :- end_object.

These predicates can be explicitly called using the *note expand_term/2:
1b7. and *note expand_goal/2: 312. built-in methods or called
automatically by the compiler when compiling a source file (see the
section below on 'hook objects').

In the case of source files referenced in *note include/1: b8.
directives, expansions are only applied automatically when the
directives are found in source files, not when used as arguments in the
*note create_object/4: 62, *note create_protocol/3: e3, and *note
create_category/4: 11a, predicates.  This restriction prevents
inconsistent results when, for example, an expansion is defined for a
predicate with clauses found in both an included file and as argument in
a call to the ‘create_object/4’ predicate.

Clauses for the ‘term_expansion/2’ predicate are called until one of
them succeeds.  The returned expansion can be a single term or a list of
terms (including the empty list).  For example:

     | ?- an_object::expand_term(ping, Term).

     Term = pong
     yes

     | ?- an_object::expand_term(colors, Colors).

     Colors = [white, yellow, blue, green, read, black]
     yes

When no ‘term_expansion/2’ clause applies, the same term that we are
trying to expand is returned:

     | ?- an_object::expand_term(sounds, Sounds).

     Sounds = sounds
     yes

Clauses for the ‘goal_expansion/2’ predicate are recursively called on
the expanded goal until a fixed point is reached.  For example:

     | ?- an_object::expand_goal(a, Goal).

     Goal = c
     yes

     | ?- an_object::expand_goal(X is 3+2*5, Goal).

     X = 13,
     Goal = true
     yes

When no ‘goal_expansion/2’ clause applies, the same goal that we are
trying to expand is returned:

     | ?- an_object::expand_goal(3 =:= 5, Goal).

     Goal = (3=:=5)
     yes

The goal-expansion mechanism prevents an infinite loop when expanding a
goal by checking that a goal to be expanded was not the result from a
previous expansion of the same goal.  For example, consider the
following object:

     :- object(fixed_point,
         implements(expanding)).

         goal_expansion(a, b).
         goal_expansion(b, c).
         goal_expansion(c, (a -> b; c)).

     :- end_object.

The expansion of the goal ‘a’ results in the goal ‘(a -> b; c)’ with no
attempt to further expand the ‘a’, ‘b’, and ‘c’ goals as they have
already been expanded.

Goal-expansion applies to goal arguments of control constructs,
meta-arguments in built-in or ‘user’ defined meta-predicates,
meta-arguments in local user-defined meta-predicates, meta-arguments in
meta-predicate messages when static binding is possible, and
‘initialization/1’, ‘if/1’, and ‘elif/1’ directives.

   ---------- Footnotes ----------

   (1) ../../apis/expanding_0.html#expanding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Expanding grammar rules,  Next: Bypassing expansions,  Prev: Defining expansions,  Up: Term and goal expansion

1.16.2 Expanding grammar rules
------------------------------

A common term expansion is the translation of grammar rules into
predicate clauses.  This transformation is performed automatically by
the compiler when a source file entity defines grammar rules.  It can
also be done explicitly by calling the ‘expand_term/2’ built-in method.
For example:

     | ?- logtalk::expand_term((a --> b, c), Clause).

     Clause = (a(A,B) :- b(A,C), c(C,B))
     yes

Note that the default translation of grammar rules can be overridden by
defining clauses for the *note term_expansion/2: fc. predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: Bypassing expansions,  Next: Hook objects,  Prev: Expanding grammar rules,  Up: Term and goal expansion

1.16.3 Bypassing expansions
---------------------------

Terms and goals wrapped by the *note {}/1: 191. control construct are
not expanded.  For example:

     | ?- an_object::expand_term({ping}, Term).

     Term = {ping}
     yes

     | ?- an_object::expand_goal({a}, Goal).

     Goal = {a}
     yes

This also applies to source file terms and source file goals when using
hook objects (discussed next).


File: TheLogtalkHandbook-3.100.1.info,  Node: Hook objects,  Next: Virtual source file terms and loading context,  Prev: Bypassing expansions,  Up: Term and goal expansion

1.16.4 Hook objects
-------------------

Term and goal expansion of a source file during its compilation is
performed by using 'hook objects'.  A hook object is simply an object
implementing the expanding(1) built-in protocol and defining clauses for
the term and goal expansion hook predicates.  Hook objects must be
compiled and loaded prior to being used to expand a source file.

To compile a source file using a hook object, we can use the *note hook:
fe. compiler flag in the second argument of the *note logtalk_compile/2:
2b2. and *note logtalk_load/2: 4e. built-in predicates.  For example:

     | ?- logtalk_load(source_file, [hook(hook_object)]).
     ...

In alternative, we can use a *note set_logtalk_flag/2: 50. directive in
the source file itself.  For example:

     :- set_logtalk_flag(hook, hook_object).

To use multiple hook objects in the same source file, simply write each
directive before the block of code that it should handle.  For example:

     :- object(h1,
         implements(expanding)).

         term_expansion((:- public(a/0)), (:- public(b/0))).
         term_expansion(a, b).

     :- end_object.

     :- object(h2,
         implements(expanding)).

         term_expansion((:- public(a/0)), (:- public(c/0))).
         term_expansion(a, c).

     :- end_object.

     :- set_logtalk_flag(hook, h1).

     :- object(s1).

         :- public(a/0).
         a.

     :- end_object.


     :- set_logtalk_flag(hook, h2).

     :- object(s2).

         :- public(a/0).
         a.

     :- end_object.

     | ?- {h1, h2, s}.
     ...

     | ?- s1::b.
     yes

     | ?- s2::c.
     yes

It is also possible to define a default hook object by defining a global
value for the ‘hook’ flag by calling the *note set_logtalk_flag/2: 51.
predicate.  For example:

     | ?- set_logtalk_flag(hook, hook_object).

     yes

Note that, due to the ‘set_logtalk_flag/2’ directive being local to a
source file, using it to specify a hook object will override any defined
default hook object or any hook object specified as a
‘logtalk_compile/2’ or ‘logtalk_load/2’ predicate compiler option for
compiling or loading the source file.

     Note: Clauses for the ‘term_expansion/2’ and ‘goal_expansion/2’
     predicates defined within an object or a category are never used in
     the compilation of the object or the category itself.

   ---------- Footnotes ----------

   (1) ../../apis/expanding_0.html#expanding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Virtual source file terms and loading context,  Next: Default compiler expansion workflow,  Prev: Hook objects,  Up: Term and goal expansion

1.16.5 Virtual source file terms and loading context
----------------------------------------------------

When using a hook object to expand the terms of a source file, two
virtual file terms are generated: ‘begin_of_file’ and ‘end_of_file’.
These terms allow the user to define term-expansions before and after
the actual source file terms.

Logtalk also provides a *note logtalk_load_context/2: 317. built-in
predicate that can be used to access the compilation/loading context
when performing expansions.  The *note logtalk: d1. built-in object also
provides a set of predicates that can be useful, notably when adding
Logtalk support for language extensions originally developed for Prolog.

As an example of using the virtual terms and the
‘logtalk_load_context/2’ predicate, assume that you want to convert
plain Prolog files to Logtalk by wrapping the Prolog code in each file
using an object (named after the file) that implements a given protocol.
This could be accomplished by defining the following hook object:

     :- object(wrapper(_Protocol_),
         implements(expanding)).

         term_expansion(begin_of_file, (:- object(Name,implements(_Protocol_)))) :-
             logtalk_load_context(file, File),
             os::decompose_file_name(File,_ , Name, _).

         term_expansion(end_of_file, (:- end_object)).

     :- end_object.

Assuming, e.g., ‘my_car.pl’ and ‘lease_car.pl’ files to be wrapped and a
‘car_protocol’ protocol, we could then load them using:

     | ?- logtalk_load(
              ['my_car.pl', 'lease_car.pl'],
              [hook(wrapper(car_protocol))]
          ).

     yes

     Note: When a source file also contains plain Prolog directives and
     predicates, these are term-expanded but not goal-expanded (with the
     exception of the ‘initialization/1’, ‘if/1’, and ‘elif/1’
     directives, where the goal argument is expanded to improve code
     portability across backends).


File: TheLogtalkHandbook-3.100.1.info,  Node: Default compiler expansion workflow,  Next: User defined expansion workflows,  Prev: Virtual source file terms and loading context,  Up: Term and goal expansion

1.16.6 Default compiler expansion workflow
------------------------------------------

When *note compiling a source file: 29b, the compiler will first try, by
default, the source file-specific hook object specified using a local
‘set_logtalk_flag/2’ directive, if defined.  If that expansion fails, it
tries the hook object specified using the ‘hook/1’ compiler option in
the ‘logtalk_compile/2’ or ‘logtalk_load/2’ goal that compiles or loads
the file, if defined.  If that expansion fails, it tries the default
hook object, if defined.  If that expansion also fails, the compiler
tries the Prolog dialect-specific expansion rules found in the *note
adapter file: 154. (which are used to support non-standard Prolog
features).


File: TheLogtalkHandbook-3.100.1.info,  Node: User defined expansion workflows,  Next: Using Prolog defined expansions,  Prev: Default compiler expansion workflow,  Up: Term and goal expansion

1.16.7 User defined expansion workflows
---------------------------------------

Sometimes we have multiple hook objects that we need to combine and use
in the compilation of a source file.  Logtalk includes a *note
hook_flows: 31a. library that supports two basic expansion workflows: a
pipeline(1) of hook objects, where the expansion results from a hook
object are fed to the next hook object in the pipeline, and a set(2) of
hook objects, where expansions are tried until one of them succeeds.
These workflows are implemented as parametric objects, allowing
combining them to implement more sophisticated expansion workflows.
There is also a *note hook_objects: 31b. library that provides
convenient hook objects for defining custom expansion workflows.  This
library includes a hook object that can be used to restore the default
expansion workflow used by the compiler.

For example, assuming that you want to apply the Prolog backend-specific
expansion rules defined in its adapter file, using the
backend_adapter_hook(3) library object, passing the resulting terms to
your own expansion when compiling a source file, we could use the goal:

     | ?- logtalk_load(
              source,
              [hook(hook_pipeline([backend_adapter_hook, my_expansion]))]
          ).

As a second example, we can prevent expansion of a source file using the
library object identity_hook(4) by adding as the first term in a source
file the directive:

     :- set_logtalk_flag(hook, identity_hook).

The file will be compiled as-is as any hook object (specified as a
compiler option or as a default hook object) and any backend adapter
expansion rules are overridden by the directive.

   ---------- Footnotes ----------

   (1) ../../apis/hook_pipeline_1.html#hook-pipeline-1

   (2) ../../apis/hook_set_1.html#hook-set-1

   (3) ../../apis/backend_adapter_hook_0.html#backend-adapter-hook-0

   (4) ../../apis/identity_hook_0.html#identity-hook-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Using Prolog defined expansions,  Next: Debugging expansions,  Prev: User defined expansion workflows,  Up: Term and goal expansion

1.16.8 Using Prolog defined expansions
--------------------------------------

In order to use clauses for the ‘term_expansion/2’ and
‘goal_expansion/2’ predicates defined in plain Prolog, simply specify
the pseudo-object ‘user’ as the hook object when compiling source files.
When using *note backend Prolog compilers: 34. that support a module
system, it can also be specified a module containing clauses for the
expanding predicates as long as the module name doesn’t coincide with an
object name.  When defining a custom workflow, the library object
prolog_module_hook/1(1) can be used as a workflow step.  For example,
assuming a module ‘functions’ defining expansion rules that we want to
use:

     | ?- logtalk_load(
              source,
              [hook(hook_set([prolog_module_hook(functions), my_expansion]))]
          ).

But note that Prolog module libraries may provide definitions of the
expansion predicates that are not compatible with the Logtalk compiler.
In particular, when setting the hook object to ‘user’, be aware of any
Prolog library that is loaded, possibly by default or implicitly by the
Prolog system, that may be contributing definitions of the expansion
predicates.  It is usually safer to define a specific hook object for
combining multiple expansions in a fully controlled way.

     Note: The ‘user’ object declares ‘term_expansion/2’ and
     ‘goal_expansion/2’ as multifile and dynamic predicates.  This helps
     in avoiding predicate existence errors when compiling source files
     with the ‘hook’ flag set to ‘user’ as these predicates are only
     natively declared by some of the supported backend Prolog
     compilers.

   ---------- Footnotes ----------

   (1) ../../apis/prolog_module_hook_1.html#prolog-module-hook-1


File: TheLogtalkHandbook-3.100.1.info,  Node: Debugging expansions,  Prev: Using Prolog defined expansions,  Up: Term and goal expansion

1.16.9 Debugging expansions
---------------------------

The ‘term_expansion/2’ and ‘goal_expansion/2’ predicates can be *note
debugged: 47. like any other object predicates.  Note that expansions
can often be manually tested by sending *note expand_term/2: 1b7. and
*note expand_goal/2: 312. messages to a hook object with the term or
goal whose expansion you want to check as argument.  An alternative to
the debugging tools is to use a *note monitor: 31e. for the runtime
messages that call the predicates.  For example, assume a
‘expansions_debug.lgt’ file with the contents:

     :- initialization(
         define_events(after, edcg, _, _, expansions_debug)
     ).


     :- object(expansions_debug,
         implements(monitoring)).

         after(edcg, term_expansion(T,E), _) :-
             writeq(term_expansion(T,E)), nl.

     :- end_object.

We can use this monitor to help debug the expansion rules of the *note
edcg: 31f. library when applied to the ‘edcgs’ example using the
queries:

     | ?- {expansions_debug}.
     ...

     | ?- set_logtalk_flag(events, allow).
     yes

     | ?- {edcgs(loader)}.
     ...
     term_expansion(begin_of_file,begin_of_file)
     term_expansion((:-object(gemini)),[(:-object(gemini)),(:-op(1200,xfx,-->>))])
     term_expansion(acc_info(castor,A,B,C,true),[])
     term_expansion(pass_info(pollux),[])
     term_expansion(pred_info(p,1,[castor,pollux]),[])
     term_expansion(pred_info(q,1,[castor,pollux]),[])
     term_expansion(pred_info(r,1,[castor,pollux]),[])
     term_expansion((p(A)-->>B is A+1,q(B),r(B)),(p(A,C,D,E):-B is A+1,q(B,C,F,E),r(B,F,D,E)))
     term_expansion((q(A)-->>[]),(q(A,B,B,C):-true))
     term_expansion((r(A)-->>[]),(r(A,B,B,C):-true))
     term_expansion(end_of_file,end_of_file)
     ...

This solution does not require compiling the ‘edcg’ hook object in debug
mode or access to its source code (e.g., to modify its expansion rules
to emit debug messages).  We could also simply use the ‘user’
pseudo-object as the monitor object:

     | ?- assertz((
              after(_, term_expansion(T,E), _) :-
                 writeq(term_expansion(T,E)), nl
          )).
     yes

     | ?- define_events(after, edcg, _, Sender, user).
     yes

Another alternative is to use a pipeline of hook objects with the
library ‘hook_pipeline/1’ and ‘write_to_stream_hook’ objects to write
the expansion results to a file.  For example, using the ‘unique.lgt’
test file from the ‘edcgs’ library directory:

     | ?- {hook_flows(loader), hook_objects(loader)}.
     ...

     | ?- open('unique_expanded.lgt', write, Stream),
          logtalk_compile(
              unique,
              [hook(hook_pipeline([edcg,write_to_stream_hook(Stream,[quoted(true)])]))]
          ),
          close(Stream).
     ...

The generated ‘unique_expanded.lgt’ file will contain the clauses
resulting from the expansion of the EDCG rules found in the ‘unique.lgt’
file by the ‘edcg’ hook object expansion.


File: TheLogtalkHandbook-3.100.1.info,  Node: Documenting,  Next: Debugging,  Prev: Term and goal expansion,  Up: User Manual

1.17 Documenting
================

Assuming that the *note source_data: cc. flag is turned on, the compiler
saves all relevant documenting information collected when compiling a
source file.  The provided *note lgtdoc: 322. tool can access this
information by using the *note reflection: 48. support and generate a
documentation file for each compiled entity (object, protocol, or
category) in XML format.  Contents of the XML file include the entity
name, type, and compilation mode (static or dynamic), the entity
relations with other entities, and a description of any declared
predicates (name, compilation mode, scope, …).  The XML documentation
files can be enriched with arbitrary user-defined information, either
about an entity or about its predicates, by using documentation
directives.  The ‘lgtdoc’ tool includes POSIX and Windows scripts for
converting the XML documentation files to several final formats (such as
HTML and PDF).

Logtalk supports two documentation directives for providing arbitrary
user-defined information about an entity or a predicate.  These two
directives complement other directives that also provide important
documentation information, such as the *note mode/2: 149. and *note
meta_predicate/1: 152. directives.

* Menu:

* Entity documenting directives::
* Predicate documenting directives::
* Describing predicates::
* Documenting predicate exceptions::
* Processing and viewing documenting files::
* Inline formatting in comments text::
* Diagrams::


File: TheLogtalkHandbook-3.100.1.info,  Node: Entity documenting directives,  Next: Predicate documenting directives,  Up: Documenting

1.17.1 Entity documenting directives
------------------------------------

Arbitrary user-defined entity information can be represented using the
*note info/1: b4. directive:

     :- info([
         Key1 is Value1,
         Key2 is Value2,
         ...
     ]).

In this pattern, keys should be atoms and values should be bound terms.
The following keys are predefined and may be processed specially by
Logtalk tools:

‘comment’

     Comment describing the entity purpose (an atom).  End the comment
     with a period (full stop).  As a style guideline, don’t use overly
     long comments.  If you need to provide additional details, use the
     ‘fails_if’ and ‘remarks’ keys.

‘author’

     Entity author(s) (an atom or a compound term ‘{entity}’ where
     ‘entity’ is the name of an XML entity in a user-defined
     ‘custom.ent’ file).

‘version’

     Version number (a ‘Major:Minor:Patch’ compound term) Following the
     Semantic Versioning guidelines(1) is strongly advised.

‘date’

     Date of last modification in ISO 8601 standard format
     (‘Year-Month-Day’ where ‘Year’, ‘Month’, and ‘Day’ are integers).

‘parameters’

     Parameter names and descriptions for parametric entities (a list of
     ‘Name-Description’ pairs where both names and descriptions are
     atoms).  End the ‘Description’ with a period (full stop).

‘parnames’

     Parameter names for parametric entities (a list of atoms; a simpler
     version of the previous key, used when parameter descriptions are
     deemed unnecessary).

‘copyright’

     Copyright notice for the entity source code (an atom or a compound
     term ‘{entity}’ where ‘entity’ is the name of an XML entity defined
     in a user-defined ‘custom.ent’ file).

‘license’

     License terms for the entity source code; usually, just the license
     name (an atom or a compound term ‘{entity}’ where ‘entity’ is the
     name of an XML entity in a user-defined ‘custom.ent’ file).
     License names should, whenever possible, be a license identifier as
     specified in the SPDX standard(2).

‘remarks’

     List of general remarks about the entity using ‘Topic-Text’ pairs
     where both the topic and the text must be atoms.  End the ‘Text’
     with a period (full stop).

‘see_also’

     List of related entities (using the entity identifiers, which can
     be atoms or compound terms).

For example:

     :- info([
         version is 2:1:0,
         author is 'Paulo Moura',
         date is 2000-11-20,
         comment is 'Building representation.',
         diagram is 'UML Class Diagram #312'
     ]).

Use only the keywords that make sense for your application, and remember
that you are free to invent your own keywords.  All key-value pairs can
be retrieved programmatically using the *note reflection API: 48. and
are visible to the *note lgtdoc: 322. tool (which includes them in the
generated documentation).

   ---------- Footnotes ----------

   (1) https://semver.org

   (2) https://spdx.org/licenses/


File: TheLogtalkHandbook-3.100.1.info,  Node: Predicate documenting directives,  Next: Describing predicates,  Prev: Entity documenting directives,  Up: Documenting

1.17.2 Predicate documenting directives
---------------------------------------

Arbitrary user-defined predicate information can be represented using
the *note info/2: 168. directive:

     :- info(Name/Arity, [
         Key1 is Value1,
         Key2 is Value2,
         ...
     ]).

The first argument can also a grammar rule non-terminal indicator,
‘Name//Arity’.  Keys should be atoms.  Values should be bound terms.
The following keys are predefined and may be processed specially by
Logtalk tools:

‘comment’

     Comment describing the predicate (or non-terminal) purpose (an
     atom).  End the comment with a period (full stop).  As a style
     guideline, don’t use overly long comments.  If you need to provide
     additional details, use the ‘remarks’ key.

‘fails_if’

     Comment describing failing conditions for the predicate.  As a
     style guideline, don’t use overly long comments.  If you need to
     provide additional details, use the ‘remarks’ key.

‘arguments’

     Names and descriptions of predicate arguments for pretty print
     output (a list of ‘Name-Description’ pairs where both names and
     descriptions are atoms).  End the ‘Description’ with a period (full
     stop).

‘argnames’

     Names of predicate arguments for pretty print output (a list of
     atoms; a simpler version of the previous key, used when argument
     descriptions are deemed unnecessary).

‘allocation’

     Objects where we should define the predicate.  Some possible values
     are ‘container’, ‘descendants’, ‘instances’, ‘classes’,
     ‘subclasses’, and ‘any’.

‘redefinition’

     Describes if a predicate is expected to be redefined and, if so, in
     what way.  Some possible values are ‘never’, ‘free’, ‘specialize’,
     ‘call_super_first’, ‘call_super_last’.

‘exceptions’

     List of possible exceptions thrown by the predicate using
     ‘Description-Exception’ pairs.  The description must be an atom.
     The exception term must be a ground term.

‘examples’

     List of typical predicate call examples using the format
     ‘Description-Goal-Bindings’.  The description must be an atom with
     the goal term sharing variables with the bindings.  The variable
     bindings term uses the format ‘{Variable = Term, ...}’.  When there
     are no variable bindings, the success or failure of the predicate
     call should be represented by the terms ‘{true}’ or ‘{false}’,
     respectively (you can also use in alternative the terms ‘{yes}’ or
     ‘{no}’).

‘remarks’

     List of general remarks about the predicate using ‘Topic-Text’
     pairs where both the topic and the text must be atoms.  End the
     ‘Text’ with a period (full stop).

‘since’

     Version that added the predicate (‘Major:Minor:Patch’).

‘see_also’

     List of related predicates and non-terminals (using the predicate
     and non-terminal indicators).

For example:

     :- info(color/1, [
         comment is 'Table of defined colors.',
         argnames is ['Color'],
         constraint is 'Up to four visible colors allowed.',
         examples is [
            'Check that the color blue is defined' - color(blue) - {true}
         ]
     ]).

As with the ‘info/1’ directive, use only the keywords that make sense
for your application and remember that you are free to invent your own
keywords.  All key-value pairs can also be retrieved programmatically
using the *note reflection API: 48. and are visible to the *note lgtdoc:
322. tool (which includes them in the generated documentation).


File: TheLogtalkHandbook-3.100.1.info,  Node: Describing predicates,  Next: Documenting predicate exceptions,  Prev: Predicate documenting directives,  Up: Documenting

1.17.3 Describing predicates
----------------------------

The value of the ‘comment’ key, possibly extended with the ‘remarks’
key, should describe a predicate purpose and, when applicable, the
circumstances under which a call may fail.  Descriptions should be
consistent across library and application APIs.  Some guidelines:

1.  When starting the description with a verb, use the 'third-person
singular simple present form'.  For example, write ‘'Runs ...'’, ‘'Calls
...'’, ‘'Compares ...'’, ‘'Parses ...'’, ‘'Generates ...'’, ‘'Converts
...'’, ‘'Creates ...'’, ‘'Maps ...'’, ‘'Merges ...'’, ‘'Finds ...'’,
etc.

2.  Predicates that are pure logical relations often have descriptions
starting with ‘'True iff ...'’ or ‘'True if ...'’.

3.  Predicates with multiple solutions often have descriptions starting
with ‘'Enumerates, by backtracking, all ...'’ or ‘'Enumerates, by
backtracking, the ...'’.

4.  Predicate call failure conditions often have descriptions with one
or more sentences starting with ‘'Fails when ...'’ or ‘'Fails if ...'’.

If you’re not sure how best to describe a predicate, look for examples
in the Logtalk libraries and developer tools APIs documentation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Documenting predicate exceptions,  Next: Processing and viewing documenting files,  Prev: Describing predicates,  Up: Documenting

1.17.4 Documenting predicate exceptions
---------------------------------------

As described above, the ‘info/2’ predicate directive supports an
‘exceptions’ key that allows us to list all exceptions that may occur
when calling a predicate.  For example:

     :- info(check_option/1, [
         comment is 'Succeeds if the option is valid. Throws an error otherwise.',
         argnames is ['Option'],
         exceptions is [
             '``Option`` is a variable' - instantiation_error,
             '``Option`` is neither a variable nor a compound term' - type_error(compound, 'Option'),
             '``Option`` is a compound term but not a valid option' - domain_error(option, 'Option')
         ]
     ]).

When possible, only standard exceptions should be used.  See e.g.  the
*note error handling methods: 24c. section for a full list.  The
argument names should be the same as those provided in the ‘arguments’
or ‘argnames’ keys.  Exceptions are usually listed starting with
instantiation and uninstantiation errors, followed by type errors, and
then domain errors.  These may then be followed by permission,
existence, evaluation, representation, or resource errors.

For each exception, use of 'controlled language' as found, e.g., in the
ISO Prolog Core standard and this Handbook is advised.  Some examples:

Instantiation error when one or more arguments cannot be a variable

     ‘Argument’ is a variable

     ‘Argument1’ and ‘Argument2’ are variables

Instantiation error when a closed list with bound elements is required

     ‘Argument’ is a partial list or a list with an element ‘Element’
     which is a variable

Uninstantiation error when an argument is not a variable

     ‘Argument’ is not a variable

Type error when an argument is not a variable but also not of the expected type

     ‘Argument’ is neither a variable nor a TYPE

     ‘Argument’ is neither a partial list nor a list

Type error when an element of a list is not a variable but is not of the expected type

     An element ‘Element’ of the ‘Argument’ list is neither a variable
     nor a TYPE

Domain error when an argument is of the correct type but not in the expected domain

     ‘Argument’ is a TYPE but not a valid DOMAIN

     ‘Argument’ is an integer that is less than zero

Domain error when an element of a list is of the correct type but not in the expected domain

     An element ‘Element’ of the ‘Argument’ list is a TYPE but not a
     valid DOMAIN

Existence error when an entity of a given kind does not exist

     The KIND ‘Argument’ does not exist

Other classes of errors have a less rigid style.  In case of doubt, look
for examples in this Handbook, in the APIs documentation, and in
standard documents.


File: TheLogtalkHandbook-3.100.1.info,  Node: Processing and viewing documenting files,  Next: Inline formatting in comments text,  Prev: Documenting predicate exceptions,  Up: Documenting

1.17.5 Processing and viewing documenting files
-----------------------------------------------

The *note lgtdoc: 322. tool generates an XML documenting file per
entity.  It can also generate library, directory, entity, and predicate
indexes when documenting libraries and directories.  For example,
assuming the default filename extensions, a ‘trace’ object and a
‘sort(_)’ parametric object will result in ‘trace_0.xml’ and
‘sort_1.xml’ XML files.

Each entity XML file contains references to two other files, an XML
specification file and a XSLT stylesheet file.  The XML specification
file can be either a DTD file (‘logtalk_entity.dtd’) or an XML Scheme
file (‘logtalk_entity.xsd’).  The XSLT stylesheet file is responsible
for converting the XML files to some desired format such as HTML or PDF.
The default names for the XML specification file and the XSL stylesheet
file are defined by the *note lgtdoc: 322. tool but can be overridden by
passing a list of options to the tool predicates.  The ‘lgtdoc/xml’
sub-directory in the Logtalk installation directory contains the XML
specification files described above, along with several sample XSL
stylesheet files and sample scripts for converting XML documenting files
to several formats (e.g., reStructuredText, Markdown, HTML, and PDF).
For example, assume that you want to generate the API documentation for
the ‘types’ library:

     | ?- {types(loader)}.
     ....

     | ?- {lgtdoc(loader)}.
     ....

     | ?- lgtdoc::library(types).
     ...

The above queries will result in the creation of a ‘xml_docs’ in your
current directory by default.  Assuming that we want to generate
Sphinx-based documentation and that we are using a POSIX
operating-system, the next steps would be:

     $ cd xml_docs
     $ lgt2rst -s -m

The ‘lgt2rst’ script will ask a few questions (project name, author,
version, …).  After its completion, the generated HTML files will be
found in the ‘_build/html’ directory by default:

     $ open _build/html/index.html

For Windows operating-systems, PowerShell scripts are available.  For
example, assuming that we want to generate HTML documentation, we could
run in a PowerShell window:

     PS > cd xml_docs
     PS > lgt2html.ps1 -p saxon

After completion, the generated HTML files will be found in the
‘xml_docs’ directory by default.

See the ‘NOTES’ file in the tool directory for details, specially on the
XSLT processor dependencies.  You may use the supplied sample files as a
starting point for generating the documentation of your Logtalk
applications.

The Logtalk DTD file, ‘logtalk_entity.dtd’, contains a reference to a
user-customizable file, ‘custom.ent’, which declares XML entities for
source code author names, license terms, and copyright strings.  After
editing the ‘custom.ent’ file to reflect your personal data, you may use
the XML entities on ‘info/1’ documenting directives.  For example,
assuming that the XML entities are named 'author', 'license', and
'copyright' we may write:

     :- info([
         version is 1:1:0,
         author is {author},
         license is {license},
         copyright is {copyright}
     ]).

The entity references are replaced by the value of the corresponding XML
entity when the XML documenting files are processed ('not' when they are
generated; this notation is just a shortcut to take advantage of XML
entities).

The *note lgtdoc: 322. tool supports a set of options that can be used
to control the generation of the XML documentation files.  See the tool
documentation for details.  There is also a *note doclet: 32d. tool that
allows automating the steps required to generate the documentation for
an application.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inline formatting in comments text,  Next: Diagrams,  Prev: Processing and viewing documenting files,  Up: Documenting

1.17.6 Inline formatting in comments text
-----------------------------------------

Inline formatting in comments text can be accomplished by using Markdown
or reStructuredText syntax and converting XML documenting files to
Markdown or reStructuredText files (and these, if required, to e.g.
HTML, ePub, or PDF formats).  Note that Markdown and reStructuredText
common syntax elements are enough for most API documentation:

     Mark *italic text* with one asterisk.
     Mark **bold text** with two asterisks.
     Mark ``monospaced text`` with two backquotes.

Rendering this block as markup gives:

     Mark 'italic text' with one asterisk.  Mark 'bold text' with two
     asterisks.  Mark ‘monospaced text’ with two backquotes.

As single backquotes have different purposes in Markdown (monospaced
text) and reStructuredText (domain- or application-dependent meaning),
never use them.  This also avoids doubts if there’s an inline formatting
typo in text meant to be rendered as monospaced text (usually inline
code fragments).


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagrams,  Prev: Inline formatting in comments text,  Up: Documenting

1.17.7 Diagrams
---------------

The *note diagrams: 2ed. tool supports a wide range of diagrams that can
also help in documenting an application.  The generated diagrams can
include URL links to both source code and API documentation.  They can
also be linked, connecting, for example, high level diagrams to detail
diagrams.  These features allow diagrams to be an effective solution for
navigating and understanding the structure and implementation of an
application.  This tool uses the same *note reflection API: 48. as the
‘lgtdoc’ tool and thus has access to the same source data.  See the tool
documentation for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Debugging,  Next: Performance<2>,  Prev: Documenting,  Up: User Manual

1.18 Debugging
==============

The Logtalk distribution includes a command-line *note debugger: 2fc.
tool implemented as a Logtalk application using the debugging API. It
can be loaded at the top-level interpreter by typing:

     | ?- logtalk_load(debugger(loader)).

It can also be loaded automatically at startup time by using a *note
settings file: 49.

The *note debugger: 2fc. tool includes the debugging features found in
traditional Prolog debuggers.  There are some differences, however,
between the usual implementation of Prolog debuggers and the current
implementation of the Logtalk debugger that you should be aware of.
First, unlike most Prolog debuggers, the Logtalk debugger is not a
built-in feature but a regular Logtalk application using documented
debugging hook predicates.  This translates to a different, although
similar, set of debugging features when compared with some of the more
sophisticated Prolog debuggers.  Second, debugging is only possible for
entities compiled in debug mode.  When compiling an entity in debug
mode, Logtalk decorates clauses with source information to allow tracing
of the goal execution.  Third, the tool provides several types of
breakpoints (for pausing and interacting with the debugger) and also log
points, while most Prolog systems are limited to traditional predicate
spy points.

* Menu:

* Compiling source files in debug mode::
* Procedure box model::
* Activating the debugger::
* Defining breakpoints::
* Defining log points::
* Tracing program execution::
* Debugging using breakpoints::
* Debugging commands::
* Customizing term writing::
* Context-switching calls::
* Debugging messages::
* Using the term-expansion mechanism for debugging::
* Ports profiling::
* Debug and trace events::
* Source-level debugger::


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiling source files in debug mode,  Next: Procedure box model,  Up: Debugging

1.18.1 Compiling source files in debug mode
-------------------------------------------

Compilation of source files in debug mode is controlled by the *note
debug: 2e2. compiler flag.  The default value for this flag, usually
‘off’, is defined in the *note backend adapter files: 154.  Its default
value may be changed globally at runtime by calling:

     | ?- set_logtalk_flag(debug, on).

Implicitly, this goal also turns off the ‘optimize’ flag.  In
alternative, if we want to compile only some source files in debug mode,
we may instead write:

     | ?- logtalk_load([file1, file2, ...], [debug(on)]).

The *note logtalk_make/1: 2a0. built-in predicate can also be used to
recompile all loaded files (that were compiled without using explicit
values for the *note debug: 2e2. and *note optimize: 8c. compiler flags
in a ‘logtalk_load/2’ call or in a *note loader file: 4f, if used) in
debug mode:

     | ?- logtalk_make(debug).

With most *note backend Prolog compilers: 34, the ‘{+d}’ top-level
shortcut can also be used.  After debugging, the files can be recompiled
in normal or optimized mode using, respectively, the ‘{+n}’ or ‘{+o}’
top-level shortcuts.

     Warning: The *note clean: 292. compiler flag should be turned on
     whenever the *note debug: 2e2. flag is turned on at runtime.  This
     is necessary because debug code would not be generated for files
     previously compiled in normal or optimized mode if there are no
     changes to the source files.

After loading the debugger, we may check (or enumerate by backtracking),
all loaded entities compiled in debug mode as follows:

     | ?- debugger::debugging(Entity).

To compile only a specific entity in debug mode, use the *note
set_logtalk_flag/2: 50. directive inside the entity.  To compile all
entities in a source file in debug mode, use the *note
set_logtalk_flag/2: 50. directive at the beginning of the file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Procedure box model,  Next: Activating the debugger,  Prev: Compiling source files in debug mode,  Up: Debugging

1.18.2 Procedure box model
--------------------------

Logtalk uses a 'procedure box model' similar to those found on most
Prolog systems.  The traditional Prolog procedure box model defines four
ports ('call', 'exit', 'redo', and 'fail') for describing control flow
when calling a predicate:

     ‘call’
          predicate call
     ‘exit’
          success of a predicate call
     ‘redo’
          backtracking into a predicate call
     ‘fail’
          failure of a predicate call

Logtalk, as found on some recent Prolog systems, adds a port for dealing
with exceptions thrown when calling a predicate:

     ‘exception’
          predicate call throws an exception

In addition to the ports described above, Logtalk adds two more ports,
‘fact’ and ‘rule’, which show the result of the unification of a goal
with, respectively, a fact and a rule head:

     ‘fact’
          unification success between a goal and a fact
     ‘rule’
          unification success between a goal and a rule head

Following Prolog tradition, the user may define for which ports the
debugger should pause for user interaction by specifying a list of
'leashed' ports.  Unleashed ports are just printed with no pause for
user interaction when tracing.  For example:

     | ?- debugger::leash([call, exit, fail]).

Alternatively, the user may use an atom abbreviation for a pre-defined
set of ports.  For example:

     | ?- debugger::leash(loose).

The abbreviations defined in Logtalk are similar to those defined on
some Prolog compilers:

     ‘none’
          ‘[]’
     ‘loose’
          ‘[fact, rule, call]’
     ‘half’
          ‘[fact, rule, call, redo]’
     ‘tight’
          ‘[fact, rule, call, redo, fail, exception]’
     ‘full’
          ‘[fact, rule, call, exit, redo, fail, exception]’

By default, the debugger pauses at every port for user interaction.


File: TheLogtalkHandbook-3.100.1.info,  Node: Activating the debugger,  Next: Defining breakpoints,  Prev: Procedure box model,  Up: Debugging

1.18.3 Activating the debugger
------------------------------

The debuggerp::trace/0(1) and debuggerp::debug/0(2) predicates
implicitly select the ‘debugger’ tool as the active *note debug handler:
338.  If you have additional debug handlers loaded (e.g., the
‘ports_profiler’ tool), those would no longer be active (there can be
only one active debug handler at any given time).  The
debuggerp::nodebug/0(3) predicate implicitly deselects the ‘debugger’
tool as the active debug handler.

   ---------- Footnotes ----------

   (1) ../../apis/debuggerp_0.html#debuggerp-0-trace-0

   (2) ../../apis/debuggerp_0.html#debuggerp-0-debug-0

   (3) ../../apis/debuggerp_0.html#debuggerp-0-nodebug-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining breakpoints,  Next: Defining log points,  Prev: Activating the debugger,  Up: Debugging

1.18.4 Defining breakpoints
---------------------------

The ‘debugger’ tool provides the following breakpoint types where the
debugger pauses at a leashed port for user interaction:

   - 

     Predicate breakpoints

          Traditional Prolog spy points are defined using a predicate
          (or a non-terminal) indicator.  The debugger pauses for user
          input at all ports for the predicate (or non-terminal).

   - 

     Clause breakpoints

          Defined using the location of a clause.  The debugger pauses
          for user input at unification ports.

   - 

     Conditional breakpoints

          Defined using the location of a clause and a condition for
          pausing for user input at an unification port.

   - 

     Hit count breakpoints

          Defined using the location of a clause and an unification
          count expression as a condition for pausing for user input at
          an unification port.

   - 

     Triggered breakpoints

          Defined using the location of a clause and another breakpoint
          that must be hit first as a condition for pausing for user
          input at an unification port.

   - 

     Context breakpoints

          Defined using execution context and goal templates as a
          condition for pausing for user input at all ports.

Clause breakpoints are checked when the current goal successfully
unifies with a clause head.  To simplify their definition, these are
specified using the entity identifier instead of the file name (as all
entities share a single namespace, an entity can only be defined in a
single file) and the first line number of the clause head.  But note
that only some Prolog backends provide accurate source file term line
numbers.  Check the *note debugger: 2fc. tool documentation for details.

* Menu:

* Defining predicate and clause breakpoints::
* Defining conditional breakpoints::
* Defining hit count breakpoints::
* Defining triggered breakpoints::
* Defining context breakpoints::
* Removing all breakpoints::


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining predicate and clause breakpoints,  Next: Defining conditional breakpoints,  Up: Defining breakpoints

1.18.4.1 Defining predicate and clause breakpoints
..................................................

Predicate and clause breakpoints can be defined using the debugger
‘spy/1’ predicate.  The argument can be a predicate indicator
(‘Name/Arity’), a non-terminal indicator (‘Name//Arity’), a clause
location (expressed as an ‘Entity-Line’ pair), or a list of breakpoints.
Predicate and non-terminal indicators can also be qualified with a
specific object or category identifiers.  For example:

     | ?- debugger::spy(person-42).

     Clause breakpoint added.
     yes

     | ?- debugger::spy(foo/2).

     Predicate breakpoint added.
     yes

     | ?- debugger::spy(qux::baz/3).

     Entity predicate breakpoint added.
     yes

     | ?- debugger::spy([foo/4, bar//1, agent-99]).

     All specified breakpoints added.
     yes

Note that setting a clause breakpoint implicitly removes any existing
conditional breakpoint, triggered breakpoint, or log point for the same
clause.

Unconditional clause and predicate breakpoints can be removed by using
the debugger ‘nospy/1’ predicate.  The argument can also be a list of
breakpoints or a non-instantiated variable, in which case all
breakpoints will be removed.  For example:

     | ?- debugger::nospy(_).

     All matching predicate and clause breakpoints removed.
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining conditional breakpoints,  Next: Defining hit count breakpoints,  Prev: Defining predicate and clause breakpoints,  Up: Defining breakpoints

1.18.4.2 Defining conditional breakpoints
.........................................

Conditional clause breakpoints are specified using the debugger ‘spy/3’
predicate.  The first two arguments are the entity and the line of a
clause head.  The third argument is the condition, which can be a lambda
expression, an unification count expression (see next section), or
another breakpoint (see next below).

The supported lambda expressions are ‘[Count, N, Goal]>>Condition’ and
‘[Goal]>>Condition’ where ‘Count’ is the unification count, ‘N’ is the
goal invocation number, and ‘Goal’ is the goal that unified with the
clause head; ‘Condition’ is called in the context of the ‘user’
pseudo-object and must not have any side effects.  Some examples:

     | ?- debugger::spy(planet, 76, [weight(m1,_)]>>true).

     Conditional breakpoint added.
     yes

Note that setting a conditional breakpoint will remove any existing
clause breakpoint or log point for the same location.

Conditional breakpoints can be removed by using the debugger ‘nospy/3’
predicate.  For example:

     | ?- debugger::nospy(planet, _, _).

     All matching conditional breakpoints removed.
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining hit count breakpoints,  Next: Defining triggered breakpoints,  Prev: Defining conditional breakpoints,  Up: Defining breakpoints

1.18.4.3 Defining hit count breakpoints
.......................................

Conditional clause breakpoints that depend on the unification count are
known as 'hit count' clause breakpoints.  The debugger pauses at a hit
count breakpoint depending on an unification count expression:

   - ‘>(Count)’ - break when the unification count is greater than
     ‘Count’

   - ‘>=(Count)’ - break when the unification count is greater than or
     equal to ‘Count’

   - ‘=:=(Count)’ - break when the unification count is equal to ‘Count’

   - ‘=<(Count)’ - break when the unification count is less than or
     equal to ‘Count’

   - ‘<(Count)’ - break when the unification count is less than ‘Count’

   - ‘mod(M)’ - break when the unification count modulo ‘M’ is zero

   - ‘Count’ - break when the unification count is greater than or equal
     to ‘Count’

For example:

     | ?- debugger::spy(planet, 41, =<(2)).

     Conditional breakpoint added.
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining triggered breakpoints,  Next: Defining context breakpoints,  Prev: Defining hit count breakpoints,  Up: Defining breakpoints

1.18.4.4 Defining triggered breakpoints
.......................................

Conditional clause breakpoints that depend on other clause breakpoint or
on a log point are known as 'triggered' clause breakpoints.  The
debugger only pauses at a triggered breakpoint if the clause breakpoint
or log point it depends on is hit first.  For example:

     | ?- debugger::spy(mars, 98, planet-76).

     Triggered breakpoint added.
     yes

In this case, the debugger will break for user interaction at the
unification port for the clause in the source file defining the ‘mars’
object at line 98 if and only if the debugger paused earlier at the
unification port for the clause in the source file defining the ‘planet’
category at line 76.

The debugger prints a ‘^’ character at the beginning of the line for
easy recognition of triggered breakpoints.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining context breakpoints,  Next: Removing all breakpoints,  Prev: Defining triggered breakpoints,  Up: Defining breakpoints

1.18.4.5 Defining context breakpoints
.....................................

A context breakpoint is a tuple describing a message execution context
and a goal:

     (Sender, This, Self, Goal)

The debugger pauses for user interaction whenever the breakpoint goal
and execution context subsume the goal currently being executed and its
execution context.  The user may establish any number of context
breakpoints as necessary.  For example, in order to call the debugger
whenever a predicate defined on an object named ‘foo’ is called, we may
define the following context breakpoint:

     | ?- debugger::spy(_, foo, _, _).

     Context breakpoint set.
     yes

For example, we can spy all calls to a ‘foo/2’ predicate with a ‘bar’
atom in the second argument by setting the condition:

     | ?- debugger::spy(_, _, _, foo(_, bar)).

     Context breakpoint set.
     yes

The debugger ‘nospy/4’ predicate may be used to remove all matching
breakpoints.  For example, the call:

     | ?- debugger::nospy(_, _, foo, _).

     All matching context breakpoints removed.
     yes

will remove all context breakpoints where the value of *note self: 69.
is the atom ‘foo’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Removing all breakpoints,  Prev: Defining context breakpoints,  Up: Defining breakpoints

1.18.4.6 Removing all breakpoints
.................................

We can remove all breakpoints by using the debugger ‘nospyall/0’
predicate:

     | ?- debugger::nospyall.

     All breakpoints removed.
     yes

There’s also a ‘reset/0’ predicate that can be used to reset the
debugger to its default settings and delete all defined breakpoints and
log points.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining log points,  Next: Tracing program execution,  Prev: Defining breakpoints,  Up: Debugging

1.18.5 Defining log points
--------------------------

Logtalk log points are similar to clause breakpoints.  Therefore, the
line number must correspond to the first line of an entity clause.  When
the debugger reaches a log point at an unification port, it prints a log
message and continues without pausing execution for reading a port
command.  When the log message is an empty atom, the default port output
message is printed.  When the log message starts with a ‘%’ character,
the default port output message is printed, followed by the log message.
In these two cases, the debugger prints a ‘@’ character at the beginning
of the line for easy recognition of log points output.  When the log
message is neither empty nor starts with a ‘%’ character, the log
message is printed instead of the default port output message.  In this
case, the message can contain ‘$KEYWORD’ placeholders that are expanded
at runtime.  The valid keywords are:

   - ‘PORT’

   - ‘ENTITY’

   - ‘CLAUSE_NUMBER’

   - ‘FILE’

   - ‘LINE’

   - ‘UNIFICATION_COUNT’

   - ‘INVOCATION_NUMBER’

   - ‘GOAL’

   - ‘PREDICATE’

   - ‘EXECUTION_CONTEXT’

   - ‘SENDER’

   - ‘THIS’

   - ‘SELF’

   - ‘METACALL_CONTEXT’

   - ‘COINDUCTION_STACK’

   - ‘THREAD’

Log points are defined using the ‘log/3’ predicate.  For example:

     | ?- debugger::log(agent, 99, '% At the secret headquarters!').
          Log point added.
     yes

     | ?- debugger::log(loop, 42, 'Message $PREDICATE from $SENDER at thread $THREAD').
          Log point added.
     yes

The ‘logging/3’ and ‘nolog/3’ predicate can be used to, respectively,
query and remove log points.  There’s also a ‘nologall/0’ predicate that
removes all log points.

Note that setting a log point will remove any existing clause breakpoint
for the same location.


File: TheLogtalkHandbook-3.100.1.info,  Node: Tracing program execution,  Next: Debugging using breakpoints,  Prev: Defining log points,  Up: Debugging

1.18.6 Tracing program execution
--------------------------------

Logtalk allows tracing of execution for all objects compiled in debug
mode.  To start the debugger in trace mode, write:

     | ?- debugger::trace.

     yes

Next, type the query to be debugged.  For example, using the ‘family’
example in the Logtalk distribution compiled for debugging:

     | ?- addams::sister(Sister, Sibling).
          Call: (1) sister(_1082,_1104) ?
          Rule: (1) sister(_1082,_1104) ?
          Call: (2) ::female(_1082) ?
          Call: (3) female(_1082) ?
          Fact: (3) female(morticia) ?
         *Exit: (3) female(morticia) ?
         *Exit: (2) ::female(morticia) ?
         ...

While tracing, the debugger will pause for user input at each leashed
port, printing an informative message.  Each trace line starts with the
port, followed by the goal invocation number, followed by the goal.  The
invocation numbers are unique and allow us to correlate the ports used
for a goal.  In the output above, you can see, for example, that the
goal ‘::female(_1082)’ succeeds with the answer ‘::female(morticia)’.
The debugger also provides determinism information by prefixing the
‘exit’ port with a ‘*’ character when a call succeeds with choice-points
pending, thus indicating that there might be alternative solutions for
the goal.

Note that breakpoints are ignored when tracing.  But when a breakpoint
is set for the current predicate or clause, the debugger prints, before
the port name and number, a ‘+’ character for predicate breakpoints, a
‘#’ character for clause breakpoints, a ‘?’ character for conditional
clause breakpoints, a ‘^’ for triggered breakpoints, and a ‘*’ character
for context breakpoints.  For example:

     | ?- debugger::spy(female/2).

     yes

     | ?- addams::sister(Sister, Sibling).
          Call: (1) sister(_1078,_1100) ?
          Rule: (1) sister(_1078,_1100) ?
          Call: (2) ::female(_1078) ?
       +  Call: (3) female(_1078) ?

To stop tracing (but still allowing the debugger to pause at the defined
breakpoints), write:

     | ?- debugger::notrace.

     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Debugging using breakpoints,  Next: Debugging commands,  Prev: Tracing program execution,  Up: Debugging

1.18.7 Debugging using breakpoints
----------------------------------

Tracing a program execution may generate large amounts of debugging
data.  Debugging using breakpoints allows the user to concentrate on
specific points of the code.  To start a debugging session using
breakpoints, write:

     | ?- debugger::debug.

     yes

For example, assuming the predicate breakpoint we set in the previous
section on the ‘female/1’ predicate:

     | ?- addams::sister(Sister, Sibling).
       +  Call: (3) female(_1078) ?

To stop the debugger, write:

     | ?- debugger::nodebug.

     yes

Note that stopping the debugger does not remove any defined breakpoints
or log points.


File: TheLogtalkHandbook-3.100.1.info,  Node: Debugging commands,  Next: Customizing term writing,  Prev: Debugging using breakpoints,  Up: Debugging

1.18.8 Debugging commands
-------------------------

The debugger pauses for user interaction at leashed ports when tracing
and when hitting a breakpoint.  The following commands are available:

‘c’ — creep

     go on; you may use the spacebar, return, or enter keys in
     alternative

‘l’ — leap

     continues execution until the next breakpoint is found

‘s’ — skip

     skips tracing for the current goal; valid at call, redo, and
     unification ports

‘S’ - Skip

     similar to skip but displaying all intermediate ports unleashed

‘q’ — quasi-skip

     skips tracing until returning to the current goal or reaching a
     breakpoint; valid at call and redo ports

‘r’ — retry

     retries the current goal but side-effects are not undone; valid at
     the fail port

‘j’ — jump

     reads invocation number and continues execution until a port is
     reached for that number

‘z’ — zap

     reads either a port name and continues execution until that port is
     reached or a negated port name (e.g.  ‘-exit’) and continues
     execution until a port other than the negated port is reached

‘i’ — ignore

     ignores goal, assumes that it succeeded; valid at call and redo
     ports

‘f’ — fail

     forces backtracking; may also be used to convert an exception into
     a failure

‘n’ — nodebug

     turns off debugging

‘N’ — notrace

     turns off tracing

‘@’ — command; ‘!’ can be used in alternative

     reads and executes a query

‘b’ — break

     suspends execution and starts new interpreter; type ‘end_of_file’
     to terminate

‘a’ — abort

     returns to top level interpreter

‘Q’ — quit

     quits Logtalk

‘p’ — print

     writes current goal using the ‘print/1’ predicate if available

‘d’ — display

     writes current goal without using operator notation

‘w’ — write

     writes current goal quoting atoms if necessary

‘$’ — dollar

     outputs the compiled form of the current goal (for low-level
     debugging)

‘x’ — context

     prints execution context

‘.’ — file

     prints file, entity, predicate, and line number information at an
     unification port

‘e’ — exception

     prints exception term thrown by the current goal

‘E’ — raise exception

     reads and throws an exception term

‘=’ — debugging

     prints debugging information

‘<’ — write depth

     sets the write term depth (set to ‘0’ to reset)

‘*’ — add

     adds a context breakpoint for the current goal

‘/’ — remove

     removes a context breakpoint for the current goal

‘+’ — add

     adds a predicate breakpoint for the current goal

‘-’ — remove

     removes a predicate breakpoint for the current goal

‘#’ — add

     adds a breakpoint for the current clause

‘|’ — remove

     removes a breakpoint for the current clause

‘h’ — condensed help

     prints list of command options

‘?’ — extended help

     prints list of command options


File: TheLogtalkHandbook-3.100.1.info,  Node: Customizing term writing,  Next: Context-switching calls,  Prev: Debugging commands,  Up: Debugging

1.18.9 Customizing term writing
-------------------------------

Debugging complex applications often requires customizing term writing.
The available options are limiting the writing depth of large compound
terms and using the ‘p’ command at a leashed port.  This command uses
the ‘format/3’ de facto standard predicate with the ‘~p’ formatting
option to delegate writing the term to the ‘print/1’ predicate.  But
note that some backends don’t support this formatting option.

* Menu:

* Term write depth::
* Custom term writing::


File: TheLogtalkHandbook-3.100.1.info,  Node: Term write depth,  Next: Custom term writing,  Up: Customizing term writing

1.18.9.1 Term write depth
.........................

The terms written by the debugger can be quite large depending on the
application being debugged.  As described in the previous section, the
debugger accepts the ‘<’ command to set the maximum write term depth for
compound terms.  This command requires that the used *note backend
Prolog compiler: 34. supports the non-standard but common ‘max_depth/1’
option for the ‘write_term/3’ predicate.  When the compound term being
written is deeply nested, the sub-terms are only written up to the
specified depth with the omitted sub-terms replaced usually by ‘...’.
For example:

     | ?- write_term([0,1,2,3,4,5,6,7,8,9], [max_depth(5)]).

     [0,1,2,3,4|...]
     yes

The default maximum depth depends on the backend.  To print compound
terms without a depth limit, set it explicitly to zero if necessary.
The debuggerp::write_max_depth/1(1) and
debuggerp::set_write_max_depth/1(2) predicates can be used to query and
set the default maximum depth.

   ---------- Footnotes ----------

   (1) ../../apis/debuggerp_0.html#debuggerp-0-write-max-depth-1

   (2) ../../apis/debuggerp_0.html#debuggerp-0-set-write-max-depth-1


File: TheLogtalkHandbook-3.100.1.info,  Node: Custom term writing,  Prev: Term write depth,  Up: Customizing term writing

1.18.9.2 Custom term writing
............................

The implicit use of the traditional ‘print/1’ predicate (using the ‘p’
command) and the ‘portray/1’ user-defined hook predicate requires
backend Prolog compiler support for these predicates.  See the
documentation of the backend you intend to use for details.  As an
example, assuming the following ‘portray/1’ definition:

     portray(e(V1,V2)) :-
         format('~q ---> ~q~n', [V1,V2]).

Calling the ‘print/1’ predicate with e.g.  a ‘e(x1,x7)’ compound term
argument will output:

     | ?- print(e(x1,x7)).

     x1 ---> x7
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Context-switching calls,  Next: Debugging messages,  Prev: Customizing term writing,  Up: Debugging

1.18.10 Context-switching calls
-------------------------------

Logtalk provides a debugging control construct, *note (<<)/2: c7, which
allows the execution of a query within the context of an object.  Common
debugging uses include checking an object local predicates (e.g.
predicates representing internal dynamic state) and sending a message
from within an object.  This control construct may also be used to write
unit tests.

Consider the following toy example:

     :- object(broken).

         :- public(a/1).

         a(A) :- b(A, B), c(B).
         b(1, 2). b(2, 4). b(3, 6).
         c(3).

     :- end_object.

Something is wrong when we try the object public predicate, ‘a/1’:

     | ?- broken::a(A).

     no

For helping in diagnosing the problem, instead of compiling the object
in debug mode and doing a 'trace' of the query to check the clauses for
the non-public predicates, we can instead simply type:

     | ?- broken << c(C).

     C = 3
     yes

The ‘(<<)/2’ control construct works by switching the execution context
to the object in the first argument and then compiling and executing the
second argument within that context:

     | ?- broken << (self(Self), sender(Sender), this(This)).

     Self = broken
     Sender = broken
     This = broken

     yes

As exemplified above, the ‘(<<)/2’ control construct allows you to call
an object local and private predicates.  However, it is important to
stress that we are not bypassing or defeating an object predicate scope
directives.  The calls take place within the context of the specified
object, not within the context of the object making the ‘(<<)/2’ call.
Thus, the ‘(<<)/2’ control construct implements a form of
'execution-context-switching'.

The availability of the ‘(<<)/2’ control construct is controlled by the
*note context_switching_calls: 2d9. compiler flag (its default value is
defined in the adapter files of the backend Prolog compilers).


File: TheLogtalkHandbook-3.100.1.info,  Node: Debugging messages,  Next: Using the term-expansion mechanism for debugging,  Prev: Context-switching calls,  Up: Debugging

1.18.11 Debugging messages
--------------------------

Messages generated by calls to the *note logtalk;;print_message/3: 2fe.
predicate where the message kind is either ‘debug’ or ‘debug(Group)’ are
only printed, by default, when the *note debug: 2e2. flag is turned on.
Moreover, these predicate calls are suppressed by the compiler when the
*note optimize: 8c. flag is turned on.  Note that actual printing of
debug messages does not require compiling the code in debug mode, only
turning on the ‘debug’ flag.

* Menu:

* Meta-messages: Meta-messages<2>.
* Selective printing of debug messages::


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-messages<2>,  Next: Selective printing of debug messages,  Up: Debugging messages

1.18.11.1 Meta-messages
.......................

To avoid having to define *note message_tokens//2: 300. grammar rules
for translating each and every debug message, Logtalk provides default
tokenization for seven 'meta-messages' that cover the most common cases:

‘@Message’

     By default, the message is printed as passed to the ‘write/1’
     predicate followed by a newline.

‘Key-Value’

     By default, the message is printed as ‘Key: Value’ followed by a
     newline.  The key is printed as passed to the ‘write/1’ predicate
     while the value is printed as passed to the ‘writeq/1’ predicate.

‘Format+Arguments’

     By default, the message is printed as passed to the ‘format/2’
     predicate.

‘List’

     By default, the list items are printed indented, one per line.  The
     items are preceded by a dash and can be ‘@Message’, ‘Key-Value’, or
     ‘Format+Arguments’ messages.  If that is not the case, the item is
     printed as passed to the ‘writeq/1’ predicate.

‘Title::List’

     By default, the title is printed, followed by a newline and the
     indented list items, one per line.  The items are printed as in the
     ‘List’ meta message.

‘[Stream,Prefix]>>Goal’

     By default, call user-defined printing ‘Goal’ in the context of
     ‘user’.  The use of a lambda expression allows passing the message
     stream and prefix.  Printing the prefix is delegated to the goal.

‘[Stream]>>Goal’

     By default, call user-defined printing ‘Goal’ in the context of
     ‘user’.  The use of a lambda expression allows passing the message
     stream.

Some simple examples of using these meta-messages:

     | ?- logtalk::print_message(debug, core, @'Phase 1 completed').
     yes

     | ?- logtalk::print_message(debug, core, [Stream]>>write(Stream,foo)).
     yes

     | ?- set_logtalk_flag(debug, on).
     yes

     | ?- logtalk::print_message(debug, core, [Stream]>>write(Stream,foo)).
     foo
     yes

     | ?- logtalk::print_message(debug, core, @'Phase 1 completed').
     >>> Phase 1 completed
     yes

     | ?- logtalk::print_message(debug, core, answer-42).
     >>> answer: 42
     yes

     | ?- logtalk::print_message(debug, core, 'Position: <~d,~d>'+[42,23]).
     >>> Position: <42,23>
     yes

     | ?- logtalk::print_message(debug, core, [arthur,ford,marvin]).
     >>> - arthur
     >>> - ford
     >>> - marvin
     yes

     | ?- logtalk::print_message(debug, core, names::[arthur,ford,marvin]).
     >>> names:
     >>> - arthur
     >>> - ford
     >>> - marvin
     yes

The ‘>>>’ prefix is the default message prefix for ‘debug’ messages.  It
can be redefined using the *note logtalk;;message_prefix_stream/4: 304.
hook predicate.  For example:

     :- multifile(logtalk::message_prefix_stream/4).
     :- dynamic(logtalk::message_prefix_stream/4).

     logtalk::message_prefix_stream(debug, core, '(dbg) ', user_error).

Debugging messages only output information by default.  These messages
can, however, be *note intercepted: 309. to perform other actions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Selective printing of debug messages,  Prev: Meta-messages<2>,  Up: Debugging messages

1.18.11.2 Selective printing of debug messages
..............................................

By default, all debug messages are either printed or skipped, depending
on the *note debug: 2e2. and *note optimize: 8c. flags.  When the code
is not compiled in optimal mode, the *note debug_messages: 352. tool
allows selective enabling of debug messages per *note component: 353.
and per debug group.  For example, to enable all ‘debug’ and
‘debug(Group)’ messages for the ‘parser’ component:

     % upon loading the tool, all messages are disabled by default:
     | ?- logtalk_load(debug_messages(loader)).
     ...

     % enable both debug and debug(_) messages:
     | ?- debug_messages::enable(parser).
     yes

To enable only ‘debug(tokenization)’ messages for the ‘parser’
component:

     % first disable any and all enabled messages:
     | ?- debug_messages::disable(parser).
     yes

     % enable only debug(tokenization) messages:
     | ?- debug_messages::enable(parser, tokenization).
     yes

See the tool documentation for more details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Using the term-expansion mechanism for debugging,  Next: Ports profiling,  Prev: Debugging messages,  Up: Debugging

1.18.12 Using the term-expansion mechanism for debugging
--------------------------------------------------------

The *note term-expansion mechanism: cb. can also be used for conditional
compilation of debugging goals.  For example, the *note hook_objects:
31b. library provides a print_goal_hook(1) object that simplifies
printing entity goals before or after calling them by simply prefixing
them with an operator.  See the library and hook object documentation
for details.  You can also define your own specialized hook objects for
custom debugging tasks.

   ---------- Footnotes ----------

   (1) ../../apis/print_goal_hook_0.html#print-goal-hook-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Ports profiling,  Next: Debug and trace events,  Prev: Using the term-expansion mechanism for debugging,  Up: Debugging

1.18.13 Ports profiling
-----------------------

The Logtalk distribution includes a *note ports_profiler: 358. tool
based on the same procedure box model described above.  This tool is
specially useful for debugging performance issues (e.g., due to lack of
determinism or unexpected backtracking).  See the tool documentation for
details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Debug and trace events,  Next: Source-level debugger,  Prev: Ports profiling,  Up: Debugging

1.18.14 Debug and trace events
------------------------------

The debugging API defines two multifile predicates,
logtalk::trace_event/2(1) and logtalk::debug_handler/3(2) for handling
trace and debug events.  It also provides a logtalk::debug_handler/1(3)
multifile predicate that allows an object (or a category) to declare
itself as a debug handler provider.  The Logtalk ‘debugger’ and
‘ports_profiler’ tools are regular applications that are implemented
using this API, which can also be used to implement alternative or new
debugging-related tools.  See the API documentation for details and the
source code of the ‘debugger’ and ‘ports_profiler’ tools for usage
examples.

To define a new debug handler provider, add (to an object or category)
clauses for the ‘debug_handler/1’ and ‘debug_handler/3’ predicates.  For
example:

     % declare my_debug_handler as a debug handler provider
     :- multifile(logtalk::debug_handler/1).
     logtalk::debug_handler(my_debug_handler).

     % handle debug events
     :- multifile(logtalk::debug_handler/3).
     logtalk::debug_handler(my_debug_handler, Event, ExCtx) :-
         debug_handler(Event, ExCtx).

     debug_handler(fact(Entity,Fact,Clause,File,Line), ExCtx) :-
         ...
     debug_handler(rule(Entity,Head,Clause,File,Line), ExCtx) :-
         ...
     debug_handler(top_goal(Goal, TGoal), ExCtx) :-
         ...
     debug_handler(goal(Goal, TGoal), ExCtx) :-
         ...

Your debug handler provider should also either automatically call the
logtalk::activate_debug_handler/1(4) and
logtalk::deactivate_debug_handler/0(5) predicate or provide public
predicates to simplify calling these predicates.  For example:

     :- public(start/0).
     start :-
        logtalk::activate_debug_handler(my_debug_handler).

     :- public(stop/0).
     stop :-
        logtalk::deactivate_debug_handler.

If you only need to define a trace event handler, then simply define
clauses for the logtalk::trace_event/2(6) multifile predicate:

     :- multifile(logtalk::trace_event/2).
     :- dynamic(logtalk::trace_event/2).

     % the Logtalk runtime calls all defined logtalk::trace_event/2 hooks using
     % a failure-driven loop; thus we don't have to worry about handling all
     % events or failing after handling an event to give other hooks a chance
     logtalk::trace_event(fact(Entity, Fact, N, _, _), _) :-
         ...
     logtalk::trace_event(rule(Entity, Head, N, _, _), _) :-
         ...

   ---------- Footnotes ----------

   (1) ../../apis/logtalk_0.html#logtalk-0-trace-event-2

   (2) ../../apis/logtalk_0.html#logtalk-0-debug-handler-3

   (3) ../../apis/logtalk_0.html#logtalk-0-debug-handler-1

   (4) ../../apis/logtalk_0.html#logtalk-0-activate-debug-handler-1

   (5) ../../apis/logtalk_0.html#logtalk-0-deactivate-debug-handler-0

   (6) ../../apis/logtalk_0.html#logtalk-0-trace-event-2


File: TheLogtalkHandbook-3.100.1.info,  Node: Source-level debugger,  Prev: Debug and trace events,  Up: Debugging

1.18.15 Source-level debugger
-----------------------------

A minimal source-level debugger is provided by the Logtalk for VSCode
extension: when debugging in the integrated terminal using the
‘debugger’ tool, the current clause (at leashed unification ports) is
shown in the active editor window.  The extension can also be used with
VSCodium.  See its documentation for more details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Performance<2>,  Next: Installing Logtalk,  Prev: Debugging,  Up: User Manual

1.19 Performance
================

Logtalk is implemented as a 'trans-compiler' to Prolog.  When compiling
predicates, it preserves in the generated Prolog code all cases of
first-argument indexing and tail-recursion.  In practice, this means
that if you know how to write efficient Prolog predicates, you already
know the basics of how to write efficient Logtalk predicates.

The Logtalk compiler appends a single argument to the compiled form of
all entity predicate clauses.  This hidden argument is used to pass the
*note execution-context: 35e. when proving a query.  In the common case
where a predicate makes no calls to the *note execution-context
predicates: 35f. and *note message-sending control constructs: 360. and
is neither a meta-predicate nor a coinductive predicate, the
execution-context is simply passed between goals.  In this case, with
most backend Prolog virtual machines, the cost of this extra argument is
null or negligible.  When the execution-context needs to be accessed
(e.g. to fetch the value of *note self: 69. for a *note (;;)/1: 5c.
call) there may be a small inherent overhead due to the access to the
individual arguments of the compound term used to represent the
execution-context.

* Menu:

* Source code compilation modes::
* Source code compilation order::
* Local predicate calls::
* Calls to imported or inherited predicates::
* Calls to module predicates::
* Messages: Messages<2>.
* Automatic expansion of built-in meta-predicates::
* Inlining::
* Generated code simplification and optimizations::
* Size of the generated code::
* Circular references::
* Debug mode overhead::
* Other considerations::


File: TheLogtalkHandbook-3.100.1.info,  Node: Source code compilation modes,  Next: Source code compilation order,  Up: Performance<2>

1.19.1 Source code compilation modes
------------------------------------

Source code can be compiled in 'optimal', 'normal', or 'debug' mode,
depending on the *note optimize: 8c. and *note debug: 2e2. compiler
flags.  Optimal mode is used when deploying an application, while normal
and debug modes are used when developing an application.  Compiling code
in optimal mode enables several optimizations, notably the use of *note
static binding: 35. whenever enough information is available at
compile-time.  In debug mode, most optimizations are turned off, and the
code is instrumented to generate *note debug events: d5. that enable
developer tools such as the *note command-line debugger: 2fc. and the
*note ports profiler: 358.


File: TheLogtalkHandbook-3.100.1.info,  Node: Source code compilation order,  Next: Local predicate calls,  Prev: Source code compilation modes,  Up: Performance<2>

1.19.2 Source code compilation order
------------------------------------

Static binding optimizations, notably message sending and super calls,
require referenced code to be compiled before the calls so that the
calls can be resolved at compile time.  The compiler prints warnings
when the file compilation/loading order is not ideal (controlled by the
*note unknown_entities: 2c0. flag).  See the *note Source files: 294.
section on using the logtalk::loaded_files_topological_sort/1(1) and
logtalk::loaded_files_topological_sort/2(2) predicates to find an
optimal file loading order.  See the *note Source files: 294. section
for details.  See also the section below on circular references.

   ---------- Footnotes ----------

   (1) 
../../apis/logtalk_0.html#logtalk-0-loaded-files-topological-sort-1

   (2) 
../../apis/logtalk_0.html#logtalk-0-loaded-files-topological-sort-2


File: TheLogtalkHandbook-3.100.1.info,  Node: Local predicate calls,  Next: Calls to imported or inherited predicates,  Prev: Source code compilation order,  Up: Performance<2>

1.19.3 Local predicate calls
----------------------------

Local calls to object (or category) predicates have zero overhead in
terms of the number of inferences, as expected, compared with local
Prolog calls.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calls to imported or inherited predicates,  Next: Calls to module predicates,  Prev: Local predicate calls,  Up: Performance<2>

1.19.4 Calls to imported or inherited predicates
------------------------------------------------

Assuming the *note optimize: 8c. flag is turned on and a static
predicate, *note (^^)/1: 5d. calls have zero overhead in terms of number
of inferences.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calls to module predicates,  Next: Messages<2>,  Prev: Calls to imported or inherited predicates,  Up: Performance<2>

1.19.5 Calls to module predicates
---------------------------------

Local calls from an object (or category) to a module predicate have zero
overhead (assuming both the module and the predicate are bound at
compile-time).


File: TheLogtalkHandbook-3.100.1.info,  Node: Messages<2>,  Next: Automatic expansion of built-in meta-predicates,  Prev: Calls to module predicates,  Up: Performance<2>

1.19.6 Messages
---------------

Logtalk implements *note static binding: 35. and *note dynamic binding:
36. for message-sending calls.  For dynamic binding, a caching mechanism
is used by the runtime.  It’s useful to measure the performance overhead
in 'number of logic inferences' compared with plain Prolog and Prolog
modules.  Note that the number of logic inferences is a metric
independent of the chosen backend Prolog compiler.  The results for
Logtalk 3.17.0 and later versions are:

   - Static binding: 0

   - Dynamic binding (object bound at compile-time): +1

   - Dynamic binding (object bound at runtime): +2

Static binding is the common case with libraries and most application
code; it requires compiling code with the *note optimize: 8c. flag
turned on.  Dynamic binding numbers are after the first call (i.e.
after the generalization of the query is cached).  All numbers with the
*note events: 89. flag set to ‘deny’ (setting this flag to ‘allow’ adds
an overhead of +5 inferences to the results above; note that this flag
can be defined on a per-object basis as needed instead of globally and
thus minimizing the performance impact).

The dynamic binding caches assume the used *note backend Prolog
compiler: 34. does indexing of dynamic predicates.  This is a common
feature of modern Prolog systems, but the actual details vary from
system to system and may have an impact on dynamic binding performance.

Note that messages to 'self' (*note (;;)/1: 5c. calls) and messages to
an object (*note (;;)/2: 7e. calls) from the top-level interpreter
always use dynamic binding, as the object that receives the message is
only known at runtime.

Messages sent from Prolog modules may use static binding depending on
the used backend Prolog compiler native support for goal-expansion.
Consult the Prolog compiler documentation and adapter file notes for
details.

     Warning: Some Prolog systems provide a ‘time/1’ predicate that also
     reports the number of inferences.  But the reported numbers are
     often misleading when the predicate is called from the top-level.
     Besides common top-level bookkeeping operations (e.g., keeping
     track of goal history or applying goal-expansion) that may
     influence the inference counting, the Logtalk runtime code for a
     ‘(::)/2’ top-level goal is necessarily different from the code
     generated for a ‘(::)/2’ goal from a compiled object, as it
     requires 'runtime' compilation of the goal into the same low-level
     message-sending primitive (assuming dynamic-binding is also
     required for the compiled object goal).


File: TheLogtalkHandbook-3.100.1.info,  Node: Automatic expansion of built-in meta-predicates,  Next: Inlining,  Prev: Messages<2>,  Up: Performance<2>

1.19.7 Automatic expansion of built-in meta-predicates
------------------------------------------------------

The compiler always expands calls to the *note forall/2: 1c3, *note
once/1: 1bb, and *note ignore/1: 180. meta-predicates into equivalent
definitions using the negation and conditional control constructs.  It
also expands calls to the *note call/1-N: 181, *note phrase/2: 18e, and
*note phrase/3: 18f. meta-predicates when the first argument is bound.
These expansions are performed independently of the ‘optimize’ flag
value.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inlining,  Next: Generated code simplification and optimizations,  Prev: Automatic expansion of built-in meta-predicates,  Up: Performance<2>

1.19.8 Inlining
---------------

When the *note optimize: 8c. flag is turned on, the Logtalk compiler
performs 'inlining' of predicate calls whenever possible.  This includes
calls to Prolog predicates that are either built-in, foreign, or defined
in a module (including ‘user’).  Inlining notably allows wrapping module
or foreign predicates using an object without introducing any overhead.
In the specific case of the *note execution-context predicates: 19c,
calls are inlined independently of the ‘optimize’ flag value.


File: TheLogtalkHandbook-3.100.1.info,  Node: Generated code simplification and optimizations,  Next: Size of the generated code,  Prev: Inlining,  Up: Performance<2>

1.19.9 Generated code simplification and optimizations
------------------------------------------------------

When the *note optimize: 8c. flag is turned on, the Logtalk compiler
simplifies and optimizes generated clauses (including those resulting
from the compilation of grammar rules), by flattening conjunctions,
folding left unifications (e.g. generated as a by-product of the
compilation of grammar rules), and removing redundant calls to ‘true/0’.

When using *note lambda expressions: 162. and library meta-predicates,
use the *note meta_compiler: 36a. library to avoid most meta-call
overheads.


File: TheLogtalkHandbook-3.100.1.info,  Node: Size of the generated code,  Next: Circular references,  Prev: Generated code simplification and optimizations,  Up: Performance<2>

1.19.10 Size of the generated code
----------------------------------

The size of the intermediate Prolog code generated by the compiler is
proportional to the size of the source code.  Assuming that the *note
term-expansion mechanism: cb. is not used, each predicate clause in the
source code is compiled into a single predicate clause.  But the Logtalk
compiler also generates internal tables for the defined entities, for
the entity relations, and for the declared and defined predicates.
These tables enable support for fundamental features such as *note
inheritance: 8. and *note reflection: 48.  The size of these tables is
proportional to the number of entities, entity relations, and predicate
declarations and definitions.  When the *note source_data: cc. is turned
on (the default when 'developing' an application), the generated code
also includes additional data about the source code, such as entity and
predicate positions in a source file.  This data enables advanced
developer tool functionality.  But it is usually not required when
'deploying' an application.  Thus, turning this flag off is a common
setting for minimizing an application footprint.


File: TheLogtalkHandbook-3.100.1.info,  Node: Circular references,  Next: Debug mode overhead,  Prev: Size of the generated code,  Up: Performance<2>

1.19.11 Circular references
---------------------------

Circular references, i.e.  two objects sending messages to each other,
are relatively costly and should be avoided if possible as they prevent
using static binding for the messages sent from the first loaded object
to the second object.  The *note logtalk_make(circular): 2a0. goal (or
its ‘{@}’ top-level abbreviation) can be used to scan for circular
entity dependencies.


File: TheLogtalkHandbook-3.100.1.info,  Node: Debug mode overhead,  Next: Other considerations,  Prev: Circular references,  Up: Performance<2>

1.19.12 Debug mode overhead
---------------------------

Code compiled in debug mode runs slower, as expected, when compared with
normal or optimized mode.  The overhead depends on the number of 'debug
events' generated when running the application.  A debug event is simply
a pass on a call or unification port of the *note procedure box model:
335.  These debug events can be intercepted by defined clauses for the
logtalk::trace_event/2(1) and logtalk::debug_handler/3(2) multifile
predicates.  With no application (such as a debugger or a port profiler)
loaded defining clauses for these predicates, each goal has an overhead
of four extra inferences due to the runtime checking for a definition of
the hook predicates and a meta-call of the user goal.  The clause head
unification events result in one or more inferences per goal (depending
on the number of clauses whose head unifies with the goal and
backtracking).  In practice, this overhead translates to code compiled
in debug mode running typically ~2x to ~7x slower than code compiled in
normal or optimized mode, depending on the application (the exact
overhead is proportional to the number of passes on the call and
unification ports; deterministic code often results in a relatively
larger overhead when compared with code performing significant
backtracking).

   ---------- Footnotes ----------

   (1) ../../apis/logtalk_0.html#logtalk-0-trace-event-2

   (2) ../../apis/logtalk_0.html#logtalk-0-debug-handler-3


File: TheLogtalkHandbook-3.100.1.info,  Node: Other considerations,  Prev: Debug mode overhead,  Up: Performance<2>

1.19.13 Other considerations
----------------------------

One aspect of performance that affects both Logtalk and Prolog code is
the characteristics of the Prolog VM. The Logtalk distribution includes
two examples, bench(1) and benchmarks(2), to help evaluate performance
with specific backend Prolog systems.  A table with benchmark results(3)
for a subset of the supported systems is also available at the Logtalk
website.  But note that multiple factors affect the performance of an
application.  The benchmark examples and their results only provide a
partial assessment.

   ---------- Footnotes ----------

   (1) 
https://github.com/LogtalkDotOrg/logtalk3/tree/master/examples/bench

   (2) 
https://github.com/LogtalkDotOrg/logtalk3/tree/master/examples/benchmarks

   (3) https://logtalk.org/performance.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Installing Logtalk,  Next: Prolog integration and migration,  Prev: Performance<2>,  Up: User Manual

1.20 Installing Logtalk
=======================

This page provides an overview of Logtalk installation requirements and
instructions and a description of the files contained in the Logtalk
distribution.  For detailed, up-to-date installation and configuration
instructions, please see the ‘README.md’, ‘INSTALL.md’, and
‘CUSTOMIZE.md’ files distributed with Logtalk.  The broad compatibility
of Logtalk, both with Prolog compilers and operating-systems, together
with all the possible user scenarios, means that installation can vary
from very simple, by running an installer or a couple of scripts, to the
need of patching both Logtalk and Prolog compilers to workaround the
lack of strong Prolog standards or to cope with the requirements of less
common operating-systems.

The preferred installation scenario is to have Logtalk installed in a
system-wide location, thus available for all users, and a local copy of
user-modifiable files on each user home directory (even when you are the
single user of your computer).  This scenario allows each user to
independently customize Logtalk and to freely modify the provided
libraries and programming examples.  Logtalk installers, installation
shell scripts, and Prolog integration scripts favor this installation
scenario, although alternative installation scenarios are always
possible.  The installers set two environment variables, ‘LOGTALKHOME’
and ‘LOGTALKUSER’, pointing, respectively, to the Logtalk installation
folder and to the Logtalk user folder.

User applications should preferably be kept outside of the Logtalk user
folder created by the installation process, as updating Logtalk often
results in updating the contents of this folder.  If your applications
depend on customizations to the distribution files, backup those changes
before updating Logtalk.

* Menu:

* Hardware and software requirements::
* Logtalk installers::
* Source distribution::
* Distribution overview::


File: TheLogtalkHandbook-3.100.1.info,  Node: Hardware and software requirements,  Next: Logtalk installers,  Up: Installing Logtalk

1.20.1 Hardware and software requirements
-----------------------------------------

* Menu:

* Computer and operating system::
* Prolog compiler::


File: TheLogtalkHandbook-3.100.1.info,  Node: Computer and operating system,  Next: Prolog compiler,  Up: Hardware and software requirements

1.20.1.1 Computer and operating system
......................................

Logtalk is compatible with almost any computer/operating-system with a
modern, standards-compliant, Prolog compiler available.


File: TheLogtalkHandbook-3.100.1.info,  Node: Prolog compiler,  Prev: Computer and operating system,  Up: Hardware and software requirements

1.20.1.2 Prolog compiler
........................

Logtalk requires a *note backend Prolog compiler: 34. supporting
official and de facto standards.  Capabilities needed by Logtalk that
are not defined in the official ISO Prolog Core standard include:

   - access to predicate properties

   - operating-system access predicates

   - de facto standard predicates not (yet) specified in the official
     standard

Logtalk needs access to the predicate property ‘built_in’ to properly
compile objects and categories that contain Prolog built-in predicate
calls.  In addition, some Logtalk built-ins need to know the
dynamic/static status of predicates to ensure correct application.  The
ISO standard for Prolog modules defines a ‘predicate_property/2’
predicate that is already implemented by most Prolog compilers.  Note
that if these capabilities are not built-in the user cannot easily
define them.

For optimal performance, Logtalk requires that the Prolog compiler
supports 'first-argument indexing' for both static and dynamic code
(most modern compilers support this feature).

Since most Prolog compilers are moving closer to the ISO Prolog standard
*note [ISO95]: 31, it is advisable that you try to use the most recent
version of your favorite Prolog compiler.


File: TheLogtalkHandbook-3.100.1.info,  Node: Logtalk installers,  Next: Source distribution,  Prev: Hardware and software requirements,  Up: Installing Logtalk

1.20.2 Logtalk installers
-------------------------

Logtalk installers are available for macOS, Linux, and Microsoft
Windows.  Depending on the chosen installer, some tasks (e.g., setting
environment variables or integrating Logtalk with some Prolog compilers)
may need to be performed manually.


File: TheLogtalkHandbook-3.100.1.info,  Node: Source distribution,  Next: Distribution overview,  Prev: Logtalk installers,  Up: Installing Logtalk

1.20.3 Source distribution
--------------------------

Logtalk sources are available in a ‘tar’ archive compressed with
‘bzip2’, ‘lgt3xxx.tar.bz2’.  You may expand the archive by using a
decompressing utility or by typing the following commands at the
command-line:

     % tar -jxvf lgt3xxx.tar.bz2

This will create a sub-directory named ‘lgt3xxx’ in your current
directory.  Almost all files in the Logtalk distribution are text files.
Different operating-systems use different end-of-line codes for text
files.  Ensure that your decompressing utility converts the end-of-lines
of all text files to match your operating system.


File: TheLogtalkHandbook-3.100.1.info,  Node: Distribution overview,  Prev: Source distribution,  Up: Installing Logtalk

1.20.4 Distribution overview
----------------------------

In the Logtalk installation directory, you will find the following files
and directories:

‘ACKNOWLEDGMENTS.md’ - List of authors, contributors, sponsors, and open
source credits

‘BIBLIOGRAPHY.bib’ – Logtalk bibliography in BibTeX format

‘CITATION.cff’ - Information on how to cite Logtalk

‘CODE_OF_CONDUCT.md’ - Code of conduct for contributors and users
posting on support forums

‘CUSTOMIZE.md’ – Logtalk end-user customization instructions

‘INSTALL.md’ – Logtalk installation instructions

‘LICENSE.txt’ – Logtalk user license

‘NOTICE.txt’ – Logtalk copyright notice

‘QUICK_START.md’ – Quick start instructions for those that do not like
to read manuals

‘README.md’ – several useful pieces of information

‘RELEASE_NOTES.md’ – release notes for this version

‘UPGRADING.md’ – instructions on how to upgrade your programs to the
current Logtalk version

‘VERSION.txt’ – file containing the current Logtalk version number (used
for compatibility checking when upgrading Logtalk)

‘adapters’

     ‘NOTES.md’ – notes on the provided adapter files

     ‘template.pl’ – template adapter file

     ‘...’ – specific adapter files

‘coding’

     ‘NOTES.md’ – notes on syntax highlighter and text editor support
     files providing syntax coloring for publishing and editing Logtalk
     source code

     ‘...’ – syntax coloring support files

‘contributions’

     ‘NOTES.md’ – notes on the user-contributed code

     ‘...’ – user-contributed code files

‘core’

     ‘NOTES.md’ – notes on the current status of the compiler and
     runtime

     ‘...’ – core source files

‘docs/apis’

     ‘NOTES.md’ – notes on the provided documentation for core, library,
     tools, and contributions entities

     ‘index.html’ – root document for all entities documentation

     ‘...’ – other entity documentation files

‘docs/handbook’

     ‘NOTES.md’ – notes on the provided documentation

     ‘bibliography.html’ – bibliography

     ‘glossary.html’ – glossary

     ‘index.html’ – root document for all documentation

     ‘...’ – other documentation files

‘docs/man’

     ‘...’ – POSIX man pages for the shell scripts

‘examples’

     ‘NOTES.md’ – short description of the provided examples

     ‘ack’

          ‘NOTES.md’ – example notes and sample queries

          ‘loader.lgt’ – loader utility file for the example objects

          ‘...’ – ack example source files

     ‘...’ – other examples

‘integration’

     ‘NOTES.md’ – notes on scripts for Logtalk integration with Prolog
     compilers

     ‘...’ – Prolog integration scripts

‘library’

     ‘NOTES.md’ – short description of the library contents

     ‘all_loader.lgt’ – loader utility file for all library entities

     ‘...’ – library source files

‘paths’

     ‘NOTES.md’ – description on how to setup library and example paths

     ‘paths.pl’ – default library and example paths

‘ports’

     ‘NOTES.md’ – description of included ports of third-party software

     ‘...’ – ports

‘samples’

     ‘loader-sample.lgt’ – sample loader file for user applications

     ‘settings-sample.lgt’ – sample file for user-defined Logtalk
     settings

     ‘tester-sample.lgt’ – sample file for helping to automate running
     user application unit tests

     ‘tests-sample.lgt’ – sample file for writing user application unit
     tests

‘scratch’

     ‘NOTES.md’ – notes on the scratch directory

‘scripts’

     ‘NOTES.md’ – notes on scripts for Logtalk user setup, packaging,
     and installation

     ‘...’ – packaging, installation, and setup scripts

‘tests’

     ‘NOTES.md’ – notes on the current status of the unit tests

     ‘...’ – unit tests for built-in features

‘tools’

     ‘NOTES.md’ – notes on the provided programming tools

     ‘...’ – programming tools

* Menu:

* Adapter files::
* Compiler and runtime::
* Library::
* Examples::
* Logtalk source files::


File: TheLogtalkHandbook-3.100.1.info,  Node: Adapter files,  Next: Compiler and runtime,  Up: Distribution overview

1.20.4.1 Adapter files
......................

Adapter files provide the glue code between the Logtalk compiler/runtime
and a Prolog compiler.  Each adapter file contains two sets of
predicates: ISO Prolog standard predicates and directives not built-in
in the target Prolog compiler and Logtalk specific predicates.

Logtalk already includes ready-to-use adapter files for most academic
and commercial Prolog compilers.  If an adapter file is not available
for the compiler that you intend to use, then you need to build a new
one, starting from the included ‘template.pl’ file.  Start by making a
copy of the template file.  Carefully check (or complete if needed) each
listed definition.  If your Prolog compiler conforms to the ISO
standard, this task should only take you a few minutes.  In most cases,
you can borrow code from the predefined adapter files.  If you are
unsure that your Prolog compiler provides all the ISO predicates needed
by Logtalk, try to run the system by setting the unknown predicate error
handler to report as an error any call to a missing predicate.  Better
yet, switch to a modern, ISO-compliant, Prolog compiler.  If you send me
your adapter file, with a reference to the target Prolog compiler, maybe
I can include it in the next release of Logtalk.

The adapter files specify 'default' values for most of the Logtalk *note
compiler flags: 251.  They also specify values for read-only flags that
are used to describe Prolog backend-specific features.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiler and runtime,  Next: Library,  Prev: Adapter files,  Up: Distribution overview

1.20.4.2 Compiler and runtime
.............................

The ‘core’ sub-directory contains the Prolog and Logtalk source files
that implement the Logtalk compiler and the Logtalk runtime.  The
compiler and the runtime may be split in two (or more) separate files or
combined into a single file, depending on the Logtalk release that you
are installing.


File: TheLogtalkHandbook-3.100.1.info,  Node: Library,  Next: Examples,  Prev: Compiler and runtime,  Up: Distribution overview

1.20.4.3 Library
................

The Logtalk distribution includes a standard library of useful objects,
categories, and protocols.  Read the corresponding ‘NOTES.md’ file for
details about the library contents.


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples,  Next: Logtalk source files,  Prev: Library,  Up: Distribution overview

1.20.4.4 Examples
.................

The Logtalk distribution includes a large number of programming
examples.  The sources of each one of these examples can be found
included in a subdirectory with the same name, inside the directory
examples.  The majority of these examples include tests and a file named
‘SCRIPT.txt’ with sample calls.  Some examples may depend on other
examples and library objects to work properly.  Read the corresponding
‘NOTES.md’ file for details before running an example.


File: TheLogtalkHandbook-3.100.1.info,  Node: Logtalk source files,  Prev: Examples,  Up: Distribution overview

1.20.4.5 Logtalk source files
.............................

Logtalk source files are text files containing one or more entity
definitions (objects, categories, or protocols).  The Logtalk source
files may also contain plain Prolog code.  The extension ‘.lgt’ is
normally used.  Logtalk compiles these files to plain Prolog by
appending to the file name a suffix derived from the extension and by
replacing the ‘.lgt’ extension with ‘.pl’ (‘.pl’ is the default Prolog
extension; if your Prolog compiler expects the Prolog source filenames
to end with a specific, different extension, you can set it in the
corresponding adapter file).


File: TheLogtalkHandbook-3.100.1.info,  Node: Prolog integration and migration,  Prev: Installing Logtalk,  Up: User Manual

1.21 Prolog integration and migration
=====================================

This section provides suggestions for integrating and migrating plain
Prolog code and Prolog module code to Logtalk.  Detailed instructions
are provided for encapsulating plain Prolog code in objects, converting
Prolog modules into objects, and compiling and reusing Prolog modules as
objects from inside Logtalk.  An interesting application of the
techniques described in this section is a solution for running a Prolog
application that uses modules on a Prolog compiler with no module
system.  The *note wrapper: 38b. tool can be used to help in migrating
Prolog code.

* Menu:

* Source files with both Prolog code and Logtalk code::
* Encapsulating plain Prolog code in objects::
* Converting Prolog modules into objects::
* Compiling Prolog modules as objects::
* Dealing with proprietary Prolog directives and predicates::
* Calling Prolog module predicates: Calling Prolog module predicates<2>.
* Loading converted Prolog applications::


File: TheLogtalkHandbook-3.100.1.info,  Node: Source files with both Prolog code and Logtalk code,  Next: Encapsulating plain Prolog code in objects,  Up: Prolog integration and migration

1.21.1 Source files with both Prolog code and Logtalk code
----------------------------------------------------------

Logtalk source files may contain plain Prolog code intermixed with
Logtalk code.  The Logtalk compiler simply copies the plain Prolog code
as-is to the generated Prolog file.  With Prolog modules, it is assumed
that the module code starts with a ‘module/1-2’ directive and ends at
the end of the file.  There is no module ending directive that would
allow us to define more than one module per file.  In fact, most, if not
all, Prolog module systems always define a single module per file.  Some
of them mandate that the ‘module/1-2’ directive be the first term in a
source file.  As such, when the Logtalk compiler finds a ‘module/1-2’
directive, it assumes that all code that follows until the end of the
file belongs to the module.


File: TheLogtalkHandbook-3.100.1.info,  Node: Encapsulating plain Prolog code in objects,  Next: Converting Prolog modules into objects,  Prev: Source files with both Prolog code and Logtalk code,  Up: Prolog integration and migration

1.21.2 Encapsulating plain Prolog code in objects
-------------------------------------------------

Most applications consist of several plain Prolog source files, each one
defining a few top-level predicates and auxiliary predicates that are
not meant to be directly called by the user.  Encapsulating plain Prolog
code in objects allows us to make clear the different roles of each
predicate, to hide implementation details, to prevent auxiliary
predicates from being called outside the object, and to take advantage
of Logtalk advanced code encapsulating and reusing features.  It also
simplifies using its developer tools.

Encapsulating Prolog code using Logtalk objects is simple.  First, for
each source file, add an opening object directive, *note object/1-5: 9a,
to the beginning of the file and an ending object directive, *note
end_object/0: 9b, to the end of the file.  Choose an object name that
reflects the purpose of the source file code (this is a good opportunity
for code refactoring if necessary).  Second, add *note public/1: 143.
predicate directives for the top-level predicates that are used directly
by the user or called from other source files.  Third, we need to be
able to call from inside an object predicates defined in other source
files/objects.  The easiest solution, which has the advantage of not
requiring any changes to the predicate definitions, is to use the *note
uses/2: 4b. directive.  If your Prolog compiler supports
cross-referencing tools, you may use them to help you make sure that all
calls to predicates on other source files/objects are listed in the
*note uses/2: 4b. directives.  The Logtalk ‘wrapper’ tool can also help
in detecting cross-predicate calls.  Compiling the resulting objects
with the Logtalk *note unknown_predicates: 2c1. and *note portability:
1d1. flags set to ‘warning’ will help you identify calls to predicates
defined in other converted source files and possible portability issues.

* Menu:

* Prolog multifile predicates::


File: TheLogtalkHandbook-3.100.1.info,  Node: Prolog multifile predicates,  Up: Encapsulating plain Prolog code in objects

1.21.2.1 Prolog multifile predicates
....................................

Prolog 'multifile' predicates are used when clauses for the same
predicate are spread among several source files.  When encapsulating
plain Prolog code that uses multifile predicates, it’s often the case
that the clauses of the multifile predicates get spread between
different objects and categories, but conversion is straight-forward.
In the Logtalk object (or category) holding the multifile predicate
*note primary declaration: 392, add a *note predicate scope directive:
13f. and a *note multifile/1: 16a. directive.  In all other objects (or
categories) defining clauses for the multifile predicate, add a
‘multifile/1’ directive and predicate clauses using the format:

     :- multifile(Entity::Name/Arity).

     Entity::Functor(...) :-
         ...

See the *note section: 16a. on the ‘multifile/1’ predicate directive for
more information.  An alternative solution is to simply keep the clauses
for the multifile predicates as plain Prolog code and define, if
necessary, a parametric object to encapsulate all predicates working
with the multifile predicate clauses.  For example, assume the following
‘multifile/1’ directive:

     % city(Name, District, Population, Neighbors)
     :- multifile(city/4).

We can define a parametric object with ‘city/4’ as its identifier:

     :- object(city(_Name, _District, _Population, _Neighbors)).

         % predicates for working with city/4 clauses

     :- end_object.

This solution is preferred when the multifile predicates are used to
represent large tables of data.  See the section on *note parametric
objects: 66. for more details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Converting Prolog modules into objects,  Next: Compiling Prolog modules as objects,  Prev: Encapsulating plain Prolog code in objects,  Up: Prolog integration and migration

1.21.3 Converting Prolog modules into objects
---------------------------------------------

Converting Prolog modules into objects may allow an application to run
on a wider range of Prolog compilers, overcoming portability problems.
Some Prolog compilers don’t support a module system.  Among those Prolog
compilers that support a module system, the lack of standardization
leads to several issues, notably with semantics, operators, and
meta-predicates.  In addition, the conversion allows you to take
advantage of Logtalk more powerful abstraction and reuse mechanisms,
such as separation between interface and implementation, inheritance,
parametric objects, and categories.  It also allows you to take full
advantage of Logtalk developer tools for improved productivity.

Converting a Prolog module into an object is simplified when the
directives used in the module are supported by Logtalk (see the listing
in the next section).  Assuming that this is the case, apply the
following steps:

  1. Convert the module ‘module/1’ directive into an *note object/1: 9a.
     opening object directive, using the module name as the object name.
     For ‘module/2’ directives apply the same conversion and convert the
     list of exported predicates into *note public/1: 143. predicate
     directives.  Add a closing object directive, *note end_object/0:
     9b, at the end of the source code.

  2. Convert any ‘export/1’ directives into ‘public/1’ predicate
     directives.

  3. Convert any ‘use_module/1’ directives for modules that will not be
     converted to objects into ‘use_module/2’ directives (see next
     section), replacing the file spec in the first argument with the
     module name.

  4. Convert any ‘use_module/1-2’ directives referencing other modules
     also being converted to objects into Logtalk *note uses/2: 4b.
     directives.

  5. Convert each ‘reexport/1’ directive into a *note uses/2: 4b.
     directive and ‘public/1’ predicate directives (see next section).

  6. Convert any ‘meta_predicate/1’ directives into Logtalk *note
     meta_predicate/1: 152. directives by replacing the module
     meta-argument indicator, ‘:’, with the Logtalk meta-argument
     indicator ‘0’ for goal meta-arguments.  For closure meta-arguments,
     use an integer denoting the number of additional arguments that
     will be appended to construct a goal.  Arguments that are not
     meta-arguments are represented by the ‘*’ character.  Do not use
     argument mode indicators such as ‘?’, or ‘+’, or ‘-’ as Logtalk
     supports *note mode directives: 148.

  7. Convert any explicit qualified calls to module predicates to
     messages by replacing the ‘(:)/2’ operator with the *note (;;)/2:
     7e. message-sending operator when the referenced modules are also
     being converted into objects.  Calls in the pseudo-module ‘user’
     can be encapsulated using the *note {}/1: 191. Logtalk external
     call control construct.  You can also use instead a *note uses/2:
     4b. directive where the first argument would be the atom ‘user’ and
     the second argument a list of all external predicates.  This
     alternative has the advantages of not requiring changes to the code
     making the predicate calls and of better visibility for the
     documenting and diagramming tools.

  8. If your module uses the database built-in predicates to implement
     module-local mutable state using dynamic predicates, add both *note
     private/1: 145. and *note dynamic/1: 15a. directives for each
     dynamic predicate.

  9. If your module declares or defines clauses for multifile module
     predicates, replace the ‘(:)/2’ functor by ‘(::)/2’ in the
     ‘multifile/1’ directives and in the clause heads for all modules
     defining the multifile predicates that are also being converted
     into objects; if that is not the case, just keep the ‘multifile/1’
     directives and the clause heads as-is.

  10. Compile the resulting objects with the Logtalk *note
     unknown_predicates: 2c1, and *note portability: 1d1. flags set to
     ‘warning’ to help you locate possible issues and calls to
     proprietary Prolog built-in predicates and to predicates defined on
     other converted modules.  In order to improve code portability,
     check the Logtalk library for possible alternatives to the use of
     proprietary Prolog built-in predicates.

Before converting your modules to objects, you may try to compile them
first as objects (using the *note logtalk_compile/1: 29e. Logtalk
built-in predicates) to help identify any issues that must be dealt with
when doing the conversion to objects.  Note that Logtalk supports
compiling Prolog files as Logtalk source code without requiring changes
to the file name extensions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiling Prolog modules as objects,  Next: Dealing with proprietary Prolog directives and predicates,  Prev: Converting Prolog modules into objects,  Up: Prolog integration and migration

1.21.4 Compiling Prolog modules as objects
------------------------------------------

A possible alternative to porting Prolog code to Logtalk is to compile
the Prolog source files using the ‘logtalk_load/1-2’ and
‘logtalk_compile/1-2’ predicates.  The Logtalk compiler provides partial
support for compiling Prolog modules as Logtalk objects.  This support
may allow using modules from a backend Prolog system in a different
backend Prolog system, although its main purpose is to help in porting
existing Prolog code to Logtalk in order to benefit from its extended
language features and its developer tools.  Why partial support?
Although there is an ISO Prolog standard for modules, it is (rightfully)
ignored by most implementers and vendors (due to its flaws and deviation
from common practice).  In addition, there is no de facto standard for
module systems, despite otherwise frequent misleading claims.  Key
system differences include the set of implemented module directives, the
directive semantics, the handling of operators, the locality of flags,
and the integration of term-expansion mechanisms (when provided).
Another potential issue is that, when compiling modules as objects,
Logtalk assumes that any referenced module (e.g., using ‘use_module/1-2’
directives) is also being compiled as an object.  If that’s not the
case, the compiled module calls being compiled as message-sending goals
will still work for normal predicates but will not work for
meta-predicates called using implicit module qualification.  The reason
is that, unlike in Logtalk, calls to implicitly and explicitly qualified
module meta-predicates have different semantics.  Follows a discussion
of other limitations of this approach that you should be aware of.

* Menu:

* Supported module directives::
* Unsupported module directives::
* Modules using a term-expansion mechanism::
* File search paths::


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported module directives,  Next: Unsupported module directives,  Up: Compiling Prolog modules as objects

1.21.4.1 Supported module directives
....................................

Currently, Logtalk supports the following module directives:

‘module/1’

     The module name becomes the object name.

‘module/2’

     The module name becomes the object name.  The exported predicates
     become public object predicates.  The exported grammar rule
     non-terminals become public grammar rule non-terminals.  The
     exported operators become public object operators but are not
     active elsewhere when loading the code.

‘use_module/2’

     This directive is compiled as a Logtalk *note uses/2: 4b. directive
     in order to ensure correct compilation of the module predicate
     clauses.  The first argument of this directive must be the module
     'name' (an atom), not a module file specification (the adapter
     files attempt to use the Prolog dialect level term-expansion
     mechanism to find the module name from the module file
     specification).  Note that the module is not automatically loaded
     by Logtalk (as it would be when compiling the directive using
     Prolog instead of Logtalk; the programmer may also want the
     specified module to be compiled as an object).  The second argument
     must be a predicate indicator (‘Name/Arity’), a grammar rule
     non-terminal indicator (‘Name//Arity’), a operator declaration, or
     a list of predicate indicators, grammar rule non-terminal
     indicators, and operator declarations.  Predicate aliases can be
     declared using the notation ‘Name/Arity as Alias/Arity’ or, in
     alternative, the notation ‘Name/Arity:Alias/Arity’.  Similar for
     non-terminal aliases.

‘export/1’

     Exported predicates are compiled as public object predicates.  The
     argument must be a predicate indicator (‘Name/Arity’), a grammar
     rule non-terminal indicator (‘Name//Arity’), an operator
     declaration, or a list of predicate indicators, grammar rule
     non-terminal indicators, and operator declarations.

‘reexport/2’

     Reexported predicates are compiled as public object predicates.
     The first argument is the module name.  The second argument must be
     a predicate indicator (‘Name/Arity’), a grammar rule non-terminal
     indicator (‘Name//Arity’), an operator declaration, or a list of
     predicate indicators, grammar rule non-terminal indicators, and
     operator declarations.  Predicate aliases can be declared using the
     notation ‘Name/Arity as Alias/Arity’ or, in alternative, the
     notation ‘Name/Arity:Alias/Arity’.  Similar for non-terminal
     aliases.

‘meta_predicate/1’

     Module meta-predicates become object meta-predicates.  All
     meta-predicates must be declared using the *note meta_predicate/1:
     152. directive using Logtalk syntax for normal arguments and
     meta-arguments.  Note that Prolog module meta-predicates and
     Logtalk meta-predicates don’t share the same explicit-qualification
     calling semantics: in Logtalk, meta-arguments are always called in
     the context of the *note sender: 399.  Moreover, Logtalk is not
     based on the predicate-prefixing mechanism common to most Prolog
     module systems.

A common issue when compiling modules as objects is the use of the atoms
‘dynamic’, ‘discontiguous’, and ‘multifile’ as operators in directives.
For better portability, avoid this usage.  For example, write:

     :- dynamic([foo/1, bar/2]).

instead of:

     :- dynamic foo/1, bar/2.

Another common issue is missing ‘meta_predicate/1’, ‘dynamic/1’,
‘discontiguous/1’, and ‘multifile/1’ predicate directives.  The Logtalk
compiler supports detection of missing directives (by setting its *note
missing_directives: 2c6. flag to ‘warning’).

When compiling modules as objects, you probably don’t need event support
turned on.  You may use the *note events: 89. compiler flag to ‘deny’ in
the Logtalk compiling and loading built-in methods for a small
performance gain for the compiled code.


File: TheLogtalkHandbook-3.100.1.info,  Node: Unsupported module directives,  Next: Modules using a term-expansion mechanism,  Prev: Supported module directives,  Up: Compiling Prolog modules as objects

1.21.4.2 Unsupported module directives
......................................

The ‘reexport/1’ and ‘use_module/1’ directives are not directly
supported by the Logtalk compiler.  But most Prolog adapter files
provide support for compiling these directives using Logtalk’s first
stage of its *note term-expansion mechanism: cb.  Nevertheless, these
directives can be converted, respectively, into a sequence of ‘:-
use_module/2’ and ‘export/1’ directives and ‘use_module/2’ directives by
finding which predicates exported by the specified modules are
reexported or imported into the module containing the directive.  For
‘use_module/1’ directives, finding the names of the imported predicates
that are actually used is easy.  First, comment out the directive and
compile the file (making sure that the *note unknown_predicates: 2c1.
compiler flag is set to ‘warning’).  Logtalk will print a warning with a
list of predicates that are called but never defined.  Second, use this
list to replace the ‘use_module/1’ directives by ‘use_module/2’
directives.  You should then be able to compile the modified Prolog
module as an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modules using a term-expansion mechanism,  Next: File search paths,  Prev: Unsupported module directives,  Up: Compiling Prolog modules as objects

1.21.4.3 Modules using a term-expansion mechanism
.................................................

Although Logtalk supports *note term and goal expansion mechanisms: cb,
the usage semantics are different from similar mechanisms found in some
Prolog compilers.  In particular, Logtalk does not support defining term
and goal expansions clauses in a source file for expanding the source
file itself.  Logtalk forces a clean separation between expansion
clauses and the source files that will be subject to source-to-source
expansions by using *note hook objects: 39e.  But hook objects also
provide a working solution here when the expansion code is separated
from the code to be expanded.  Logtalk supports using a module as a hook
object as long as its name doesn’t coincide with the name of an object
and that the module uses ‘term_expansion/2’ and ‘goal_expansion/2’
predicates.  Assuming that’s the case, before attempting to compile the
modules as objects, set the default hook object to the module containing
the expansion code.  For example, if the expansions are stored in a
‘system’ module:

     | ?- set_logtalk_flag(hook, system).
     ...

This, however, may not be enough, as expansions may be stored in
multiple modules.  A common example is to use a module named ‘prolog’
for system expansions and to store the user-defined expansions in
‘user’.  The Logtalk library provides a solution for these scenarios.
Using the ‘hook_flows’ library we can select multiple hook objects or
hook modules.  For example, assuming expansions stored on both ‘user’
and ‘system’ modules:

     | ?- logtalk_load(hook_flows(loader)).
     ...

     | ?- set_logtalk_flag(hook, hook_set([user, system])).
     ...

After these queries, we can try to compile the modules and look for
other porting or portability issues.  A well-know issue is Prolog module
term-expansions calling predicates such as ‘prolog_load_context/2’,
which will always fail when it’s the Logtalk compiler instead of the
Prolog compiler loading a source file.  In some of these cases, it may
be possible to rewrite the expansion rules to use the *note
logtalk_load_context/2: 317. predicate instead.


File: TheLogtalkHandbook-3.100.1.info,  Node: File search paths,  Prev: Modules using a term-expansion mechanism,  Up: Compiling Prolog modules as objects

1.21.4.4 File search paths
..........................

Some Prolog systems provide a mechanism for defining file search paths
(this mechanism works differently from Logtalk own support for defining
library path aliases).  When porting Prolog code that defines file
search paths, e.g.  for finding module libraries, it often helps to load
the pristine Prolog application before attempting to compile its source
files as Logtalk source files.  Depending on the Prolog backend, this
may allow the file search paths to be used when compiling modules as
objects that use file directives such as ‘use_module/2’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dealing with proprietary Prolog directives and predicates,  Next: Calling Prolog module predicates<2>,  Prev: Compiling Prolog modules as objects,  Up: Prolog integration and migration

1.21.5 Dealing with proprietary Prolog directives and predicates
----------------------------------------------------------------

Most Prolog compilers define proprietary, non-standard directives and
predicates that may be used in both plain code and module code.
Non-standard Prolog built-in predicates are usually not problematic, as
Logtalk is usually able to identify and compile them correctly (but see
the notes on built-in meta-predicates for possible caveats).  However,
Logtalk will generate compilation errors on source files containing
proprietary directives unless you first specify how the directives
should be handled.  Several actions are possible on a per-directive
basis: ignoring the directive (i.e., do not copy the directive, although
a goal can be proved as a consequence), rewriting and copying the
directive to the generated Prolog files, or rewriting and recompiling
the resulting directive.  To specify these actions, the adapter files
contain clauses for the internal ‘'$lgt_prolog_term_expansion'/2’
predicate.  For example, assume that a given Prolog compiler defines a
‘comment/2’ directive for predicates using the format:

     :- comment(foo/2, "Brief description of the predicate").

We can rewrite this predicate into a Logtalk ‘info/2’ directive by
defining a suitable clause for the ‘'$lgt_prolog_term_expansion'/2’
predicate:

     '$lgt_prolog_term_expansion'(
             (:- comment(F/A, String)),
             (:- info(F/A, [comment is Atom]))
     ) :-
         atom_codes(Atom, String).

This Logtalk feature can be used to allow compilation of legacy Prolog
code without the need of changing the sources.  When used, it is
advisable to set the *note portability: 1d1. compiler flag to ‘warning’
in order to more easily identify source files that are likely
non-portable across Prolog compilers.

A second example, where a proprietary Prolog directive is discarded
after triggering a side effect:

     '$lgt_prolog_term_expansion'(
             (:- load_foreign_files(Files,Libs,InitRoutine)),
             []
     ) :-
         load_foreign_files(Files,Libs,InitRoutine).

In this case, although the directive is not copied to the generated
Prolog file, the foreign library files are loaded as a side effect of
the Logtalk compiler calling the ‘'$lgt_prolog_term_expansion'/2’ hook
predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling Prolog module predicates<2>,  Next: Loading converted Prolog applications,  Prev: Dealing with proprietary Prolog directives and predicates,  Up: Prolog integration and migration

1.21.6 Calling Prolog module predicates
---------------------------------------

Prolog module predicates can be called from within objects or categories
by simply using explicit module qualification, i.e.  by writing
‘Module:Goal’ or ‘Goal@Module’ (depending on the module system).
Logtalk also supports the use of ‘use_module/2’ directives in objects
and categories (with the restriction that the first argument of the
directive must be the actual module name and not the module file name or
the module file path).  In this case, these directives are parsed in a
similar way to Logtalk *note uses/2: 4b. directives, with calls to the
specified module predicates being automatically translated to
‘Module:Goal’ calls.

As a general rule, the Prolog modules should be loaded (e.g., in the
auxiliary Logtalk loader files) 'before' compiling objects that make use
of module predicates.  Moreover, the Logtalk compiler does not generate
code for the automatic loading of modules referenced in ‘use_module/1-2’
directives.  This is a consequence of the lack of standardization of
these directives, whose first argument can be a module name, a straight
file name, or a file name using some kind of library notation, depending
on the *note backend Prolog compiler: 34.  Worse, modules are sometimes
defined in files with names different from the module names, requiring
finding, opening, and reading the file in order to find the actual
module name.

Logtalk allows you to send a message to a module in order to call one of
its predicates.  This is usually not advised as it implies a performance
penalty when compared to just using the ‘Module:Call’ notation.
Moreover, this works only if there is no object with the same name as
the module you are targeting.  This feature is necessary, however, in
order to properly support the compilation of modules containing
‘use_module/2’ directives as objects.  If the modules specified in the
‘use_module/2’ directives are not compiled as objects but are instead
loaded as-is by Prolog, the exported predicates would need to be called
using the ‘Module:Call’ notation but the converted module will be
calling them through message-sending.  Thus, this feature ensures that,
on a module compiled as an object, any predicate calling other module
predicates will work as expected, either these other modules are loaded
as-is or also compiled as objects.

For more details, see the *note Calling Prolog predicates: 3e. section.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading converted Prolog applications,  Prev: Calling Prolog module predicates<2>,  Up: Prolog integration and migration

1.21.7 Loading converted Prolog applications
--------------------------------------------

Logtalk strongly favors and advises users to provide a main *note loader
file: 2a4. for applications that explicitly load any required libraries
and the application source files.  In contrast, Prolog applications
often either scatter loading of source files from multiple files or use
implicit loading of source files via ‘use_module/1-2’ directives.  Due
to this frequent ad-hoc approach, it’s common to find Prolog
applications with duplicated loading directives, and where loading order
ignores the dependencies between source files.  These issues are easily
exposed by the Logtalk linter when compiling Prolog files as Logtalk
files.  Also common are Prolog files with multiple circular
dependencies.  While this should not affect the 'semantics' of the
ported code, it may cause some performance penalties as it prevents the
Logtalk compiler from optimizing the message sending goals using
static-binding.  It also makes the application architecture more
difficult to understand.  The definition of explicit loader files
provides a good opportunity for sorting out loading order and circular
dependencies, with the linter warnings providing hints for possible code
refactoring to eliminate these issues.  The *note diagrams: 2ed. tool
supports directory and file loading and dependency diagrams that are
also useful in understanding applications architecture.


File: TheLogtalkHandbook-3.100.1.info,  Node: Reference Manual,  Next: Tutorial,  Prev: User Manual,  Up: Top

2 Reference Manual
******************

* Menu:

* Grammar::
* Control constructs::
* Directives: Directives<2>.
* Built-in predicates::
* Built-in methods: Built-in methods<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Grammar,  Next: Control constructs,  Up: Reference Manual

2.1 Grammar
===========

The Logtalk grammar is here described using W3C-style Extended
Backus-Naur Form syntax.  Non-terminal symbols not defined here can be
found in the ISO Prolog Core standard.  Terminal symbols are represented
between double-quotes.

* Menu:

* Entities::
* Object definition::
* Category definition::
* Protocol definition::
* Entity relations::
* Entity identifiers::
* Source files: Source files<2>.
* Source file names::
* Terms::
* Directives::
* Clauses and goals::
* Lambda expressions: Lambda expressions<2>.
* Entity properties::
* Predicate properties: Predicate properties<2>.
* Compiler flags: Compiler flags<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Entities,  Next: Object definition,  Up: Grammar

2.1.1 Entities
--------------

     entity ::=
        object
        | category
        | protocol


File: TheLogtalkHandbook-3.100.1.info,  Node: Object definition,  Next: Category definition,  Prev: Entities,  Up: Grammar

2.1.2 Object definition
-----------------------

     object ::=
        begin_object_directive ( object_term )* end_object_directive

     begin_object_directive ::=
        ":- object(" object_identifier ( "," object_relations )? ")."

     end_object_directive ::=
        ":- end_object."

     object_relations ::=
        prototype_relations
        | non_prototype_relations

     prototype_relations ::=
        prototype_relation
        | prototype_relation "," prototype_relations

     prototype_relation ::=
        implements_protocols
        | imports_categories
        | extends_objects

     non_prototype_relations ::=
        non_prototype_relation
        | non_prototype_relation "," non_prototype_relations

     non_prototype_relation ::=
        implements_protocols
        | imports_categories
        | instantiates_classes
        | specializes_classes


File: TheLogtalkHandbook-3.100.1.info,  Node: Category definition,  Next: Protocol definition,  Prev: Object definition,  Up: Grammar

2.1.3 Category definition
-------------------------

     category ::=
        begin_category_directive  ( category_term )* end_category_directive

     begin_category_directive ::=
        ":- category(" category_identifier ( "," category_relations )? ")."

     end_category_directive ::=
        ":- end_category."

     category_relations ::=
        category_relation
        | category_relation "," category_relations

     category_relation ::=
        implements_protocols
        | extends_categories
        | complements_objects


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol definition,  Next: Entity relations,  Prev: Category definition,  Up: Grammar

2.1.4 Protocol definition
-------------------------

     protocol ::=
        begin_protocol_directive  ( protocol_directive )* end_protocol_directive

     begin_protocol_directive ::=
        ":- protocol(" protocol_identifier ( "," extends_protocols)? ")."

     end_protocol_directive ::=
        ":- end_protocol."


File: TheLogtalkHandbook-3.100.1.info,  Node: Entity relations,  Next: Entity identifiers,  Prev: Protocol definition,  Up: Grammar

2.1.5 Entity relations
----------------------

     extends_protocols ::=
        "extends(" extended_protocols ")"

     extends_objects ::=
        "extends(" extended_objects ")"

     extends_categories ::=
        "extends(" extended_categories ")"

     implements_protocols ::=
        "implements(" implemented_protocols ")"

     imports_categories ::=
        "imports(" imported_categories ")"

     instantiates_classes ::=
        "instantiates(" instantiated_objects ")"

     specializes_classes ::=
        "specializes(" specialized_objects ")"

     complements_objects ::=
        "complements(" complemented_objects ")"

* Menu:

* Implemented protocols::
* Extended protocols::
* Imported categories::
* Extended objects::
* Extended categories::
* Instantiated objects::
* Specialized objects::
* Complemented objects::
* Entity and predicate scope::


File: TheLogtalkHandbook-3.100.1.info,  Node: Implemented protocols,  Next: Extended protocols,  Up: Entity relations

2.1.5.1 Implemented protocols
.............................

     implemented_protocols ::=
        implemented_protocol
        | implemented_protocol_sequence
        | implemented_protocol_list

     implemented_protocol ::=
        protocol_identifier
        | scope "::" protocol_identifier

     implemented_protocol_sequence ::=
        "(" implemented_protocol ("," implemented_protocol)* ")"

     implemented_protocol_list ::=
        "[" implemented_protocol ("," implemented_protocol)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Extended protocols,  Next: Imported categories,  Prev: Implemented protocols,  Up: Entity relations

2.1.5.2 Extended protocols
..........................

     extended_protocols ::=
        extended_protocol
        | extended_protocol_sequence
        | extended_protocol_list

     extended_protocol ::=
        protocol_identifier
        | scope "::" protocol_identifier

     extended_protocol_sequence ::=
        "(" extended_protocol ("," extended_protocol)* ")"

     extended_protocol_list ::=
        "[" extended_protocol ("," extended_protocol)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Imported categories,  Next: Extended objects,  Prev: Extended protocols,  Up: Entity relations

2.1.5.3 Imported categories
...........................

     imported_categories ::=
        imported_category
        | imported_category_sequence
        | imported_category_list

     imported_category ::=
        category_identifier
        | scope "::" category_identifier

     imported_category_sequence ::=
        "(" imported_category ("," imported_category)* ")"

     imported_category_list ::=
        "[" imported_category ("," imported_category)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Extended objects,  Next: Extended categories,  Prev: Imported categories,  Up: Entity relations

2.1.5.4 Extended objects
........................

     extended_objects ::=
        extended_object
        | extended_object_sequence
        | extended_object_list

     extended_object ::=
        object_identifier
        | scope "::" object_identifier

     extended_object_sequence ::=
        "(" extended_object ("," extended_object)* ")"

     extended_object_list ::=
        "[" extended_object ("," extended_object)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Extended categories,  Next: Instantiated objects,  Prev: Extended objects,  Up: Entity relations

2.1.5.5 Extended categories
...........................

     extended_categories ::=
        extended_category
        | extended_category_sequence
        | extended_category_list

     extended_category ::=
        category_identifier
        | scope "::" category_identifier

     extended_category_sequence ::=
        "(" extended_category ("," extended_category)* ")"

     extended_category_list ::=
        "[" extended_category ("," extended_category)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Instantiated objects,  Next: Specialized objects,  Prev: Extended categories,  Up: Entity relations

2.1.5.6 Instantiated objects
............................

     instantiated_objects ::=
        instantiated_object
        | instantiated_object_sequence
        | instantiated_object_list

     instantiated_object ::=
        object_identifier
        | scope "::" object_identifier

     instantiated_object_sequence ::=
        "(" instantiated_object ("," instantiated_object)* ")"

     instantiated_object_list ::=
        "[" instantiated_object ("," instantiated_object)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Specialized objects,  Next: Complemented objects,  Prev: Instantiated objects,  Up: Entity relations

2.1.5.7 Specialized objects
...........................

     specialized_objects ::=
        specialized_object
        | specialized_object_sequence
        | specialized_object_list

     specialized_object ::=
        object_identifier
        | scope "::" object_identifier

     specialized_object_sequence ::=
        "(" specialized_object ("," specialized_object)* ")"

     specialized_object_list ::=
        "[" specialized_object ("," specialized_object)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Complemented objects,  Next: Entity and predicate scope,  Prev: Specialized objects,  Up: Entity relations

2.1.5.8 Complemented objects
............................

     complemented_objects ::=
        object_identifier
        | complemented_object_sequence
        | complemented_object_list

     complemented_object_sequence ::=
        "(" object_identifier ("," object_identifier)* ")"

     complemented_object_list ::=
        "[" object_identifier ("," object_identifier)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Entity and predicate scope,  Prev: Complemented objects,  Up: Entity relations

2.1.5.9 Entity and predicate scope
..................................

     scope ::=
        "public"
        | "protected"
        | "private"


File: TheLogtalkHandbook-3.100.1.info,  Node: Entity identifiers,  Next: Source files<2>,  Prev: Entity relations,  Up: Grammar

2.1.6 Entity identifiers
------------------------

     entity_identifier ::=
        object_identifier
        | protocol_identifier
        | category_identifier

* Menu:

* Object identifiers::
* Category identifiers::
* Protocol identifiers::
* Module identifiers::


File: TheLogtalkHandbook-3.100.1.info,  Node: Object identifiers,  Next: Category identifiers,  Up: Entity identifiers

2.1.6.1 Object identifiers
..........................

     object_identifier ::=
        atom
        | compound


File: TheLogtalkHandbook-3.100.1.info,  Node: Category identifiers,  Next: Protocol identifiers,  Prev: Object identifiers,  Up: Entity identifiers

2.1.6.2 Category identifiers
............................

     category_identifier ::=
        atom
        | compound


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol identifiers,  Next: Module identifiers,  Prev: Category identifiers,  Up: Entity identifiers

2.1.6.3 Protocol identifiers
............................

     protocol_identifier ::=
        atom


File: TheLogtalkHandbook-3.100.1.info,  Node: Module identifiers,  Prev: Protocol identifiers,  Up: Entity identifiers

2.1.6.4 Module identifiers
..........................

     module_identifier ::=
        atom


File: TheLogtalkHandbook-3.100.1.info,  Node: Source files<2>,  Next: Source file names,  Prev: Entity identifiers,  Up: Grammar

2.1.7 Source files
------------------

     source_file ::=
        ( source_file_content )*

     source_file_content ::=
        source_file_directive
        | clause
        | grammar_rule
        | entity


File: TheLogtalkHandbook-3.100.1.info,  Node: Source file names,  Next: Terms,  Prev: Source files<2>,  Up: Grammar

2.1.8 Source file names
-----------------------

     source_file_name ::=
        atom
        | library_source_file_name

     library_source_file_name ::=
        library_name "(" atom ")"

     library_name ::=
        atom


File: TheLogtalkHandbook-3.100.1.info,  Node: Terms,  Next: Directives,  Prev: Source file names,  Up: Grammar

2.1.9 Terms
-----------

* Menu:

* Object terms::
* Category terms::


File: TheLogtalkHandbook-3.100.1.info,  Node: Object terms,  Next: Category terms,  Up: Terms

2.1.9.1 Object terms
....................

     object_term ::=
        object_directive
        | clause
        | grammar_rule


File: TheLogtalkHandbook-3.100.1.info,  Node: Category terms,  Prev: Object terms,  Up: Terms

2.1.9.2 Category terms
......................

     category_term ::=
        category_directive
        | clause
        | grammar_rule


File: TheLogtalkHandbook-3.100.1.info,  Node: Directives,  Next: Clauses and goals,  Prev: Terms,  Up: Grammar

2.1.10 Directives
-----------------

* Menu:

* Source file directives::
* Conditional compilation directives::
* Object directives: Object directives<2>.
* Category directives: Category directives<2>.
* Protocol directives: Protocol directives<2>.
* Predicate directives::


File: TheLogtalkHandbook-3.100.1.info,  Node: Source file directives,  Next: Conditional compilation directives,  Up: Directives

2.1.10.1 Source file directives
...............................

     source_file_directive ::=
        ":- encoding(" atom ")."
        | ":- set_logtalk_flag(" atom "," nonvar ")."
        | ":- include(" source_file_name ")."
        | prolog_directive


File: TheLogtalkHandbook-3.100.1.info,  Node: Conditional compilation directives,  Next: Object directives<2>,  Prev: Source file directives,  Up: Directives

2.1.10.2 Conditional compilation directives
...........................................

     conditional_compilation_directive ::=
        ":- if(" callable ")."
        | ":- elif(" callable ")."
        | ":- else."
        | ":- endif."


File: TheLogtalkHandbook-3.100.1.info,  Node: Object directives<2>,  Next: Category directives<2>,  Prev: Conditional compilation directives,  Up: Directives

2.1.10.3 Object directives
..........................

     object_directive ::=
        ":- initialization(" callable ")."
        | ":- built_in."
        | ":- threaded."
        | ":- dynamic."
        | ":- info(" entity_info_list ")."
        | ":- set_logtalk_flag(" atom "," nonvar ")."
        | ":- include(" source_file_name ")."
        | ":- uses(" object_alias_list ")."
        | ":- use_module(" module_alias_list ")."
        | conditional_compilation_directive
        | predicate_directive


File: TheLogtalkHandbook-3.100.1.info,  Node: Category directives<2>,  Next: Protocol directives<2>,  Prev: Object directives<2>,  Up: Directives

2.1.10.4 Category directives
............................

     category_directive ::=
        ":- built_in."
        | ":- dynamic."
        | ":- info(" entity_info_list ")."
        | ":- set_logtalk_flag(" atom "," nonvar ")."
        | ":- include(" source_file_name ")."
        | ":- uses(" object_alias_list ")."
        | ":- use_module(" module_alias_list ")."
        | conditional_compilation_directive
        | predicate_directive


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol directives<2>,  Next: Predicate directives,  Prev: Category directives<2>,  Up: Directives

2.1.10.5 Protocol directives
............................

     protocol_directive ::=
        ":- built_in."
        | ":- dynamic."
        | ":- info(" entity_info_list ")."
        | ":- set_logtalk_flag(" atom "," nonvar ")."
        | ":- include(" source_file_name ")."
        | conditional_compilation_directive
        | predicate_directive


File: TheLogtalkHandbook-3.100.1.info,  Node: Predicate directives,  Prev: Protocol directives<2>,  Up: Directives

2.1.10.6 Predicate directives
.............................

     predicate_directive ::=
        alias_directive
        | synchronized_directive
        | uses_directive
        | use_module_directive
        | scope_directive
        | mode_directive
        | mode_non_terminal_directive
        | meta_predicate_directive
        | meta_non_terminal_directive
        | info_directive
        | dynamic_directive
        | discontiguous_directive
        | multifile_directive
        | coinductive_directive
        | operator_directive

     alias_directive ::=
        ":- alias(" entity_identifier "," alias_directive_resource_list ")."

     synchronized_directive ::=
        ":- synchronized(" synchronized_directive_resource_term ")."

     uses_directive ::=
        ":- uses(" ( object_identifier | parameter_variable ) "," uses_directive_resource_list ")."

     use_module_directive ::=
        ":- use_module(" ( module_identifier | parameter_variable ) "," use_module_directive_resource_list ")."

     scope_directive ::=
        ":- public(" scope_directive_resource_term ")."
        | ":- protected(" scope_directive_resource_term ")."
        | ":- private(" scope_directive_resource_term ")."

     mode_directive ::=
        ":- mode(" predicate_mode_term "," number_of_proofs ")."

     mode_non_terminal_directive ::=
        ":- mode_non_terminal(" non_terminal_mode_term "," number_of_proofs ")."

     meta_predicate_directive ::=
        ":- meta_predicate(" meta_predicate_template_term ")."

     meta_non_terminal_directive ::=
        ":- meta_non_terminal(" meta_non_terminal_template_term ")."

     info_directive ::=
        ":- info(" ( predicate_indicator | non_terminal_indicator ) "," predicate_info_list ")."

     dynamic_directive ::=
        ":- dynamic(" qualified_directive_resource_term ")."

     discontiguous_directive ::=
        ":- discontiguous(" qualified_directive_resource_term ")."

     multifile_directive ::=
        ":- multifile(" qualified_directive_resource_term ")."

     coinductive_directive ::=
        ":- coinductive(" ( predicate_indicator_term | coinductive_predicate_template_term ) ")."

     parameter_variable ::=
        _variable_

     scope_directive_resource_term ::=
        scope_directive_resource
        | scope_directive_resource_sequence
        | scope_directive_resource_list

     scope_directive_resource ::=
        predicate_indicator
        | non_terminal_indicator
        | operator

     scope_directive_resource_sequence ::=
        "(" scope_directive_resource ("," scope_directive_resource)* ")"

     scope_directive_resource_list ::=
        "[" scope_directive_resource ("," scope_directive_resource)* "]"

     entity_resources_list ::=
        predicate_indicator_list
        | operator_list

     predicate_indicator_term ::=
        predicate_indicator
        | predicate_indicator_sequence
        | predicate_indicator_list

     predicate_indicator_sequence ::=
        "(" predicate_indicator ("," predicate_indicator)* ")"

     predicate_indicator_list ::=
        "[" predicate_indicator ("," predicate_indicator)* "]"

     alias_directive_resource ::=
        predicate_indicator_alias
        | non_terminal_indicator_alias

     alias_directive_resource_sequence ::=
        "(" alias_directive_resource ("," alias_directive_resource)* ")"

     alias_directive_resource_list ::=
        "[" alias_directive_resource ("," alias_directive_resource)* "]"

     synchronized_directive_resource_term ::=
        synchronized_directive_resource
        | synchronized_directive_resource_sequence
        | synchronized_directive_resource_list

     synchronized_directive_resource ::=
        predicate_indicator
        | non_terminal_indicator

     synchronized_directive_resource_sequence ::=
        "(" synchronized_directive_resource ("," synchronized_directive_resource)* ")"

     synchronized_directive_resource_list ::=
        "[" synchronized_directive_resource ("," synchronized_directive_resource)* "]"

     uses_directive_resource ::=
        predicate_indicator_alias
        | non_terminal_indicator_alias
        | predicate_indicator
        | non_terminal_indicator
        | predicate_template_alias
        | operator

     uses_directive_resource_sequence ::=
        "(" uses_directive_resource ("," uses_directive_resource)* ")"

     uses_directive_resource_list ::=
        "[" uses_directive_resource ("," uses_directive_resource)* "]"

     use_module_directive_resource ::=
        predicate_indicator_alias
        | non_terminal_indicator_alias
        | predicate_indicator
        | non_terminal_indicator
        | predicate_template_alias
        | operator

     use_module_directive_resource_sequence ::=
        "(" use_module_directive_resource ("," use_module_directive_resource)* ")"

     use_module_directive_resource_list ::=
        "[" use_module_directive_resource ("," use_module_directive_resource)* "]"

     qualified_directive_resource_term ::=
        qualified_directive_resource
        | qualified_directive_resource_sequence
        | qualified_directive_resource_list

     qualified_directive_resource_sequence ::=
        "(" qualified_directive_resource_term ("," qualified_directive_resource_term)* ")"

     qualified_directive_resource_list ::=
        "[" qualified_directive_resource_term ("," qualified_directive_resource_term)* "]"

     qualified_directive_resource ::=
        predicate_indicator
        | non_terminal_indicator
        | object_identifier "::" ( predicate_indicator | non_terminal_indicator)
        | category_identifier "::" ( predicate_indicator | non_terminal_indicator)
        | module_identifier ":" ( predicate_indicator | non_terminal_indicator)

     predicate_indicator_alias ::=
        predicate_indicator "as" predicate_indicator

     predicate_template_alias ::=
        callable "as" callable

     non_terminal_indicator ::=
        functor "//" arity

     non_terminal_indicator_alias ::=
        non_terminal_indicator "as" non_terminal_indicator

     operator_sequence ::=
        operator specification
        | operator specification "," operator_sequence

     operator_list ::=
        "[" operator_sequence "]"

     coinductive_predicate_template_term ::=
        coinductive_predicate_template
        | coinductive_predicate_template_sequence
        | coinductive_predicate_template_list

     coinductive_predicate_template_sequence ::=
        "(" coinductive_predicate_template ("," coinductive_predicate_template)* ")"

     coinductive_predicate_template_list ::=
        "[" coinductive_predicate_template ("," coinductive_predicate_template)* "]"

     coinductive_predicate_template ::=
        atom "(" coinductive_mode_terms ")"

     coinductive_mode_terms ::=
        coinductive_mode_term
        | coinductive_mode_terms "," coinductive_mode_terms

     coinductive_mode_term ::=
        "+"
        | "-"

     predicate_mode_term ::=
        atom "(" mode_terms ")"

     non_terminal_mode_term ::=
        atom "(" mode_terms ")"

     mode_terms ::=
        mode_term
        |mode_term "," mode_terms

     mode_term ::=
        "@"  type?
        | "+" type?
        | "-" type?
        | "?" type?
        | "++" type?
        | "--" type?

     type ::=
        prolog_type | logtalk_type | user_defined_type

     prolog_type ::=
        "term"
        | "nonvar"
        | "var"
        | "compound"
        | "ground"
        | "callable"
        | "list"
        | "atomic"
        | "atom"
        | "number"
        | "integer"
        | "float"

     logtalk_type ::=
        "object"
        | "category"
        | "protocol"
        | "event"

     user_defined_type ::=
        atom
        | compound

     number_of_proofs ::=
        "zero"
        | "zero_or_one"
        | "zero_or_more"
        | "one"
        | "one_or_more"
        | "zero_or_error"
        | "one_or_error"
        | "zero_or_one_or_error"
        | "zero_or_more_or_error"
        | "one_or_more_or_error"
        | "error"

     meta_predicate_template_term ::=
        meta_predicate_template
        | meta_predicate_template_sequence
        | meta_predicate_template_list

     meta_predicate_template_sequence ::=
        "(" meta_predicate_template ("," meta_predicate_template)* ")"

     meta_predicate_template_list ::=
        "[" meta_predicate_template ("," meta_predicate_template)* "]"

     meta_predicate_template ::=
        object_identifier "::" atom "(" meta_predicate_specifiers ")"
        | category_identifier "::" atom "(" meta_predicate_specifiers ")"
        | module_identifier ":" atom "(" meta_predicate_specifiers ")"
        | atom "(" meta_predicate_specifiers ")"

     meta_predicate_specifiers ::=
        meta_predicate_specifier
        | meta_predicate_specifier "," meta_predicate_specifiers

     meta_predicate_specifier ::=
        non_negative_integer
        | "::"
        | "^"
        | "*"

     meta_non_terminal_template_term ::=
        meta_predicate_template_term

     entity_info_pair ::=
        entity_info_item "is" nonvar

     entity_info_list ::=
        "[" entity_info_pair ("," entity_info_pair)* "]"

     entity_info_item ::=
        "comment"
        | "remarks"
        | "author"
        | "version"
        | "date"
        | "copyright"
        | "license"
        | "parameters"
        | "parnames"
        | "see_also"
        | atom

     predicate_info_pair ::=
        predicate_info_item "is" nonvar

     predicate_info_list ::=
        "[" predicate_info_pair ("," predicate_info_pair)* "]"

     predicate_info_item ::=
        "comment"
        | "remarks"
        | "arguments"
        | "argnames"
        | "redefinition"
        | "allocation"
        | "examples"
        | "exceptions"
        | "see_also"
        | atom

     object_alias ::=
        object_identifier "as" object_identifier

     object_alias_list ::=
        "[" object_alias ("," object_alias)* "]"

     module_alias ::=
        module_identifier "as" module_identifier

     module_alias_list ::=
        "[" module_alias ("," module_alias)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Clauses and goals,  Next: Lambda expressions<2>,  Prev: Directives,  Up: Grammar

2.1.11 Clauses and goals
------------------------

     clause ::=
        object_identifier "::" head ":-" body
        | module_identifier ":" head ":-" body
        | head ":-" body
        | object_identifier "::" fact
        | module_identifier ":" fact
        | fact

     goal ::=
        message_sending
        | super_call
        | external_call
        | context_switching_call
        | callable

     message_sending ::=
        message_to_object
        | message_delegation
        | message_to_self

     message_to_object ::=
        receiver "::" messages

     message_delegation ::=
        "[" message_to_object "]"

     message_to_self ::=
        "::" messages

     super_call ::=
        "^^" message

     messages ::=
        message
        | "(" message "," messages ")"
        | "(" message ";" messages ")"
        | "(" message "->" messages ")"

     message ::=
        callable
        | variable

     receiver ::=
        "{" callable "}"
        | object_identifier
        | variable

     external_call ::=
        "{" callable "}"

     context_switching_call ::=
        object_identifier "<<" callable


File: TheLogtalkHandbook-3.100.1.info,  Node: Lambda expressions<2>,  Next: Entity properties,  Prev: Clauses and goals,  Up: Grammar

2.1.12 Lambda expressions
-------------------------

     lambda_expression ::=
        lambda_free_variables "/" lambda_parameters ">>" callable
        | lambda_free_variables "/" callable
        | lambda_parameters ">>" callable

     lambda_free_variables ::=
        "{" variables? "}"

     lambda_parameters ::=
        "[" terms? "]"

     variables ::=
        variable
        | variable "," variables

     terms ::=
        term
        | term "," terms


File: TheLogtalkHandbook-3.100.1.info,  Node: Entity properties,  Next: Predicate properties<2>,  Prev: Lambda expressions<2>,  Up: Grammar

2.1.13 Entity properties
------------------------

     category_property ::=
        "static"
        | "dynamic"
        | "built_in"
        | "file(" atom ")"
        | "file(" atom "," atom ")"
        | "lines(" integer "," integer ")"
        | "directive(" integer "," integer ")"
        | "events"
        | "source_data"
        | "public(" entity_resources_list ")"
        | "protected(" entity_resources_list ")"
        | "private(" entity_resources_list ")"
        | "declares(" predicate_indicator "," predicate_declaration_property_list ")"
        | "defines(" predicate_indicator "," predicate_definition_property_list ")"
        | "includes(" predicate_indicator "," ( object_identifier | category_identifier ) "," predicate_definition_property_list ")"
        | "provides(" predicate_indicator "," ( object_identifier | category_identifier ) "," predicate_definition_property_list ")"
        | "references(" reference "," reference_property_list ")"
        | "alias(" ( object_identifier | module_identifier ) "," entity_alias_property_list ")"
        | "alias(" predicate_indicator "," predicate_alias_property_list ")"
        | "calls(" predicate "," predicate_call_update_property_list ")"
        | "updates(" predicate "," predicate_call_update_property_list ")"
        | "number_of_clauses(" integer ")"
        | "number_of_rules(" integer ")"
        | "number_of_user_clauses(" integer ")"
        | "number_of_user_rules(" integer ")"
        | "debugging"

     object_property ::=
        "static"
        | "dynamic"
        | "built_in"
        | "threaded"
        | "file(" atom ")"
        | "file(" atom "," atom ")"
        | "lines(" integer "," integer ")"
        | "directive(" integer "," integer ")"
        | "context_switching_calls"
        | "dynamic_declarations"
        | "events"
        | "source_data"
        | "complements(" ( "allow" | "restrict" ) ")"
        | "complements"
        | "public(" entity_resources_list ")"
        | "protected(" entity_resources_list ")"
        | "private(" entity_resources_list ")"
        | "declares(" predicate_indicator "," predicate_declaration_property_list ")"
        | "defines(" predicate_indicator "," predicate_definition_property_list ")"
        | "includes(" predicate_indicator "," ( object_identifier | category_identifier ) "," predicate_definition_property_list ")"
        | "provides(" predicate_indicator "," ( object_identifier | category_identifier ) "," predicate_definition_property_list ")"
        | "references(" reference "," reference_property_list ")"
        | "alias(" ( object_identifier | module_identifier ) "," entity_alias_property_list ")"
        | "alias(" predicate_indicator "," predicate_alias_property_list ")"
        | "calls(" predicate "," predicate_call_update_property_list ")"
        | "updates(" predicate "," predicate_call_update_property_list ")"
        | "number_of_clauses(" integer ")"
        | "number_of_rules(" integer ")"
        | "number_of_user_clauses(" integer ")"
        | "number_of_user_rules(" integer ")"
        | "module"
        | "debugging"

     protocol_property ::=
        "static"
        | "dynamic"
        | "built_in"
        | "source_data"
        | "file(" atom ")"
        | "file(" atom "," atom ")"
        | "lines(" integer "," integer ")"
        | "directive(" integer "," integer ")"
        | "public(" entity_resources_list ")"
        | "protected(" entity_resources_list ")"
        | "private(" entity_resources_list ")"
        | "declares(" predicate_indicator "," predicate_declaration_property_list ")"
        | "alias(" predicate_indicator "," predicate_alias_property_list ")"
        | "debugging"

     predicate_declaration_property_list ::=
        "[" predicate_declaration_property ("," predicate_declaration_property)* "]"

     predicate_declaration_property ::=
        "static"
        | "dynamic"
        | "scope(" scope ")"
        | "private"
        | "protected"
        | "public"
        | "coinductive"
        | "multifile"
        | "synchronized"
        | "meta_predicate(" meta_predicate_template ")"
        | "coinductive(" coinductive_predicate_template ")"
        | "non_terminal(" non_terminal_indicator ")"
        | "include(" atom ")"
        | "lines(" integer  "," integer ")"
        | "line_count(" integer ")"
        | "mode(" predicate_mode_term "," number_of_proofs ")"
        | "info(" list ")"

     predicate_definition_property_list ::=
        "[" predicate_definition_property ("," predicate_definition_property)* "]"

     predicate_definition_property ::=
        "inline"
        | "auxiliary"
        | "non_terminal(" non_terminal_indicator ")"
        | "include(" atom ")"
        | "lines(" integer  "," integer ")"
        | "line_count(" integer ")"
        | "number_of_clauses(" integer ")"
        | "number_of_rules(" integer ")"

     entity_alias_property_list ::=
        "[" entity_alias_property ("," entity_alias_property)* "]"

     entity_alias_property ::=
        "object"
        | "module"
        | "for(" ( object_identifier | module_identifier ) ")"
        | "include(" atom ")"
        | "lines(" integer  "," integer ")"
        | "line_count(" integer ")"

     predicate_alias_property_list ::=
        "[" predicate_alias_property ("," predicate_alias_property)* "]"

     predicate_alias_property ::=
        "predicate"
        | "for(" predicate_indicator ")"
        | "from(" entity_identifier ")"
        | "non_terminal(" non_terminal_indicator ")"
        | "include(" atom ")"
        | "lines(" integer  "," integer ")"
        | "line_count(" integer ")"

     predicate ::=
        predicate_indicator
        | "^^" predicate_indicator
        | "::" predicate_indicator
        | ( variable | object_identifier ) "::" predicate_indicator
        | ( variable | module_identifier ) ":" predicate_indicator

     predicate_call_update_property_list ::=
        "[" predicate_call_update_property ("," predicate_call_update_property)* "]"

     predicate_call_update_property ::=
        "caller(" predicate_indicator ")"
        | "include(" atom ")"
        | "lines(" integer  "," integer ")"
        | "line_count(" integer ")"
        | "alias(" predicate_indicator ")"
        | "non_terminal(" non_terminal_indicator ")"

     reference ::=
        object_identifier | category_identifier
        | ( object_identifier | category_identifier ) "::" predicate_indicator

     reference_property ::=
        "in(" ( "multifile" | "dynamic" | "discontiguous" | "meta_predicate" | "meta_non_terminal" | "clause" ) ")"
        | "include(" atom ")"
        | "lines(" integer  "," integer ")"
        | "line_count(" integer ")"
        | "non_terminal(" non_terminal_indicator ")"

     reference_property_list ::=
        "[" reference_property ("," reference_property)* "]"


File: TheLogtalkHandbook-3.100.1.info,  Node: Predicate properties<2>,  Next: Compiler flags<2>,  Prev: Entity properties,  Up: Grammar

2.1.14 Predicate properties
---------------------------

     predicate_property ::=
        "static"
        | "dynamic"
        | "scope(" scope ")"
        | "private"
        | "protected"
        | "public"
        | "logtalk"
        | "prolog"
        | "foreign"
        | "coinductive(" coinductive_predicate_template ")"
        | "multifile"
        | "synchronized"
        | "built_in"
        | "inline"
        | "recursive"
        | "declared_in(" entity_identifier ")"
        | "defined_in(" ( object_identifier | category_identifier ) ")"
        | "redefined_from(" ( object_identifier | category_identifier ) ")"
        | "meta_predicate(" meta_predicate_template ")"
        | "alias_of(" callable ")"
        | "alias_declared_in(" entity_identifier ")"
        | "non_terminal(" non_terminal_indicator ")"
        | "mode(" predicate_mode_term "," number_of_proofs ")"
        | "info(" list ")"
        | "number_of_clauses(" integer ")"
        | "number_of_rules(" integer ")"
        | "declared_in(" entity_identifier "," line_count ")"
        | "defined_in(" ( object_identifier | category_identifier ) "," line_count ")"
        | "redefined_from(" ( object_identifier | category_identifier ) "," line_count ")"
        | "alias_declared_in(" entity_identifier "," line_count ")"

     line_count ::=
        integer


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiler flags<2>,  Prev: Predicate properties<2>,  Up: Grammar

2.1.15 Compiler flags
---------------------

     compiler_flag ::=
        flag "(" flag_value ")"


File: TheLogtalkHandbook-3.100.1.info,  Node: Control constructs,  Next: Directives<2>,  Prev: Grammar,  Up: Reference Manual

2.2 Control constructs
======================

* Menu:

* Message sending: Message sending<2>.
* Message delegation::
* Calling imported and inherited predicates: Calling imported and inherited predicates<2>.
* Calling predicates in this::
* Calling external predicates::
* Context switching calls::


File: TheLogtalkHandbook-3.100.1.info,  Node: Message sending<2>,  Next: Message delegation,  Up: Control constructs

2.2.1 Message sending
---------------------

'control construct'

* Menu:

* (;;)/2: /2.
* (;;)/1: /1.


File: TheLogtalkHandbook-3.100.1.info,  Node: /2,  Next: /1,  Up: Message sending<2>

2.2.1.1 ‘(::)/2’
................

* Menu:

* Description::
* Modes and number of proofs::
* Errors::
* Examples: Examples<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description,  Next: Modes and number of proofs,  Up: /2

2.2.1.2 Description
...................

     Object::Message
     {Proxy}::Message

Sends a message to an object.  The message argument must match a *note
public: 143. predicate of the receiver object.  When the message
corresponds to a *note protected: 144. or *note private: 145. predicate,
the call is only valid if the *note sender: 399. matches the *note
predicate scope container: 3f9.  When the predicate is declared but not
defined, the message simply fails (as per the *note closed-world
assumption: 6a.).

When the predicate used to answer the message is a *note meta-predicate:
52, the *note calling context: 150. for the predicate meta-arguments is
the object sending the message.

The ‘{Proxy}::Message’ syntax allows simplified access to *note
parametric object proxies: 3fa.  Its operational semantics is equivalent
to the conjunction ‘(call(Proxy), Proxy::Message)’.  I.e.  ‘Proxy’ is
proved within the context of the pseudo-object *note user: cf. and, if
successful, the ‘Proxy’ term is used as an object identifier.
Exceptions thrown when proving ‘Proxy’ are handled by the ‘(::)/2’
control construct.  This control construct supports backtracking over
the ‘{Proxy}’ goal.

The lookups for the message declaration and the corresponding method are
performed using a depth-first strategy.  Depending on the value of the
*note optimize: 8c. flag, these lookups are performed at compile-time
whenever sufficient information is available.  When the lookups are
performed at runtime, a caching mechanism is used to improve performance
for subsequent messages.  See the User Manual section on *note
performance: 38. for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs,  Next: Errors,  Prev: Description,  Up: /2

2.2.1.3 Modes and number of proofs
..................................

     +object_identifier::+callable - zero_or_more
     {+object_identifier}::+callable - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors,  Next: Examples<2>,  Prev: Modes and number of proofs,  Up: /2

2.2.1.4 Errors
..............

     Either ‘Object’ or ‘Message’ is a variable:
          ‘instantiation_error’
     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Message’ is neither a variable nor a callable term:
          ‘type_error(callable, Message)’
     ‘Message’, with predicate indicator ‘Name/Arity’, is declared private:
          ‘permission_error(access, private_predicate, Name/Arity)’
     ‘Message’, with predicate indicator ‘Name/Arity’, is declared protected:
          ‘permission_error(access, protected_predicate, Name/Arity)’
     ‘Message’, with predicate indicator ‘Name/Arity’, is not declared:
          ‘existence_error(predicate_declaration, Name/Arity)’
     ‘Object’ does not exist:
          ‘existence_error(object, Object)’
          
     ‘Proxy’ is a variable:
          ‘instantiation_error’
     ‘Proxy’ is neither a variable nor a callable term:
          ‘type_error(callable, Proxy)’
     ‘Proxy’, with predicate indicator ‘Name/Arity’, does not exist in the ‘user’ pseudo-object:
          ‘existence_error(procedure, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<2>,  Prev: Errors,  Up: /2

2.2.1.5 Examples
................

     | ?- list::member(X, [1, 2, 3]).

     X = 1 ;
     X = 2 ;
     X = 3
     yes

See also
........

*note (;;)/1: 5c, *note (^^)/1: 5d, *note []/1: 81.

'control construct'


File: TheLogtalkHandbook-3.100.1.info,  Node: /1,  Prev: /2,  Up: Message sending<2>

2.2.1.6 ‘(::)/1’
................

* Menu:

* Description: Description<2>.
* Modes and number of proofs: Modes and number of proofs<2>.
* Errors: Errors<2>.
* Examples: Examples<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<2>,  Next: Modes and number of proofs<2>,  Up: /1

2.2.1.7 Description
...................

     ::Message

Sends a message to *note self: 69.  Can only be used in the body of a
predicate definition.  The argument should match a *note public: 143. or
*note protected: 144. predicate of 'self'.  It may also match a *note
private: 145. predicate if the predicate is within the scope of the
object where the method making the call is defined, if imported from a
category, if used from within a category, or when using private
inheritance.  When the predicate is declared but not defined, the
message simply fails (as per the *note closed-world assumption: 6a.).

When the predicate used to answer the message is a *note meta-predicate:
52, the *note calling context: 150. for the predicate meta-arguments is
the object sending the message.

The lookups for the message declaration and the corresponding method are
performed using a depth-first strategy.  A message to 'self' necessarily
implies the use of *note dynamic binding: 36. but a caching mechanism is
used to improve performance in subsequent messages.  See the User Manual
section on *note performance: 38. for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<2>,  Next: Errors<2>,  Prev: Description<2>,  Up: /1

2.2.1.8 Modes and number of proofs
..................................

     ::+callable - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<2>,  Next: Examples<3>,  Prev: Modes and number of proofs<2>,  Up: /1

2.2.1.9 Errors
..............

     ‘Message’ is a variable:
          ‘instantiation_error’
     ‘Message’ is neither a variable nor a callable term:
          ‘type_error(callable, Message)’
     ‘Message’, with predicate indicator ‘Name/Arity’, is declared private:
          ‘permission_error(access, private_predicate, Name/Arity)’
     ‘Message’, with predicate indicator ‘Name/Arity’, is not declared:
          ‘existence_error(predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<3>,  Prev: Errors<2>,  Up: /1

2.2.1.10 Examples
.................

     area(Area) :-
         ::width(Width),
         ::height(Height),
         Area is Width * Height.

See also
........

*note (;;)/2: 7e, *note (^^)/1: 5d, *note []/1: 81.


File: TheLogtalkHandbook-3.100.1.info,  Node: Message delegation,  Next: Calling imported and inherited predicates<2>,  Prev: Message sending<2>,  Up: Control constructs

2.2.2 Message delegation
------------------------

'control construct'

* Menu:

* []/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: []/1,  Up: Message delegation

2.2.2.1 ‘[]/1’
..............

* Menu:

* Description: Description<3>.
* Modes and number of proofs: Modes and number of proofs<3>.
* Errors: Errors<3>.
* Examples: Examples<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<3>,  Next: Modes and number of proofs<3>,  Up: []/1

2.2.2.2 Description
...................

     [Object::Message]
     [{Proxy}::Message]

This control construct allows the programmer to send a message to an
object while preserving the original sender and meta-call context.  It
is mainly used in the definition of object handlers for unknown
messages.  This functionality is usually known as 'delegation' but be
aware that this is an overloaded word that can mean different things in
different object-oriented programming languages.

To prevent the use of this control construct to break object
encapsulation, an attempt to delegate a message to the original sender
results in an error.  The remaining error conditions are the same as the
*note (;;)/2: 7e. control construct.

Note that, despite the correct functor for this control construct being
(traditionally) ‘'.'/2’, we refer to it as ‘[]/1’ simply to emphasize
that the syntax is a list with a single element.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<3>,  Next: Errors<3>,  Prev: Description<3>,  Up: []/1

2.2.2.3 Modes and number of proofs
..................................

     [+object_identifier::+callable] - zero_or_more
     [{+object_identifier}::+callable] - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<3>,  Next: Examples<4>,  Prev: Modes and number of proofs<3>,  Up: []/1

2.2.2.4 Errors
..............

     ‘Object’ is a variable:
          ‘instantiation_error’
     Object is neither a variable nor an object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Object’ does not exist:
          ‘existence_error(object, Object)’
     ‘Object’ and the original 'sender' are the same object:
          ‘permission_error(access, object, Sender)’
          
     ‘Proxy’ is a variable:
          ‘instantiation_error’
     ‘Proxy’ is neither a variable nor an object identifier:
          ‘type_error(object_identifier, Proxy)’
     ‘Proxy’, with predicate indicator ‘Name/Arity’, does not exist in the ‘user’ pseudo-object:
          ‘existence_error(procedure, Name/Arity)’
          
     ‘Message’ is a variable:
          ‘instantiation_error’
     ‘Message’ is neither a variable nor a callable term:
          ‘type_error(callable, Message)’
     ‘Message’, with predicate indicator ‘Name/Arity’, is declared private:
          ‘permission_error(access, private_predicate, Name/Arity)’
     ‘Message’, with predicate indicator ‘Name/Arity’, is declared protected:
          ‘permission_error(access, protected_predicate, Name/Arity)’
     ‘Message’, with predicate indicator ‘Name/Arity’, is not declared:
          ‘existence_error(predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<4>,  Prev: Errors<3>,  Up: []/1

2.2.2.5 Examples
................

     % delegate unknown messages to the "backup" object:
     forward(Message) :-
         [backup::Message].

See also
........

*note (;;)/2: 7e, *note (;;)/1: 5c, *note (^^)/1: 5d, *note forward/1:
105.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling imported and inherited predicates<2>,  Next: Calling predicates in this,  Prev: Message delegation,  Up: Control constructs

2.2.3 Calling imported and inherited predicates
-----------------------------------------------

'control construct'

* Menu:

* (^^)/1: ^^ /1.


File: TheLogtalkHandbook-3.100.1.info,  Node: ^^ /1,  Up: Calling imported and inherited predicates<2>

2.2.3.1 ‘(^^)/1’
................

* Menu:

* Description: Description<4>.
* Modes and number of proofs: Modes and number of proofs<4>.
* Errors: Errors<4>.
* Examples: Examples<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<4>,  Next: Modes and number of proofs<4>,  Up: ^^ /1

2.2.3.2 Description
...................

     ^^Predicate

Calls an imported or inherited predicate definition.  The call fails if
the predicate is declared but there is no imported or inherited
predicate definition (as per the *note closed-world assumption: 6a.).
This control construct may be used within objects or categories in the
body of a predicate definition.

This control construct preserves the implicit execution context *note
self: 69. and *note sender: 399. arguments (plus the meta-call context
and coinduction stack when applicable) when calling the inherited (or
imported) predicate definition.

The lookups for the predicate declaration and the predicate definition
are performed using a depth-first strategy.  Depending on the value of
the *note optimize: 8c. flag, these lookups are performed at
compile-time when the predicate is static and sufficient information is
available.  When the lookups are performed at runtime, a caching
mechanism is used to improve performance in subsequent calls.  See the
User Manual section on *note performance: 38. for details.

When the call is made from within an object, the lookup for the
predicate definition starts at the imported categories, if any.  If an
imported predicate definition is not found, the lookup proceeds to the
ancestor objects.  Calls from predicates defined in complementing
categories lookup inherited definitions as if the calls were made from
the complemented object, thus allowing more comprehensive object
patching.  For other categories, the predicate definition lookup is
restricted to the extended categories.

The called predicate should be declared *note public: 143. or *note
protected: 144.  It may also be declared *note private: 145. if within
the scope of the entity where the method making the call is defined.

This control construct is a generalization of the Smalltalk 'super'
keyword to take into account Logtalk support for prototypes and
categories besides classes.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<4>,  Next: Errors<4>,  Prev: Description<4>,  Up: ^^ /1

2.2.3.3 Modes and number of proofs
..................................

     ^^+callable - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<4>,  Next: Examples<5>,  Prev: Modes and number of proofs<4>,  Up: ^^ /1

2.2.3.4 Errors
..............

     ‘Predicate’ is a variable:
          ‘instantiation_error’
     ‘Predicate’ is neither a variable nor a callable term:
          ‘type_error(callable, Predicate)’
     ‘Predicate’, with predicate indicator ‘Name/Arity’, is declared private:
          ‘permission_error(access, private_predicate, Name/Arity)’
     ‘Predicate’, with predicate indicator ‘Name/Arity’, is not declared:
          ‘existence_error(predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<5>,  Prev: Errors<4>,  Up: ^^ /1

2.2.3.5 Examples
................

     % specialize the inherited definition
     % of the init/0 predicate:
     init :-
         assertz(counter(0)),
         ^^init.

See also
........

*note (;;)/2: 7e, *note (;;)/1: 5c, *note []/1: 81.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling predicates in this,  Next: Calling external predicates,  Prev: Calling imported and inherited predicates<2>,  Up: Control constructs

2.2.4 Calling predicates in 'this'
----------------------------------

'control construct'

* Menu:

* (@)/1: @ /1.


File: TheLogtalkHandbook-3.100.1.info,  Node: @ /1,  Up: Calling predicates in this

2.2.4.1 ‘(@)/1’
...............

* Menu:

* Description: Description<5>.
* Modes and number of proofs: Modes and number of proofs<5>.
* Errors: Errors<5>.
* Examples: Examples<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<5>,  Next: Modes and number of proofs<5>,  Up: @ /1

2.2.4.2 Description
...................

     @Predicate

Calls a predicate definition in *note this: 114.  The argument must be a
callable term at compile-time.  The predicate must be declared (by a
scope directive).  This control construct provides access to predicate
definitions in 'this' from categories.  For example, it allows
overriding a predicate definition from a complementing category with a
new definition that calls goals before and after calling the overridden
definition (the overriding definition is sometimes described in other
programming languages as an 'around method').  When used within an
object, it’s the same as calling its argument.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<5>,  Next: Errors<5>,  Prev: Description<5>,  Up: @ /1

2.2.4.3 Modes and number of proofs
..................................

     @ +callable - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<5>,  Next: Examples<6>,  Prev: Modes and number of proofs<5>,  Up: @ /1

2.2.4.4 Errors
..............

     ‘Predicate’, with predicate indicator ‘Name/Arity’, is not declared:
          ‘existence_error(predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<6>,  Prev: Errors<5>,  Up: @ /1

2.2.4.5 Examples
................

Assuming an object declaring a ‘make_sound/0’ predicate, define an
'around method' in a complementing category:

     make_sound :-
         write('Started making sound...'), nl,
         @make_sound,
         write('... finished making sound.'), nl.

See also
........

*note (;;)/2: 7e, *note (;;)/1: 5c, *note []/1: 81.


File: TheLogtalkHandbook-3.100.1.info,  Node: Calling external predicates,  Next: Context switching calls,  Prev: Calling predicates in this,  Up: Control constructs

2.2.5 Calling external predicates
---------------------------------

'control construct'

* Menu:

* {}/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: {}/1,  Up: Calling external predicates

2.2.5.1 ‘{}/1’
..............

* Menu:

* Description: Description<6>.
* Modes and number of proofs: Modes and number of proofs<6>.
* Errors: Errors<6>.
* Examples: Examples<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<6>,  Next: Modes and number of proofs<6>,  Up: {}/1

2.2.5.2 Description
...................

     {Goal}
     {Closure}
     {Term}

This control construct allows the programmer to bypass the Logtalk
compiler (including its linter but not its optimizer) in multiple
contexts:

   - Calling a goal as-is (from within an object or category) in the
     context of the *note user: cf. pseudo-object.

   - Extending a closure as-is with the remaining arguments of a *note
     call/2-N: 181. call in order to construct a goal that will be
     called within the context of the ‘user’ pseudo-object.

   - Wrapping a source file term (either a clause or a directive) or a
     source file goal to bypass the *note term-expansion mechanism: cb.

   - Using it in place of an object identifier when sending a message.
     In this case, its argument is proved as a goal within the context
     of the ‘user’ pseudo-object with the resulting term being used as
     an object identifier in the message-sending goal.  This feature is
     mainly used with *note parametric objects: 425. when their
     identifiers correspond to predicates defined in ‘user’.

   - Using it as a message to an object.  This is mainly useful when the
     message is a *note conjunction of messages: 84. where some of goals
     are calls to Prolog built-in predicates.

     Note: This control construct is opaque to cuts when used to wrap a
     goal (thus ensuring the same semantics independently of the
     argument being bound at compile-time or at runtime).


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<6>,  Next: Errors<6>,  Prev: Description<6>,  Up: {}/1

2.2.5.3 Modes and number of proofs
..................................

     {+callable} - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<6>,  Next: Examples<7>,  Prev: Modes and number of proofs<6>,  Up: {}/1

2.2.5.4 Errors
..............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
          
     ‘Closure’ is a variable:
          ‘instantiation_error’
     ‘Closure’ is neither a variable nor a callable term:
          ‘type_error(callable, Closure)’
          
     ‘Term’ is a variable:
          ‘instantiation_error’
     ‘Term’ is neither a variable nor a callable term:
          ‘type_error(callable, Term)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<7>,  Prev: Errors<6>,  Up: {}/1

2.2.5.5 Examples
................

     % overload the standard (<)/2 operator by
     % calling its standard built-in definition:
     N1/D1 < N2/D2 :-
         {N1*D2 < N2*D1}.

     % call a closure in the context of "user":
     call_in_user(F, X, Y, Z) :-
         call({F}, X, Y, Z).

     % bypass the compiler for a proprietary backend directive:
     {:- load_foreign_resource(file)}.

     % use parametric object proxies:
     | ?- {circle(Id, Radius, Color)}::area(Area).
     ...

     % use Prolog built-in predicates as messages:
     | ?- logtalk::{write('hello world!'), nl}.
     hello world!
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Context switching calls,  Prev: Calling external predicates,  Up: Control constructs

2.2.6 Context switching calls
-----------------------------

'control construct'

* Menu:

* (<<)/2: << /2.


File: TheLogtalkHandbook-3.100.1.info,  Node: << /2,  Up: Context switching calls

2.2.6.1 ‘(<<)/2’
................

* Menu:

* Description: Description<7>.
* Modes and number of proofs: Modes and number of proofs<7>.
* Errors: Errors<7>.
* Examples: Examples<8>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<7>,  Next: Modes and number of proofs<7>,  Up: << /2

2.2.6.2 Description
...................

     Object<<Goal
     {Proxy}<<Goal

Debugging control construct.  Calls a goal within the context of the
specified object.  The goal is called with the following execution
context:

   - *note sender: 399, *note this: 114, and *note self: 69. values set
     to the object

   - empty meta-call context

   - empty coinduction stack

The goal may need to be written between parenthesis to avoid parsing
errors due to operator conflicts.  This control construct should only be
used for debugging or for writing unit tests.  This control construct
can only be used for objects compiled with the *note
context_switching_calls: 2d9. compiler flag set to ‘allow’.  Set this
compiler flag to ‘deny’ to disable this control construct and thus
prevent using it to break encapsulation when deploying applications.

The ‘{Proxy}<<Goal’ syntax allows simplified access to *note parametric
object proxies: 3fa.  Its operational semantics is equivalent to the
goal conjunction ‘(call(Proxy), Proxy<<Goal)’.  I.e.  ‘Proxy’ is proved
within the context of the pseudo-object *note user: cf. and, if
successful, the goal term is used as a parametric object identifier.
Exceptions thrown when proving ‘Proxy’ are handled by the ‘(<<)/2’
control construct.  This syntax construct supports backtracking over the
‘{Proxy}’ goal.

Caveat: although the goal argument is fully compiled before calling,
some necessary information for the second compiler pass may not be
available at runtime.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<7>,  Next: Errors<7>,  Prev: Description<7>,  Up: << /2

2.2.6.3 Modes and number of proofs
..................................

     +object_identifier<<+callable - zero_or_more
     {+object_identifier}<<+callable - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<7>,  Next: Examples<8>,  Prev: Modes and number of proofs<7>,  Up: << /2

2.2.6.4 Errors
..............

     ‘Object’ is a variable:
          ‘instantiation_error’
     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Object’ does not contain a local definition for the Goal predicate:
          ‘existence_error(procedure, Goal)’
     ‘Object’ does not exist:
          ‘existence_error(object, Object)’
     ‘Object’ was created/compiled with support for context-switching calls turned off:
          ‘permission_error(access, database, Goal)’
          
     ‘Proxy’ is a variable:
          ‘instantiation_error’
     ‘Proxy’ is neither a variable nor an object identifier:
          ‘type_error(object_identifier, Proxy)’
     The predicate ‘Proxy’ does not exist in the ‘user’ pseudo-object:
          ‘existence_error(procedure, ProxyFunctor/ProxyArity)’
          
     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<8>,  Prev: Errors<7>,  Up: << /2

2.2.6.5 Examples
................

     % call the member/2 predicate in the
     % context of the "list" object:
     test(member) :-
         list << member(1, [1]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Directives<2>,  Next: Built-in predicates,  Prev: Control constructs,  Up: Reference Manual

2.3 Directives
==============

* Menu:

* Source file directives: Source file directives<2>.
* Conditional compilation directives: Conditional compilation directives<2>.
* Entity directives::
* Predicate directives: Predicate directives<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Source file directives<2>,  Next: Conditional compilation directives<2>,  Up: Directives<2>

2.3.1 Source file directives
----------------------------

'directive'

* Menu:

* encoding/1::
* include/1::
* initialization/1::
* op/3::
* set_logtalk_flag/2::


File: TheLogtalkHandbook-3.100.1.info,  Node: encoding/1,  Next: include/1,  Up: Source file directives<2>

2.3.1.1 ‘encoding/1’
....................

* Menu:

* Description: Description<8>.
* Template and modes::
* Examples: Examples<9>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<8>,  Next: Template and modes,  Up: encoding/1

2.3.1.2 Description
...................

     encoding(Encoding)

Declares the source file text encoding.  Requires a *note backend Prolog
compiler: 34. supporting the chosen encoding.  When used, this directive
must be the first term in the source file in the first line.  This
directive is also supported in files included in a main file or in a
dynamically created entity using *note include/1: b8. directives.

The encoding used in a source file (and, in the case of a Unicode
encoding, any BOM present) will be used for the intermediate Prolog file
generated by the compiler.  Logtalk uses the encoding names specified by
IANA(1). In those cases where a preferred MIME name alias is specified,
the alias is used instead.  Examples includes ‘'US-ASCII'’,
‘'ISO-8859-1'’, ‘'ISO-8859-2'’, ‘'ISO-8859-15'’, ‘'UCS-2'’, ‘'UCS-2LE'’,
‘'UCS-2BE'’, ‘'UTF-8'’, ‘'UTF-16'’, ‘'UTF-16LE'’, ‘'UTF-16BE'’,
‘'UTF-32'’, ‘'UTF-32LE'’, ‘'UTF-32BE'’, ‘'Shift_JIS'’, and ‘'EUC-JP'’.
When writing portable code that cannot be expressed using ASCII,
‘'UTF-8'’ is the most commonly supported Unicode encoding.

The backend Prolog compiler adapter files define a table that translates
between the Logtalk and Prolog specific atoms that represent each
supported encoding.  The *note encoding_directive: 299. read-only flag
can be used to find if a backend supports this directive and how.

   ---------- Footnotes ----------

   (1) 
http://www.iana.org/assignments/character-sets/character-sets.xhtml


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes,  Next: Examples<9>,  Prev: Description<8>,  Up: encoding/1

2.3.1.3 Template and modes
..........................

     encoding(+atom)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<9>,  Prev: Template and modes,  Up: encoding/1

2.3.1.4 Examples
................

     :- encoding('UTF-8').

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: include/1,  Next: initialization/1,  Prev: encoding/1,  Up: Source file directives<2>

2.3.1.5 ‘include/1’
...................

* Menu:

* Description: Description<9>.
* Template and modes: Template and modes<2>.
* Examples: Examples<10>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<9>,  Next: Template and modes<2>,  Up: include/1

2.3.1.6 Description
...................

     include(File)

Includes a file contents, which must be valid terms, at the place of
occurrence of the directive.  The file can be specified as a relative
path, an absolute path, or using *note library notation: 2a8. and is
expanded as a source file name.  Relative paths are interpreted as
relative to the path of the file containing the directive.  The file
extension is optional (the recognized Logtalk and Prolog file extensions
are defined in the *note backend adapter files: 154.).

When using the *note reflection API: 48, predicates from an included
file can be distinguished from predicates from the main file by looking
for the ‘include/1’ predicate declaration property or the ‘include/1’
predicate definition property.  For the included predicates, the
‘line_count/1’ property stores the term line number in the included
file.

This directive can be used as either a source file directive or an
entity directive.  As an entity directive, it can be used both in
entities defined in source files and with the entity creation built-in
predicates.  In the latter case, the file should be specified using an
absolute path or using library notation (which expands to a full path)
to avoid a fragile dependency on the current working directory.

Included files may contain an *note encoding/1: 298. directive, which
may specify the same encoding of the main file or a different encoding.

     Warning: The use of nested included files (i.e., included files
     including other files) is only partially supported.  Notably, the
     reflection API currently only keeps track of the included files
     dependency on the main file.  Although this allows predicates such
     as ‘logtalk_make/0-1’ to work correctly, it prevents full code
     navigation features in supported IDEs for predicates defined in the
     nested included files.

     When using this directive as an argument in calls to the *note
     create_object/4: 62, *note create_category/4: 11a, and *note
     create_protocol/3: e3. built-in predicates, the objects,
     categories, and protocols will not be recreated or redefined when
     the included file(s) are modified and the *note logtalk_make/0:
     29f. predicate or the *note logtalk_make/1: 2a0. (with target
     ‘all’) predicates are called.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<2>,  Next: Examples<10>,  Prev: Description<9>,  Up: include/1

2.3.1.7 Template and modes
..........................

     include(@source_file_name)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<10>,  Prev: Template and modes<2>,  Up: include/1

2.3.1.8 Examples
................

     % include the "raw_1.txt" text file found
     % on the "data" library directory:
     :- include(data('raw_1.txt')).

     % include a "factbase.pl" file in the same directory
     % of the source file containing the directive:
     :- include('factbase.pl').

     % include a file given its absolute path:
     :- include('/home/me/databases/countries.pl').

     % create a wrapper object for a Prolog file using
     % library notation to define the file path:
     | ?- create_object(cities, [], [public(city/4), include(geo('cities.pl'))], []).

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: initialization/1,  Next: op/3,  Prev: include/1,  Up: Source file directives<2>

2.3.1.9 ‘initialization/1’
..........................

* Menu:

* Description: Description<10>.
* Template and modes: Template and modes<3>.
* Examples: Examples<11>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<10>,  Next: Template and modes<3>,  Up: initialization/1

2.3.1.10 Description
....................

     initialization(Goal)

When used within an object, this directive defines a goal to be called
after the object has been successfully loaded into memory.  When used at
a global level within a source file, this directive defines a goal to be
called after the source file is successfully compiled and loaded into
memory.

The loading context can be accessed from this directive by calling the
*note logtalk_load_context/2: 317. predicate.  Note that the usable
loading context keys depend on the directive scope (file or object).

Multiple initialization directives can be used in a source file or in an
object.  Their goals will be called in the same order as the directives
at loading time.

     Note: Arbitrary goals cannot be used as directives in source files.
     Any goal that should be automatically called when a source file is
     loaded must be wrapped using this directive.

     Categories and protocols cannot contain ‘initialization/1’
     directives as the initialization goals would lack a complete *note
     execution context: 35e. that is only available for objects.

Although technically a global ‘initialization/1’ directive in a source
file is a Prolog directive, calls to Logtalk built-in predicates from it
are usually compiled to improve portability, improve performance, and
provide better support for embedded applications.

     Warning: Some backend Prolog compilers declare the atom
     ‘initialization’ as an operator for a lighter syntax.  But this
     makes the code non-portable and is therefore a practice best
     avoided.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<3>,  Next: Examples<11>,  Prev: Description<10>,  Up: initialization/1

2.3.1.11 Template and modes
...........................

     initialization(@callable)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<11>,  Prev: Template and modes<3>,  Up: initialization/1

2.3.1.12 Examples
.................

     % call the init/0 predicate after loading the
     % source file containing the directive

     :- initialization(init).

     % print a debug message after loading a
     % source file defining an object

     :- object(log).

         :- initialization(start_date).

         start_date :-
             os::date_time(Year, Month, Day, _, _, _, _),
             logtalk::print_message(debug, my_app, 'Starting date: ~d-~d-~d~n'+[Year,Month,Day]).

     :- end_object.

See also
........

*note logtalk_load_context/2: 317.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: op/3,  Next: set_logtalk_flag/2,  Prev: initialization/1,  Up: Source file directives<2>

2.3.1.13 ‘op/3’
...............

* Menu:

* Description: Description<11>.
* Template and modes: Template and modes<4>.
* Examples: Examples<12>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<11>,  Next: Template and modes<4>,  Up: op/3

2.3.1.14 Description
....................

     op(Precedence, Associativity, Operator)
     op(Precedence, Associativity, [Operator, ...])

Declares operators.  Global operators can be declared inside a source
file by writing the respective directives before the entity opening
directives.  Operators declared inside entities have local scope.  Calls
to the standard term input and output predicates take into account any
locally defined operators.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<4>,  Next: Examples<12>,  Prev: Description<11>,  Up: op/3

2.3.1.15 Template and modes
...........................

     op(+integer, +associativity, +atom_or_atom_list)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<12>,  Prev: Template and modes<4>,  Up: op/3

2.3.1.16 Examples
.................

Some of the predicate argument instantiation mode operators used by
Logtalk:

     :- op(200, fy, +).
     :- op(200, fy, ?).
     :- op(200, fy, @).
     :- op(200, fy, -).

An example of using entity local operators.  Consider the following
‘ops.lgt’ file:

     :- initialization((write(<=>(1,2)), nl)).

     :- object(ops).

         :- op(700, xfx, <=>).

         :- public(w/1).
         w(Term) :-
             write(Term), nl.

         :- public(r/1).
         r(Term) :-
             read(Term).

     :- end_object.

Loading the file automatically calls the initialization goal.  Compare
its output with the output of the ‘ops::w/1’ predicate.  Compare also
reading a term from within the ‘ops’ object versus reading from ‘user’.

     | ?- {ops}.
     <=>(1,2)
     true.

     | ?- ops::w(<=>(1,2)).
     1<=>2
     true.

     | ?- ops::r(T).
     |: 3<=>4.

     T = <=>(3, 4).

     | ?- read(T).
     |: 5<=>6.

     SYNTAX ERROR: operator expected

See also
........

*note current_op/3: 15e.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: set_logtalk_flag/2,  Prev: op/3,  Up: Source file directives<2>

2.3.1.17 ‘set_logtalk_flag/2’
.............................

* Menu:

* Description: Description<12>.
* Template and modes: Template and modes<5>.
* Errors: Errors<8>.
* Examples: Examples<13>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<12>,  Next: Template and modes<5>,  Up: set_logtalk_flag/2

2.3.1.18 Description
....................

     set_logtalk_flag(Flag, Value)

Sets local flag values.  The scope of this directive is the entity or
the source file containing it.  For global scope, use the corresponding
*note set_logtalk_flag/2: 51. built-in predicate called from an *note
initialization/1: 42. directive.  For a description of the predefined
compiler flags, consult the *note Compiler flags: 251. section in the
User Manual.  The directive affects the compilation of all terms that
follow it within the scope of the directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<5>,  Next: Errors<8>,  Prev: Description<12>,  Up: set_logtalk_flag/2

2.3.1.19 Template and modes
...........................

     set_logtalk_flag(+atom, +nonvar)


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<8>,  Next: Examples<13>,  Prev: Template and modes<5>,  Up: set_logtalk_flag/2

2.3.1.20 Errors
...............

     Flag is a variable:
          ‘instantiation_error’
     Value is a variable:
          ‘instantiation_error’
     Flag is not an atom:
          ‘type_error(atom, Flag)’
     Flag is neither a variable nor a valid flag:
          ‘domain_error(flag, Flag)’
     Value is not a valid value for flag Flag:
          ‘domain_error(flag_value, Flag + Value)’
     Flag is a read-only flag:
          ‘permission_error(modify, flag, Flag)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<13>,  Prev: Errors<8>,  Up: set_logtalk_flag/2

2.3.1.21 Examples
.................

     % turn off the compiler unknown entity warnings
     % during the compilation of this source file:
     :- set_logtalk_flag(unknown_entities, silent).


     :- object(...).

         % generate events for messages sent from this object:
         :- set_logtalk_flag(events, allow).
         ...

         % turn off suspicious call lint checks for the next predicate:
         :- set_logtalk_flag(suspicious_calls, silent).
         foo :-
             ...
         :- set_logtalk_flag(suspicious_calls, warning).
         ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Conditional compilation directives<2>,  Next: Entity directives,  Prev: Source file directives<2>,  Up: Directives<2>

2.3.2 Conditional compilation directives
----------------------------------------

'directive'

* Menu:

* if/1::
* elif/1::
* else/0::
* endif/0::


File: TheLogtalkHandbook-3.100.1.info,  Node: if/1,  Next: elif/1,  Up: Conditional compilation directives<2>

2.3.2.1 ‘if/1’
..............

* Menu:

* Description: Description<13>.
* Template and modes: Template and modes<6>.
* Examples: Examples<14>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<13>,  Next: Template and modes<6>,  Up: if/1

2.3.2.2 Description
...................

     if(Goal)

Starts an 'if-then' branch when performing conditional compilation.  The
code following the directive is compiled iff ‘Goal’ is true.  If ‘Goal’
throws an error instead of either succeeding or failing, the error is
reported by the compiler and compilation of the enclosing source file or
entity is aborted.  The goal is *note expanded: cb. when the directive
occurs in a source file.  Conditional compilation directives can be
nested.

     Warning: Conditional compilation goals 'cannot' depend on predicate
     definitions contained in the same source file that contains the
     conditional compilation directives (as those predicates only become
     available after the file is successfully compiled and loaded).

     Conditional compilation directives are currently not supported in
     included files when the conditional code includes ‘op/3’ directives
     or ‘uses/2’/‘use_module/2’ directives with ‘op/3’ arguments.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<6>,  Next: Examples<14>,  Prev: Description<13>,  Up: if/1

2.3.2.3 Template and modes
..........................

     if(@callable)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<14>,  Prev: Template and modes<6>,  Up: if/1

2.3.2.4 Examples
................

A common example is checking if a built-in predicate exists and
providing a definition when the predicate is absent:

     :- if(\+ predicate_property(length(_,_), built_in)).

         length(List, Length) :-
             ...

     :- endif.

Another common example is conditionally including code for a specific
backend Prolog compiler:

     :- if(current_logtalk_flag(prolog_dialect, swi)).

         % SWI-Prolog specific code
         :- set_prolog_flag(double_quotes, codes).

     :- endif.

If necessary, test goal errors can be converted into failures using the
standard ‘catch/3’ control construct.  For example:

     :- if(catch(\+ log(7,_), _, fail)).

        % define the legacy log/2 predicate
        log(X, Y) :- Y is log(X).

     :- endif.

See also
........

*note elif/1: 2f3, *note else/0: 2f4, *note endif/0: 2f5.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: elif/1,  Next: else/0,  Prev: if/1,  Up: Conditional compilation directives<2>

2.3.2.5 ‘elif/1’
................

* Menu:

* Description: Description<14>.
* Template and modes: Template and modes<7>.
* Examples: Examples<15>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<14>,  Next: Template and modes<7>,  Up: elif/1

2.3.2.6 Description
...................

     elif(Goal)

Supports embedded conditionals when performing conditional compilation.
The code following the directive is compiled iff ‘Goal’ is true.  If
‘Goal’ throws an error instead of either succeeding or failing, the
error is reported by the compiler and compilation of the enclosing
source file or entity is aborted.  The goal is *note expanded: cb. when
the directive occurs in a source file.

     Warning: Conditional compilation goals 'cannot' depend on predicate
     definitions contained in the same source file that contains the
     conditional compilation directives (as those predicates only become
     available after the file is successfully compiled and loaded).

     Conditional compilation directives are currently not supported in
     included files when the conditional code includes ‘op/3’ directives
     or ‘uses/2’/‘use_module/2’ directives with ‘op/3’ arguments.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<7>,  Next: Examples<15>,  Prev: Description<14>,  Up: elif/1

2.3.2.7 Template and modes
..........................

     elif(@callable)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<15>,  Prev: Template and modes<7>,  Up: elif/1

2.3.2.8 Examples
................

     :- if(current_prolog_flag(double_quotes, codes)).

         ...

     :- elif(current_prolog_flag(double_quotes, chars)).

         ...

     :- elif(current_prolog_flag(double_quotes, atom)).

         ...

     :- endif.

See also
........

*note else/0: 2f4, *note endif/0: 2f5, *note if/1: 2f2.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: else/0,  Next: endif/0,  Prev: elif/1,  Up: Conditional compilation directives<2>

2.3.2.9 ‘else/0’
................

* Menu:

* Description: Description<15>.
* Template and modes: Template and modes<8>.
* Examples: Examples<16>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<15>,  Next: Template and modes<8>,  Up: else/0

2.3.2.10 Description
....................

     else

Starts an 'else' branch when performing conditional compilation.  The
code following this directive is compiled iff the goal in the matching
*note if/1: 2f2. or *note elif/1: 2f3. directive is false.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<8>,  Next: Examples<16>,  Prev: Description<15>,  Up: else/0

2.3.2.11 Template and modes
...........................

     else


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<16>,  Prev: Template and modes<8>,  Up: else/0

2.3.2.12 Examples
.................

An example where a hypothetical application would have some limitations
that the user should be made aware of when running on a backend Prolog
compiler with bounded arithmetic:

     :- if(current_prolog_flag(bounded, true)).

         :- initialization(
             logtalk::print_message(warning,app,bounded_arithmetic)
         ).

     :- else.

         :- initialization(
             logtalk::print_message(comment,app,unbounded_arithmetic)
         ).

     :- endif.

See also
........

*note elif/1: 2f3, *note endif/0: 2f5, *note if/1: 2f2.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: endif/0,  Prev: else/0,  Up: Conditional compilation directives<2>

2.3.2.13 ‘endif/0’
..................

* Menu:

* Description: Description<16>.
* Template and modes: Template and modes<9>.
* Examples: Examples<17>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<16>,  Next: Template and modes<9>,  Up: endif/0

2.3.2.14 Description
....................

     endif

Ends conditional compilation for the matching *note if/1: 2f2.
directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<9>,  Next: Examples<17>,  Prev: Description<16>,  Up: endif/0

2.3.2.15 Template and modes
...........................

     endif


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<17>,  Prev: Template and modes<9>,  Up: endif/0

2.3.2.16 Examples
.................

     :- if(date::today(_,5,25)).

         :- initialization(write('Happy Towel Day!\n')).

     :- endif.

See also
........

*note elif/1: 2f3, *note else/0: 2f4, *note if/1: 2f2.


File: TheLogtalkHandbook-3.100.1.info,  Node: Entity directives,  Next: Predicate directives<2>,  Prev: Conditional compilation directives<2>,  Up: Directives<2>

2.3.3 Entity directives
-----------------------

'directive'

* Menu:

* built_in/0::
* category/1-4::
* dynamic/0::
* end_category/0::
* end_object/0::
* end_protocol/0::
* info/1::
* object/1-5::
* protocol/1-2::
* threaded/0::
* uses/1::
* use_module/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: built_in/0,  Next: category/1-4,  Up: Entity directives

2.3.3.1 ‘built_in/0’
....................

* Menu:

* Description: Description<17>.
* Template and modes: Template and modes<10>.
* Examples: Examples<18>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<17>,  Next: Template and modes<10>,  Up: built_in/0

2.3.3.2 Description
...................

     built_in

Declares an entity as built-in.  Built-in entities must be static and
cannot be redefined once loaded.  This directive is used in the
pre-defined protocols, categories, and objects that are automatically
loaded at startup.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<10>,  Next: Examples<18>,  Prev: Description<17>,  Up: built_in/0

2.3.3.3 Template and modes
..........................

     built_in


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<18>,  Prev: Template and modes<10>,  Up: built_in/0

2.3.3.4 Examples
................

     :- built_in.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: category/1-4,  Next: dynamic/0,  Prev: built_in/0,  Up: Entity directives

2.3.3.5 ‘category/1-4’
......................

* Menu:

* Description: Description<18>.
* Template and modes: Template and modes<11>.
* Examples: Examples<19>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<18>,  Next: Template and modes<11>,  Up: category/1-4

2.3.3.6 Description
...................

     category(Category)

     category(Category,
         implements(Protocols))

     category(Category,
         extends(Categories))

     category(Category,
         complements(Objects))

     category(Category,
         implements(Protocols),
         extends(Categories))

     category(Category,
         implements(Protocols),
         complements(Objects))

     category(Category,
         extends(Categories),
         complements(Objects))

     category(Category,
         implements(Protocols),
         extends(Categories),
         complements(Objects))

Starting category directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<11>,  Next: Examples<19>,  Prev: Description<18>,  Up: category/1-4

2.3.3.7 Template and modes
..........................

     category(+category_identifier)

     category(+category_identifier,
         implements(+implemented_protocols))

     category(+category_identifier,
         extends(+extended_categories))

     category(+category_identifier,
         complements(+complemented_objects))

     category(+category_identifier,
         implements(+implemented_protocols),
         extends(+extended_categories))

     category(+category_identifier,
         implements(+implemented_protocols),
         complements(+complemented_objects))

     category(+category_identifier,
         extends(+extended_categories),
         complements(+complemented_objects))

     category(+category_identifier,
         implements(+implemented_protocols),
         extends(+extended_categories),
         complements(+complemented_objects))


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<19>,  Prev: Template and modes<11>,  Up: category/1-4

2.3.3.8 Examples
................

     :- category(monitoring).

     :- category(monitoring,
         implements(monitoringp)).

     :- category(attributes,
         implements(protected::variables)).

     :- category(extended,
         extends(minimal)).

     :- category(logging,
         implements(monitoring),
         complements(employee)).

See also
........

*note end_category/0: 10f.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: dynamic/0,  Next: end_category/0,  Prev: category/1-4,  Up: Entity directives

2.3.3.9 ‘dynamic/0’
...................

* Menu:

* Description: Description<19>.
* Template and modes: Template and modes<12>.
* Examples: Examples<20>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<19>,  Next: Template and modes<12>,  Up: dynamic/0

2.3.3.10 Description
....................

     dynamic

Declares an entity and its contents as dynamic.  Dynamic entities can be
abolished at runtime.

As entities created at runtime (using the *note create_object/4: 62,
*note create_protocol/3: e3, and *note create_category/4: 11a. built-in
predicates) are always dynamic, this directive is only necessary in the
rare cases where we want to define dynamic entities in source files.

     Warning: Some backend Prolog compilers declare the atom ‘dynamic’
     as an operator for a lighter syntax, forcing writing this atom
     between parenthesis when using this directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<12>,  Next: Examples<20>,  Prev: Description<19>,  Up: dynamic/0

2.3.3.11 Template and modes
...........................

     dynamic


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<20>,  Prev: Template and modes<12>,  Up: dynamic/0

2.3.3.12 Examples
.................

     :- dynamic.

See also
........

*note dynamic/1: 15a, *note object_property/2: c6, *note
protocol_property/2: f4, *note category_property/2: 12c.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: end_category/0,  Next: end_object/0,  Prev: dynamic/0,  Up: Entity directives

2.3.3.13 ‘end_category/0’
.........................

* Menu:

* Description: Description<20>.
* Template and modes: Template and modes<13>.
* Examples: Examples<21>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<20>,  Next: Template and modes<13>,  Up: end_category/0

2.3.3.14 Description
....................

     end_category

Ending category directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<13>,  Next: Examples<21>,  Prev: Description<20>,  Up: end_category/0

2.3.3.15 Template and modes
...........................

     end_category


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<21>,  Prev: Template and modes<13>,  Up: end_category/0

2.3.3.16 Examples
.................

     :- end_category.

See also
........

*note category/1-4: 10e.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: end_object/0,  Next: end_protocol/0,  Prev: end_category/0,  Up: Entity directives

2.3.3.17 ‘end_object/0’
.......................

* Menu:

* Description: Description<21>.
* Template and modes: Template and modes<14>.
* Examples: Examples<22>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<21>,  Next: Template and modes<14>,  Up: end_object/0

2.3.3.18 Description
....................

     end_object

Ending object directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<14>,  Next: Examples<22>,  Prev: Description<21>,  Up: end_object/0

2.3.3.19 Template and modes
...........................

     end_object


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<22>,  Prev: Template and modes<14>,  Up: end_object/0

2.3.3.20 Examples
.................

     :- end_object.

See also
........

*note object/1-5: 9a.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: end_protocol/0,  Next: info/1,  Prev: end_object/0,  Up: Entity directives

2.3.3.21 ‘end_protocol/0’
.........................

* Menu:

* Description: Description<22>.
* Template and modes: Template and modes<15>.
* Examples: Examples<23>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<22>,  Next: Template and modes<15>,  Up: end_protocol/0

2.3.3.22 Description
....................

     end_protocol

Ending protocol directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<15>,  Next: Examples<23>,  Prev: Description<22>,  Up: end_protocol/0

2.3.3.23 Template and modes
...........................

     end_protocol


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<23>,  Prev: Template and modes<15>,  Up: end_protocol/0

2.3.3.24 Examples
.................

     :- end_protocol.

See also
........

*note protocol/1-2: dc.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: info/1,  Next: object/1-5,  Prev: end_protocol/0,  Up: Entity directives

2.3.3.25 ‘info/1’
.................

* Menu:

* Description: Description<23>.
* Template and modes: Template and modes<16>.
* Examples: Examples<24>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<23>,  Next: Template and modes<16>,  Up: info/1

2.3.3.26 Description
....................

     info([Key is Value, ...])

Documentation directive for objects, protocols, and categories.  The
directive argument is a list of pairs using the format 'Key is Value'.
See the *note Entity documenting directives: 323. section for a
description of the default keys.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<16>,  Next: Examples<24>,  Prev: Description<23>,  Up: info/1

2.3.3.27 Template and modes
...........................

     info(+entity_info_list)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<24>,  Prev: Template and modes<16>,  Up: info/1

2.3.3.28 Examples
.................

     :- info([
         version is 1:0:0,
         author is 'Paulo Moura',
         date is 2000-11-20,
         comment is 'List protocol.'
     ]).

See also
........

*note info/2: 168, *note object_property/2: c6, *note
protocol_property/2: f4, *note category_property/2: 12c.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: object/1-5,  Next: protocol/1-2,  Prev: info/1,  Up: Entity directives

2.3.3.29 ‘object/1-5’
.....................

* Menu:

* Description: Description<24>.
* Template and modes: Template and modes<17>.
* Examples: Examples<25>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<24>,  Next: Template and modes<17>,  Up: object/1-5

2.3.3.30 Description
....................

'Stand-alone objects (prototypes)'

     object(Object)

     object(Object,
         implements(Protocols))

     object(Object,
         imports(Categories))

     object(Object,
         implements(Protocols),
         imports(Categories))

'Prototype extensions'

     object(Object,
         extends(Objects))

     object(Object,
         implements(Protocols),
         extends(Objects))

     object(Object,
         imports(Categories),
         extends(Objects))

     object(Object,
         implements(Protocols),
         imports(Categories),
         extends(Objects))

'Class instances'

     object(Object,
         instantiates(Classes))

     object(Object,
         implements(Protocols),
         instantiates(Classes))

     object(Object,
         imports(Categories),
         instantiates(Classes))

     object(Object,
         implements(Protocols),
         imports(Categories),
         instantiates(Classes))

'Classes'

     object(Object,
         specializes(Classes))

     object(Object,
         implements(Protocols),
         specializes(Classes))

     object(Object,
         imports(Categories),
         specializes(Classes))

     object(Object,
         implements(Protocols),
         imports(Categories),
         specializes(Classes))

'Classes with metaclasses'

     object(Object,
         instantiates(Classes),
         specializes(Classes))

     object(Object,
         implements(Protocols),
         instantiates(Classes),
         specializes(Classes))

     object(Object,
         imports(Categories),
         instantiates(Classes),
         specializes(Classes))

     object(Object,
         implements(Protocols),
         imports(Categories),
         instantiates(Classes),
         specializes(Classes))

Starting object directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<17>,  Next: Examples<25>,  Prev: Description<24>,  Up: object/1-5

2.3.3.31 Template and modes
...........................

'Stand-alone objects (prototypes)'

     object(+object_identifier)

     object(+object_identifier,
         implements(+implemented_protocols))

     object(+object_identifier,
         imports(+imported_categories))

     object(+object_identifier,
         implements(+implemented_protocols),
         imports(+imported_categories))

'Prototype extensions'

     object(+object_identifier,
         extends(+extended_objects))

     object(+object_identifier,
         implements(+implemented_protocols),
         extends(+extended_objects))

     object(+object_identifier,
         imports(+imported_categories),
         extends(+extended_objects))

     object(+object_identifier,
         implements(+implemented_protocols),
         imports(+imported_categories),
         extends(+extended_objects))

'Class instances'

     object(+object_identifier,
         instantiates(+instantiated_objects))

     object(+object_identifier,
         implements(+implemented_protocols),
         instantiates(+instantiated_objects))

     object(+object_identifier,
         imports(+imported_categories),
         instantiates(+instantiated_objects))

     object(+object_identifier,
         implements(+implemented_protocols),
         imports(+imported_categories),
         instantiates(+instantiated_objects))

'Classes'

     object(+object_identifier,
         specializes(+specialized_objects))

     object(+object_identifier,
         implements(+implemented_protocols),
         specializes(+specialized_objects))

     object(+object_identifier,
         imports(+imported_categories),
         specializes(+specialized_objects))

     object(+object_identifier,
         implements(+implemented_protocols),
         imports(+imported_categories),
         specializes(+specialized_objects))

'Class with metaclasses'

     object(+object_identifier,
         instantiates(+instantiated_objects),
         specializes(+specialized_objects))

     object(+object_identifier,
         implements(+implemented_protocols),
         instantiates(+instantiated_objects),
         specializes(+specialized_objects))

     object(+object_identifier,
         imports(+imported_categories),
         instantiates(+instantiated_objects),
         specializes(+specialized_objects))

     object(+object_identifier,
         implements(+implemented_protocols),
         imports(+imported_categories),
         instantiates(+instantiated_objects),
         specializes(+specialized_objects))


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<25>,  Prev: Template and modes<17>,  Up: object/1-5

2.3.3.32 Examples
.................

     :- object(list).

     :- object(list,
         implements(listp)).

     :- object(list,
         extends(compound)).

     :- object(list,
         implements(listp),
         extends(compound)).

     :- object(object,
         imports(initialization),
         instantiates(class)).

     :- object(abstract_class,
         instantiates(class),
         specializes(object)).

     :- object(agent,
         imports(private::attributes)).

See also
........

*note end_object/0: 9b.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: protocol/1-2,  Next: threaded/0,  Prev: object/1-5,  Up: Entity directives

2.3.3.33 ‘protocol/1-2’
.......................

* Menu:

* Description: Description<25>.
* Template and modes: Template and modes<18>.
* Examples: Examples<26>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<25>,  Next: Template and modes<18>,  Up: protocol/1-2

2.3.3.34 Description
....................

     protocol(Protocol)

     protocol(Protocol,
         extends(Protocols))

Starting protocol directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<18>,  Next: Examples<26>,  Prev: Description<25>,  Up: protocol/1-2

2.3.3.35 Template and modes
...........................

     protocol(+protocol_identifier)

     protocol(+protocol_identifier,
         extends(+extended_protocols))


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<26>,  Prev: Template and modes<18>,  Up: protocol/1-2

2.3.3.36 Examples
.................

     :- protocol(listp).

     :- protocol(listp,
         extends(compoundp)).

     :- protocol(queuep,
         extends(protected::listp)).

See also
........

*note end_protocol/0: dd.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded/0,  Next: uses/1,  Prev: protocol/1-2,  Up: Entity directives

2.3.3.37 ‘threaded/0’
.....................

* Menu:

* Description: Description<26>.
* Template and modes: Template and modes<19>.
* Examples: Examples<27>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<26>,  Next: Template and modes<19>,  Up: threaded/0

2.3.3.38 Description
....................

     threaded

Declares that an object supports threaded engines, concurrent calls, and
asynchronous messages.  Any object containing calls to the built-in
multi-threading predicates (or importing a category that contains such
calls) must include this directive.

This directive results in the automatic creation and set up of an object
message queue when the object is loaded or created at runtime.  Object
message queues are used for exchanging thread notifications and for
storing concurrent goal solutions and replies to the multi-threading
calls made within the object.  The message queue for the *note user: cf.
pseudo-object is automatically created at Logtalk startup (provided that
multi-threading programming is supported and enabled for the chosen
*note backend Prolog compiler: 34.).

     Note: This directive requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<19>,  Next: Examples<27>,  Prev: Description<26>,  Up: threaded/0

2.3.3.39 Template and modes
...........................

     threaded


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<27>,  Prev: Template and modes<19>,  Up: threaded/0

2.3.3.40 Examples
.................

     :- threaded.

See also
........

*note synchronized/1: 74, *note object_property/2: c6.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: uses/1,  Next: use_module/1,  Prev: threaded/0,  Up: Entity directives

2.3.3.41 ‘uses/1’
.................

* Menu:

* Description: Description<27>.
* Template and modes: Template and modes<20>.
* Examples: Examples<28>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<27>,  Next: Template and modes<20>,  Up: uses/1

2.3.3.42 Description
....................

     uses([Object as Alias, ...])

Declares object aliases.  Typically used to shorten long object names,
to simplify and consistently send messages to parameterized objects, and
to simplify using or experimenting with different object implementations
of the same protocol when using explicit message-sending.  Object
aliases are local to the object (or category) where they are defined.

The objects being aliased can be *note parameter variables: a1. or
parametric objects where one or more parameters are parameter variables
when using the directive in a parametric object or a parametric category
defined in a source file (the common case).

Declaring multiple aliases for the same object is allowed.  But repeated
declarations of the same alias, declaring an alias for an object alias,
and redefining an alias to reference a different object are reported as
compilation errors.

To enable the use of *note static binding: 35, and thus optimal
message-sending performance, the objects should be loaded before
compiling the entities that call their predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<20>,  Next: Examples<28>,  Prev: Description<27>,  Up: uses/1

2.3.3.43 Template and modes
...........................

     uses(+object_alias_list)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<28>,  Prev: Template and modes<20>,  Up: uses/1

2.3.3.44 Examples
.................

     :- object(foo(_HeapType_, _OptionsObject_)).

         :- uses([
             fast_random as rnd,
             time(utc) as time,
             heap(_HeapType_) as heap,
             _OptionsObject_ as options
         ]).

         bar :-
             ...,
             % the same as fast_random::permutation(L, P)
             rnd::permutation(L, P),
             % the same as heap(_HeapType_)::as_heap(L, H)
             heap::as_heap(L, H),
             % the same as _OptionsObject_::get(foo, X)
             options::get(foo, X),
             % the same as time(utc)::now(T)
             time::now(T),
             ...

See also
........

*note uses/2: 4b, *note use_module/1: 4c, *note use_module/2: 4d.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: use_module/1,  Prev: uses/1,  Up: Entity directives

2.3.3.45 ‘use_module/1’
.......................

* Menu:

* Description: Description<28>.
* Template and modes: Template and modes<21>.
* Examples: Examples<29>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<28>,  Next: Template and modes<21>,  Up: use_module/1

2.3.3.46 Description
....................

     use_module([Module as Alias, ...])

Declares module aliases.  Typically used to shorten long module names
and to simplify using or experimenting with different module
implementations of the same predicates when using explicitly-qualified
calls.  Module aliases are local to the object (or category) where they
are defined.

The modules being aliased can be *note parameter variables: a1. when
using the directive in a parametric object or a parametric category
defined in a source file (the common case).

Declaring multiple aliases for the same module is allowed.  But repeated
declarations of the same alias, declaring an alias for a module alias,
and redefining an alias to reference a different module are reported as
compilation errors.

To enable the use of *note static binding: 35, and thus optimal
predicate call performance, the modules should be loaded before
compiling the entities that call their predicates.

Note that this directive semantics differs from the directive with the
same name found on some Prolog implementations where it is used to load
a module and import all its exported predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<21>,  Next: Examples<29>,  Prev: Description<28>,  Up: use_module/1

2.3.3.47 Template and modes
...........................

     use_module(+module_alias_list)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<29>,  Prev: Template and modes<21>,  Up: use_module/1

2.3.3.48 Examples
.................

     :- object(foo(_DataModule_)).

         :- use_module([
             data_noise_handler as cleaner,
             _DataModule_ as data
         ]).

         bar :-
             ...,
             % the same as _DataModule_:xy(X, Y)
             data:xy(X, Y),
             % the same as data_noise_handler:filter(X, Y)
             cleaner:filter(X, Y, Z),
             ...

See also
........

*note uses/1: 4a, *note uses/2: 4b, *note use_module/2: 4d.


File: TheLogtalkHandbook-3.100.1.info,  Node: Predicate directives<2>,  Prev: Entity directives,  Up: Directives<2>

2.3.4 Predicate directives
--------------------------

'directive'

* Menu:

* alias/2::
* coinductive/1::
* discontiguous/1::
* dynamic/1::
* info/2::
* meta_predicate/1::
* meta_non_terminal/1::
* mode/2::
* mode_non_terminal/2::
* multifile/1::
* private/1::
* protected/1::
* public/1::
* synchronized/1::
* uses/2::
* use_module/2::


File: TheLogtalkHandbook-3.100.1.info,  Node: alias/2,  Next: coinductive/1,  Up: Predicate directives<2>

2.3.4.1 ‘alias/2’
.................

* Menu:

* Description: Description<29>.
* Template and modes: Template and modes<22>.
* Examples: Examples<30>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<29>,  Next: Template and modes<22>,  Up: alias/2

2.3.4.2 Description
...................

     alias(Entity, [Name/Arity as Alias/Arity, ...])
     alias(Entity, [Name//Arity as Alias//Arity, ...])

Declares predicate and grammar rule non-terminal *note aliases: ca.  A
predicate (non-terminal) alias is an alternative name for a predicate
(non-terminal) declared or defined in an extended protocol, an
implemented protocol, an extended category, an imported category, an
extended prototype, an instantiated class, or a specialized class.
Predicate aliases may be used to solve conflicts between imported or
inherited predicates.  It may also be used to give a predicate
(non-terminal) a name more appropriate in its usage context.  This
directive may be used in objects, protocols, and categories.

Predicate (and non-terminal) aliases are specified using (preferably)
the notation ‘Name/Arity as Alias/Arity’ or, in alternative, the
notation ‘Name/Arity::Alias/Arity’.

It is also possible to declare predicate and grammar rule non-terminal
aliases in implicit qualification directives for sending messages to
objects and calling module predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<22>,  Next: Examples<30>,  Prev: Description<29>,  Up: alias/2

2.3.4.3 Template and modes
..........................

     alias(@entity_identifier, +list(predicate_indicator_alias))
     alias(@entity_identifier, +list(non_terminal_indicator_alias))


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<30>,  Prev: Template and modes<22>,  Up: alias/2

2.3.4.4 Examples
................

     % resolve a predicate name conflict:
     :- alias(list, [member/2 as list_member/2]).
     :- alias(set,  [member/2 as set_member/2]).

     % define an alternative name for a non-terminal:
     :- alias(words, [singular//0 as peculiar//0]).

See also
........

*note uses/2: 4b, *note use_module/2: 4d, *note uses/1: 4a.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: coinductive/1,  Next: discontiguous/1,  Prev: alias/2,  Up: Predicate directives<2>

2.3.4.5 ‘coinductive/1’
.......................

* Menu:

* Description: Description<30>.
* Template and modes: Template and modes<23>.
* Examples: Examples<31>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<30>,  Next: Template and modes<23>,  Up: coinductive/1

2.3.4.6 Description
...................

     coinductive(Name/Arity)
     coinductive((Name/Arity, ...))
     coinductive([Name/Arity, ...])

     coinductive(Name//Arity)
     coinductive((Name//Arity, ...))
     coinductive([Name//Arity, ...])

     coinductive(Template)
     coinductive((Template1, ...))
     coinductive([Template1, ...])

This is an 'experimental' directive, used for declaring *note
coinductive: 170. predicates.  Requires a *note backend Prolog compiler:
34. with minimal support for cyclic terms.  The current implementation
of coinduction allows the generation of only the 'basic cycles' but all
valid solutions should be recognized.  Use a predicate indicator or a
non-terminal indicator as argument when all the coinductive predicate
arguments are relevant for coinductive success.  Use a template when
only some coinductive predicate arguments (represented by a “‘+’”)
should be considered when testing for coinductive success (represent the
arguments that should be disregarded by a “‘-’“).  It’s possible to
define local *note coinductive_success_hook/1-2: 4b2. predicates that
are automatically called with the coinductive predicate term resulting
from a successful unification with an ancestor goal as first argument.
The second argument, when present, is the coinductive hypothesis (i.e.,
the ancestor goal) used.  These hook predicates can provide an
alternative to the use of tabling when defining some coinductive
predicates.  There is no overhead when these hook predicates are not
defined.

This directive must precede any calls to the declared coinductive
predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<23>,  Next: Examples<31>,  Prev: Description<30>,  Up: coinductive/1

2.3.4.7 Template and modes
..........................

     coinductive(+predicate_indicator_term)
     coinductive(+non_terminal_indicator_term)
     coinductive(+coinductive_predicate_template_term)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<31>,  Prev: Template and modes<23>,  Up: coinductive/1

2.3.4.8 Examples
................

     :- coinductive(comember/2).
     :- coinductive(ones_and_zeros//0).
     :- coinductive(controller(+,+,+,-,-)).

See also
........

*note coinductive_success_hook/1-2: 4b2, *note predicate_property/2:
142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: discontiguous/1,  Next: dynamic/1,  Prev: coinductive/1,  Up: Predicate directives<2>

2.3.4.9 ‘discontiguous/1’
.........................

* Menu:

* Description: Description<31>.
* Template and modes: Template and modes<24>.
* Examples: Examples<32>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<31>,  Next: Template and modes<24>,  Up: discontiguous/1

2.3.4.10 Description
....................

     discontiguous(Name/Arity)
     discontiguous((Name/Arity, ...))
     discontiguous([Name/Arity, ...])

     discontiguous(Entity::Name/Arity)
     discontiguous((Entity::Name/Arity, ...))
     discontiguous([Entity::Name/Arity, ...])

     discontiguous(Module:Name/Arity)
     discontiguous((Module:Name/Arity, ...))
     discontiguous([Module:Name/Arity, ...])

     discontiguous(Name//Arity)
     discontiguous((Name//Arity, ...))
     discontiguous([Name//Arity, ...])

     discontiguous(Entity::Name//Arity)
     discontiguous((Entity::Name//Arity, ...))
     discontiguous([Entity::Name//Arity, ...])

     discontiguous(Module:Name//Arity)
     discontiguous((Module:Name//Arity, ...))
     discontiguous([Module:Name//Arity, ...])

Declares *note discontiguous: 4b8. predicates and discontiguous grammar
rule non-terminals.  The use of this directive should be avoided as not
all *note backend Prolog compilers: 34. support discontiguous
predicates.

     Warning: Some backend Prolog compilers declare the atom
     ‘discontiguous’ as an operator for a lighter syntax.  But this
     makes the code non-portable and is therefore a practice best
     avoided.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<24>,  Next: Examples<32>,  Prev: Description<31>,  Up: discontiguous/1

2.3.4.11 Template and modes
...........................

     discontiguous(+predicate_indicator_term)
     discontiguous(+non_terminal_indicator_term)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<32>,  Prev: Template and modes<24>,  Up: discontiguous/1

2.3.4.12 Examples
.................

     :- discontiguous(counter/1).

     :- discontiguous((lives/2, works/2)).

     :- discontiguous([db/4, key/2, file/3]).

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: dynamic/1,  Next: info/2,  Prev: discontiguous/1,  Up: Predicate directives<2>

2.3.4.13 ‘dynamic/1’
....................

* Menu:

* Description: Description<32>.
* Template and modes: Template and modes<25>.
* Examples: Examples<33>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<32>,  Next: Template and modes<25>,  Up: dynamic/1

2.3.4.14 Description
....................

     dynamic(Name/Arity)
     dynamic((Name/Arity, ...))
     dynamic([Name/Arity, ...])

     dynamic(Entity::Name/Arity)
     dynamic((Entity::Name/Arity, ...))
     dynamic([Entity::Name/Arity, ...])

     dynamic(Module:Name/Arity)
     dynamic((Module:Name/Arity, ...))
     dynamic([Module:Name/Arity, ...])

     dynamic(Name//Arity)
     dynamic((Name//Arity, ...))
     dynamic([Name//Arity, ...])

     dynamic(Entity::Name//Arity)
     dynamic((Entity::Name//Arity, ...))
     dynamic([Entity::Name//Arity, ...])

     dynamic(Module:Name//Arity)
     dynamic((Module:Name//Arity, ...))
     dynamic([Module:Name//Arity, ...])

Declares *note dynamic: 4be. predicates and dynamic grammar rule
non-terminals.  Note that an object can be static and have both static
and dynamic predicates/non-terminals.  When the dynamic predicates are
local to an object, declaring them also as *note private predicates:
145. allows the Logtalk compiler to generate optimized code for
asserting and retracting predicate clauses.  Categories can also contain
dynamic predicate directives but cannot contain clauses for dynamic
predicates.

The predicate indicators (or non-terminal indicators) can be explicitly
qualified with an object, category, or module identifier when the
predicates (or non-terminals) are also declared *note multifile: 16c.

Note that dynamic predicates cannot be declared synchronized (when
necessary, declare the predicates updating the dynamic predicates as
*note synchronized: 74.).

     Warning: Some backend Prolog compilers declare the atom ‘dynamic’
     as an operator for a lighter syntax.  But this makes the code
     non-portable and is therefore a practice best avoided.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<25>,  Next: Examples<33>,  Prev: Description<32>,  Up: dynamic/1

2.3.4.15 Template and modes
...........................

     dynamic(+qualified_predicate_indicator_term)
     dynamic(+qualified_non_terminal_indicator_term)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<33>,  Prev: Template and modes<25>,  Up: dynamic/1

2.3.4.16 Examples
.................

     :- dynamic(counter/1).

     :- dynamic((lives/2, works/2)).

     :- dynamic([db/4, key/2, file/3]).

See also
........

*note dynamic/0: b1, *note predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: info/2,  Next: meta_predicate/1,  Prev: dynamic/1,  Up: Predicate directives<2>

2.3.4.17 ‘info/2’
.................

* Menu:

* Description: Description<33>.
* Template and modes: Template and modes<26>.
* Examples: Examples<34>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<33>,  Next: Template and modes<26>,  Up: info/2

2.3.4.18 Description
....................

     info(Name/Arity, [Key is Value, ...])
     info(Name//Arity, [Key is Value, ...])

Documentation directive for predicates and grammar rule non-terminals.
The first argument is either a predicate indicator or a grammar rule
non-terminal indicator.  The second argument is a list of pairs using
the format 'Key is Value'.  See the *note Predicate documenting
directives: 325. section for a description of the default keys.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<26>,  Next: Examples<34>,  Prev: Description<33>,  Up: info/2

2.3.4.19 Template and modes
...........................

     info(+predicate_indicator, +predicate_info_list)
     info(+non_terminal_indicator, +predicate_info_list)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<34>,  Prev: Template and modes<26>,  Up: info/2

2.3.4.20 Examples
.................

     :- info(empty/1, [
         comment is 'True if the argument is an empty list.',
         argnames is ['List']
     ]).

     :- info(sentence//0, [
         comment is 'Rewrites a sentence into a noun phrase and a verb phrase.'
     ]).

See also
........

*note info/1: b4, *note mode/2: 149, *note predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: meta_predicate/1,  Next: meta_non_terminal/1,  Prev: info/2,  Up: Predicate directives<2>

2.3.4.21 ‘meta_predicate/1’
...........................

* Menu:

* Description: Description<34>.
* Template and modes: Template and modes<27>.
* Examples: Examples<35>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<34>,  Next: Template and modes<27>,  Up: meta_predicate/1

2.3.4.22 Description
....................

     meta_predicate(Template)
     meta_predicate((Template, ...))
     meta_predicate([Template, ...])

     meta_predicate(Entity::Template)
     meta_predicate((Entity::Template, ...))
     meta_predicate([Entity::Template, ...])

     meta_predicate(Module:Template)
     meta_predicate((Module:Template, ...))
     meta_predicate([Module:Template, ...])

Declares *note meta-predicates: 52, i.e., predicates that have arguments
interpreted as goals, arguments interpreted as *note closures: 14f. used
to construct goals, or arguments with sub-terms that will be interpreted
as goals or closures.  Meta-arguments are always called in the
meta-predicate *note calling context: 150, not in the meta-predicate
*note definition context: 151.

Meta-arguments which are goals are represented by the integer ‘0’.
Meta-arguments which are closures are represented by a positive integer,
‘N’, representing the number of additional arguments that will be
appended to the closure in order to construct the corresponding goal
(typically by calling the *note call/1-N: 181. built-in method).
Meta-arguments with sub-terms that will be interpreted as goals or
closures are represented by ‘::’.  Meta-arguments that will be called
using the ‘bagof/3’ or ‘setof/3’ predicates and that can thus be
existentially-qualified are represented by the atom ‘^’.  Normal
arguments are represented by the atom ‘*’.

Logtalk allows the use of this directive to override the original
meta-predicate directive.  This is sometimes necessary when calling
Prolog built-in meta-predicates or Prolog module meta-predicates due to
the lack of standardization of the syntax of the meta-predicate
templates.  Another case is when a meta-predicate directive is missing.
The compiler requires access to correct and non-ambiguous meta-predicate
templates to correctly compile calls to Prolog meta-predicates.

     Warning: Some backend Prolog compilers declare the atom
     ‘meta_predicate’ as an operator for a lighter syntax.  But this
     makes the code non-portable and is therefore a practice best
     avoided.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<27>,  Next: Examples<35>,  Prev: Description<34>,  Up: meta_predicate/1

2.3.4.23 Template and modes
...........................

     meta_predicate(+meta_predicate_template_term)

     meta_predicate(+object_identifier::+meta_predicate_template_term)
     meta_predicate(+category_identifier::+meta_predicate_template_term)

     meta_predicate(+module_identifier:+meta_predicate_template_term)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<35>,  Prev: Template and modes<27>,  Up: meta_predicate/1

2.3.4.24 Examples
.................

     % findall/3 second argument is interpreted as a goal:
     :- meta_predicate(findall(*, 0, *)).

     % both forall/2 arguments are interpreted as goals:
     :- meta_predicate(forall(0, 0)).

     % maplist/3 first argument is interpreted as a closure
     % that will be expanded to a goal by appending two
     % arguments:
     :- meta_predicate(maplist(2, *, *)).

See also
........

*note meta_non_terminal/1: 153, *note predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: meta_non_terminal/1,  Next: mode/2,  Prev: meta_predicate/1,  Up: Predicate directives<2>

2.3.4.25 ‘meta_non_terminal/1’
..............................

* Menu:

* Description: Description<35>.
* Template and modes: Template and modes<28>.
* Examples: Examples<36>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<35>,  Next: Template and modes<28>,  Up: meta_non_terminal/1

2.3.4.26 Description
....................

     meta_non_terminal(Template)
     meta_non_terminal((Template, ...))
     meta_non_terminal([Template, ...])

     meta_non_terminal(Entity::Template)
     meta_non_terminal((Entity::Template, ...))
     meta_non_terminal([Entity::Template, ...])

     meta_non_terminal(Module:Template)
     meta_non_terminal((Module:Template, ...))
     meta_non_terminal([Module:Template, ...])

Declares meta-non-terminals, i.e., non-terminals that have arguments
that will be called as non-terminals (or grammar rule bodies).  An
argument may also be a *note closure: 14f. instead of a goal if the
non-terminal uses the *note call//1-N: 1c9. built-in methods to
construct and call the actual non-terminal from the closure and the
additional arguments or the *note phrase//1: 1c8. built-in method.

Meta-arguments which are non-terminals are represented by the integer
‘0’.  Meta-arguments which are closures are represented by a positive
integer, ‘N’, representing the number of additional arguments that will
be appended to the closure in order to construct the corresponding
meta-call.  Normal arguments are represented by the atom ‘*’.
Meta-arguments are always called in the meta-non-terminal calling
context, not in the meta-non-terminal definition context.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<28>,  Next: Examples<36>,  Prev: Description<35>,  Up: meta_non_terminal/1

2.3.4.27 Template and modes
...........................

     meta_non_terminal(+meta_non_terminal_template_term)

     meta_non_terminal(+object_identifier::+meta_non_terminal_template_term)
     meta_non_terminal(+category_identifier::+meta_non_terminal_template_term)

     meta_non_terminal(+module_identifier:+meta_non_terminal_template_term)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<36>,  Prev: Template and modes<28>,  Up: meta_non_terminal/1

2.3.4.28 Examples
.................

     :- meta_non_terminal(phrase(1, *)).
     phrase(X, T) --> call(X, T).

See also
........

*note meta_predicate/1: 152, *note predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: mode/2,  Next: mode_non_terminal/2,  Prev: meta_non_terminal/1,  Up: Predicate directives<2>

2.3.4.29 ‘mode/2’
.................

* Menu:

* Description: Description<36>.
* Template and modes: Template and modes<29>.
* Examples: Examples<37>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<36>,  Next: Template and modes<29>,  Up: mode/2

2.3.4.30 Description
....................

     mode(Mode, NumberOfProofs)

Most predicates can be used with several instantiations modes.  This
directive enables the specification of each *note instantiation mode:
14b. and the corresponding *note number of proofs: 14d. (but not
necessarily distinct solutions).  The instantiation mode of each
argument can include type information.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<29>,  Next: Examples<37>,  Prev: Description<36>,  Up: mode/2

2.3.4.31 Template and modes
...........................

     mode(+predicate_mode_term, +number_of_proofs)
     mode(+non_terminal_mode_term, +number_of_proofs)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<37>,  Prev: Template and modes<29>,  Up: mode/2

2.3.4.32 Examples
.................

     :- mode(atom_concat(-atom, -atom, +atom), one_or_more).
     :- mode(atom_concat(+atom, +atom, -atom), one).

     :- mode(var(@term), zero_or_one).

     :- mode(solve(+callable, -list(atom)), zero_or_one).

See also
........

*note mode_non_terminal/2: 14a, *note info/2: 168, *note
predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: mode_non_terminal/2,  Next: multifile/1,  Prev: mode/2,  Up: Predicate directives<2>

2.3.4.33 ‘mode_non_terminal/2’
..............................

* Menu:

* Description: Description<37>.
* Template and modes: Template and modes<30>.
* Examples: Examples<38>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<37>,  Next: Template and modes<30>,  Up: mode_non_terminal/2

2.3.4.34 Description
....................

     mode_non_terminal(Mode, NumberOfProofs)

Most non-terminals can be used with several instantiations modes.  This
directive enables the specification of each *note instantiation mode:
14b. and the corresponding *note number of proofs: 14d. (but not
necessarily distinct solutions).  The instantiation mode of each
argument can include type information.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<30>,  Next: Examples<38>,  Prev: Description<37>,  Up: mode_non_terminal/2

2.3.4.35 Template and modes
...........................

     mode_non_terminal(+predicate_mode_term, +number_of_proofs)
     mode_non_terminal(+non_terminal_mode_term, +number_of_proofs)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<38>,  Prev: Template and modes<30>,  Up: mode_non_terminal/2

2.3.4.36 Examples
.................

     :- mode_non_terminal(zero_or_more(-list(atomic)), one).

See also
........

*note mode/2: 149, *note info/2: 168, *note predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: multifile/1,  Next: private/1,  Prev: mode_non_terminal/2,  Up: Predicate directives<2>

2.3.4.37 ‘multifile/1’
......................

* Menu:

* Description: Description<38>.
* Template and modes: Template and modes<31>.
* Examples: Examples<39>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<38>,  Next: Template and modes<31>,  Up: multifile/1

2.3.4.38 Description
....................

     multifile(Name/Arity)
     multifile((Name/Arity, ...))
     multifile([Name/Arity, ...])

     multifile(Entity::Name/Arity)
     multifile((Entity::Name/Arity, ...))
     multifile([Entity::Name/Arity, ...])

     multifile(Module:Name/Arity)
     multifile((Module:Name/Arity, ...))
     multifile([Module:Name/Arity, ...])

     multifile(Name//Arity)
     multifile((Name//Arity, ...))
     multifile([Name//Arity, ...])

     multifile(Entity::Name//Arity)
     multifile((Entity::Name//Arity, ...))
     multifile([Entity::Name//Arity, ...])

     multifile(Module:Name//Arity)
     multifile((Module:Name//Arity, ...))
     multifile([Module:Name//Arity, ...])

Declares *note multifile: 16b. predicates and multifile grammar rule
non-terminals.  In the case of object or category multifile predicates,
the predicate (or non-terminal) must also have a *note scope directive:
1e4. in the object or category holding its 'primary declaration' (i.e.,
the declaration without the ‘Entity::’ prefix).  Entities holding
multifile predicate primary declarations must be compiled and loaded
prior to any entities contributing with clauses for the multifile
predicates (to prevent using multifile predicates to break entity
encapsulation).

Protocols cannot declare or define multifile predicates as protocols
cannot contain predicate definitions.

     Warning: Some backend Prolog compilers declare the atom ‘multifile’
     as an operator for a lighter syntax.  But this makes the code
     non-portable and is therefore a practice best avoided.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<31>,  Next: Examples<39>,  Prev: Description<38>,  Up: multifile/1

2.3.4.39 Template and modes
...........................

     multifile(+qualified_predicate_indicator_term)
     multifile(+qualified_non_terminal_indicator_term)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<39>,  Prev: Template and modes<31>,  Up: multifile/1

2.3.4.40 Examples
.................

     :- multifile(table/3).
     :- multifile(user::hook/2).

See also
........

*note public/1: 143, *note protected/1: 144, *note private/1: 145, *note
predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: private/1,  Next: protected/1,  Prev: multifile/1,  Up: Predicate directives<2>

2.3.4.41 ‘private/1’
....................

* Menu:

* Description: Description<39>.
* Template and modes: Template and modes<32>.
* Examples: Examples<40>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<39>,  Next: Template and modes<32>,  Up: private/1

2.3.4.42 Description
....................

     private(Name/Arity)
     private((Name/Arity, ...))
     private([Name/Arity, ...])

     private(Name//Arity)
     private((Name//Arity, ...))
     private([Name//Arity, ...])


     private(op(Precedence,Associativity,Operator))
     private((op(Precedence,Associativity,Operator), ...))
     private([op(Precedence,Associativity,Operator), ...])

Declares *note private: 55. predicates, private grammar rule
non-terminals, and private operators.  A private predicate can only be
called from the object containing the private directive.  A private
non-terminal can only be used in a call of the *note phrase/2: 18e. and
*note phrase/3: 18f. methods from the object containing the private
directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<32>,  Next: Examples<40>,  Prev: Description<39>,  Up: private/1

2.3.4.43 Template and modes
...........................

     private(+predicate_indicator_term)
     private(+non_terminal_indicator_term)
     private(+operator_declaration)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<40>,  Prev: Template and modes<32>,  Up: private/1

2.3.4.44 Examples
.................

     :- private(counter/1).

     :- private((init/1, free/1)).

     :- private([data/3, key/1, keys/1]).

See also
........

*note protected/1: 144, *note public/1: 143, *note predicate_property/2:
142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: protected/1,  Next: public/1,  Prev: private/1,  Up: Predicate directives<2>

2.3.4.45 ‘protected/1’
......................

* Menu:

* Description: Description<40>.
* Template and modes: Template and modes<33>.
* Examples: Examples<41>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<40>,  Next: Template and modes<33>,  Up: protected/1

2.3.4.46 Description
....................

     protected(Name/Arity)
     protected((Name/Arity, ...))
     protected([Name/Arity, ...])

     protected(Name//Arity)
     protected((Name//Arity, ...))
     protected([Name//Arity, ...])

     protected(op(Precedence,Associativity,Operator))
     protected((op(Precedence,Associativity,Operator), ...))
     protected([op(Precedence,Associativity,Operator), ...])

Declares *note protected: 54. predicates, protected grammar rule
non-terminals, and protected operators.  A protected predicate can only
be called from the object containing the directive or from an object
that inherits the directive.  A protected non-terminal can only be used
as an argument in a *note phrase/2: 18e. and *note phrase/3: 18f. calls
from the object containing the directive or from an object that inherits
the directive.

     Note: Protected operators are not inherited but declaring them
     provides a reusable specification for using them in descendant
     objects (or categories).


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<33>,  Next: Examples<41>,  Prev: Description<40>,  Up: protected/1

2.3.4.47 Template and modes
...........................

     protected(+predicate_indicator_term)
     protected(+non_terminal_indicator_term)
     protected(+operator_declaration)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<41>,  Prev: Template and modes<33>,  Up: protected/1

2.3.4.48 Examples
.................

     :- protected(init/1).

     :- protected((print/2, convert/4)).

     :- protected([load/1, save/3]).

See also
........

*note private/1: 145, *note public/1: 143, *note predicate_property/2:
142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: public/1,  Next: synchronized/1,  Prev: protected/1,  Up: Predicate directives<2>

2.3.4.49 ‘public/1’
...................

* Menu:

* Description: Description<41>.
* Template and modes: Template and modes<34>.
* Examples: Examples<42>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<41>,  Next: Template and modes<34>,  Up: public/1

2.3.4.50 Description
....................

     public(Name/Arity)
     public((Name/Arity, ...))
     public([Name/Arity, ...])

     public(Name//Arity)
     public((Name//Arity, ...))
     public([Name//Arity, ...])

     public(op(Precedence,Associativity,Operator))
     public((op(Precedence,Associativity,Operator), ...))
     public([op(Precedence,Associativity,Operator), ...])

Declares *note public: 53. predicates, public grammar rule
non-terminals, and public operators.  A public predicate can be called
from any object.  A public non-terminal can be used as an argument in
*note phrase/2: 18e. and *note phrase/3: 18f. calls from any object.

     Note: Declaring a public operator does not make it global when the
     entity holding the scope directive is compiled and loaded.  But
     declaring public operators provides a reusable specification for
     using them in the entity clients (e.g., in *note uses/2: 4b.
     directives).


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<34>,  Next: Examples<42>,  Prev: Description<41>,  Up: public/1

2.3.4.51 Template and modes
...........................

     public(+predicate_indicator_term)
     public(+non_terminal_indicator_term)
     public(+operator_declaration)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<42>,  Prev: Template and modes<34>,  Up: public/1

2.3.4.52 Examples
.................

     :- public(ancestor/1).

     :- public((instance/1, instances/1)).

     :- public([leaf/1, leaves/1]).

See also
........

*note private/1: 145, *note protected/1: 144, *note
predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: synchronized/1,  Next: uses/2,  Prev: public/1,  Up: Predicate directives<2>

2.3.4.53 ‘synchronized/1’
.........................

* Menu:

* Description: Description<42>.
* Template and modes: Template and modes<35>.
* Examples: Examples<43>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<42>,  Next: Template and modes<35>,  Up: synchronized/1

2.3.4.54 Description
....................

     synchronized(Name/Arity)
     synchronized((Name/Arity, ...))
     synchronized([Name/Arity, ...])

     synchronized(Name//Arity)
     synchronized((Name//Arity, ...))
     synchronized([Name//Arity, ...])

Declares *note synchronized: 175. predicates and synchronized grammar
rule non-terminals.  The most common use is for predicates that have
side effects (e.g., asserting or retracting clauses for a dynamic
predicate) in multi-threaded applications.  A synchronized predicate (or
synchronized non-terminal) is protected by a mutex in order to allow for
thread synchronization when proving a call to the predicate (or
non-terminal).

All predicates (and non-terminals) declared in the same synchronized
directive share the same mutex.  In order to use a separate mutex for
each predicate (non-terminal) so that they are independently
synchronized, a per-predicate synchronized directive must be used.

     Warning: Declaring a predicate synchronized implicitly makes it
     'deterministic'.  When using a single-threaded *note backend Prolog
     compiler: 34, calls to synchronized predicates behave as wrapped by
     the standard *note once/1: 1bb. meta-predicate.

Note that synchronized predicates cannot be declared *note dynamic: 15a.
(when necessary, declare the predicates updating the dynamic predicates
as synchronized).


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<35>,  Next: Examples<43>,  Prev: Description<42>,  Up: synchronized/1

2.3.4.55 Template and modes
...........................

     synchronized(+predicate_indicator_term)
     synchronized(+non_terminal_indicator_term)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<43>,  Prev: Template and modes<35>,  Up: synchronized/1

2.3.4.56 Examples
.................

     :- synchronized(db_update/1).

     :- synchronized((write_stream/2, read_stream/2)).

     :- synchronized([add_to_queue/2, remove_from_queue/2]).

See also
........

*note predicate_property/2: 142.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: uses/2,  Next: use_module/2,  Prev: synchronized/1,  Up: Predicate directives<2>

2.3.4.57 ‘uses/2’
.................

* Menu:

* Description: Description<43>.
* Template and modes: Template and modes<36>.
* Examples: Examples<44>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<43>,  Next: Template and modes<36>,  Up: uses/2

2.3.4.58 Description
....................

     uses(Object, [Name/Arity, ...])
     uses(Object, [Name/Arity as Alias/Arity, ...])

     uses(Object, [Predicate as Alias, ...])

     uses(Object, [Name//Arity, ...])
     uses(Object, [Name//Arity as Alias//Arity, ...])

     uses(Object, [op(Precedence, Associativity, Operator), ...])

Declares that all calls made from predicates (or non-terminals) defined
in the category or object containing the directive to the specified
predicates (or non-terminals) are to be interpreted as messages to the
specified object.  Thus, this directive may be used to simplify writing
of predicate definitions by allowing the programmer to omit the
‘Object::’ prefix when using the predicates listed in the directive (as
long as the calls do not occur as arguments for non-standard Prolog
meta-predicates not declared in the adapter files).  It is also possible
to include operator declarations in the second argument.

This directive is also taken into account when compiling calls to the
*note database: 1af. and *note reflection: 1c4. built-in methods by
looking into these methods predicate arguments if bound at compile-time.

It is possible to specify a predicate alias using the notation
‘Name/Arity as Alias/Arity’ or, in alternative, the notation
‘Name/Arity::Alias/Arity’.  Aliases may be used to avoid conflicts
between predicates specified in ‘use_module/2’ and ‘uses/2’ directives,
for giving more meaningful names considering the calling context of the
predicates, and to change the order of the predicate arguments when
calling the predicate.  For predicates, it is also possible to define
alias shorthands using the notation ‘Predicate as Alias’ or, in
alternative, the notation ‘Predicate::Alias’, where ‘Predicate’ and
‘Alias’ are callable terms where some or all arguments may be
instantiated.

To enable the use of *note static binding: 35, and thus optimal
message-sending performance, the objects should be loaded before
compiling the entities that call their predicates.

The object identifier argument can also be a *note parameter variable:
a1. when using the directive in a parametric object or a parametric
category defined in a source file (the common case).  In this case,
*note dynamic binding: 36. will be used for all listed predicates (and
non-terminals).  The parameter variable must be instantiated at runtime
when the messages are sent.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<36>,  Next: Examples<44>,  Prev: Description<43>,  Up: uses/2

2.3.4.59 Template and modes
...........................

     uses(+object_identifier, +predicate_indicator_list)
     uses(+object_identifier, +predicate_indicator_alias_list)

     uses(+object_identifier, +predicate_template_alias_list)

     uses(+object_identifier, +non_terminal_indicator_list)
     uses(+object_identifier, +non_terminal_indicator_alias_list)

     uses(+object_identifier, +operator_list)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<44>,  Prev: Template and modes<36>,  Up: uses/2

2.3.4.60 Examples
.................

     :- uses(list,  [append/3, member/2]).
     :- uses(store, [data/2]).
     :- uses(user,  [table/4]).

     foo :-
         ...,
         % the same as findall(X, list::member(X, L), A)
         findall(X, member(X, L), A),
         % the same as list::append(A, B, C)
         append(A, B, C),
         % the same as store::assertz(data(X, C))
         assertz(data(X, C)),
         % call the table/4 predicate in "user"
         table(X, Y, Z, T),
         ...

Another example, using the extended notation that allows us to define
predicate aliases:

     :- uses(btrees, [new/1 as new_btree/1]).
     :- uses(queues, [new/1 as new_queue/1]).

     btree_to_queue :-
         ...,
         % the same as btrees::new(Tree)
         new_btree(Tree),
         % the same as queues::new(Queue)
         new_queue(Queue),
         ...

An example of defining a predicate alias that is also a shorthand:

     :- uses(logtalk, [
         print_message(debug, my_app, Message) as dbg(Message)
     ]).

Predicate aliases can also be used to change argument order:

     :- uses(meta, [
         fold_left(Closure,Accumulator,List,Result) as foldl(Closure,List,Accumulator,Result)
     ]).

An example of using a *note parameter variable: a1. in place of the
object identifier to allow using the same test set for checking multiple
implementations of the same protocol:

     :- object(tests(_HeapObject_),
         extends(lgtunit)).

         :- uses(_HeapObject_, [
             as_heap/2, as_list/2, valid/1, new/1,
             insert/4, insert_all/3, delete/4, merge/3,
             empty/1, size/2, top/3, top_next/5
         ]).

See also
........

*note uses/1: 4a, *note use_module/1: 4c, *note use_module/2: 4d, *note
alias/2: 165.

'directive'


File: TheLogtalkHandbook-3.100.1.info,  Node: use_module/2,  Prev: uses/2,  Up: Predicate directives<2>

2.3.4.61 ‘use_module/2’
.......................

* Menu:

* Description: Description<44>.
* Template and modes: Template and modes<37>.
* Examples: Examples<45>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<44>,  Next: Template and modes<37>,  Up: use_module/2

2.3.4.62 Description
....................

     use_module(Module, [Name/Arity, ...])
     use_module(Module, [Name/Arity as Alias/Arity, ...])

     use_module(Module, [Predicate as Alias, ...])

     use_module(Module, [Name//Arity, ...])
     use_module(Module, [Name//Arity as Alias//Arity, ...])

     use_module(Module, [op(Precedence,Associativity,Operator), ...])

This directive declares that all calls (made from predicates defined in
the category or object containing the directive) to the specified
predicates (or non-terminals) are to be interpreted as calls to
explicitly-qualified module predicates (or non-terminals).  Thus, this
directive may be used to simplify the writing of predicate definitions
by allowing the programmer to omit the ‘Module:’ prefix when using the
predicates listed in the directive (as long as the predicate calls do
not occur as arguments for non-standard Prolog meta-predicates not
declared on the adapter files).  It is also possible to include operator
declarations in the second argument.

This directive is also taken into account when compiling calls to the
*note database: 1af. and *note reflection: 1c4. built-in methods by
looking into these methods predicate arguments if bound at compile-time.

It is possible to specify a predicate alias using the notation
‘Name/Arity as Alias/Arity’ or, in alternative, the notation
‘Name/Arity:Alias/Arity’.  Aliases may be used either for avoiding
conflicts between predicates specified in ‘use_module/2’ and *note
uses/2: 4b. directives or for giving more meaningful names considering
the calling context of the predicates.  For predicates, it is also
possible to define alias shorthands using the notation ‘Predicate as
Alias’ or, in alternative, the notation ‘Predicate::Alias’, where
‘Predicate’ and ‘Alias’ are callable terms where some or all arguments
may be instantiated.

Note that this directive differs from the directive with the same name
found on some Prolog implementations by requiring the first argument to
be a module name (an atom) instead of a file specification.  In Logtalk,
there’s no mixing between 'loading' a resource and (declaring the)
'using' (of) a resource.  As a consequence, this directive doesn’t
automatically load the module.  Loading the module file is dependent on
the used *note backend Prolog compiler: 34. and must be done separately
(usually, using a source file directive such as ‘use_module/1’ or
‘use_module/2’ in the entity file or preferably in the application *note
loader file: 4f. file).  Also, note that the name of the module may
differ from the name of the module file.

     Warning: The modules 'must' be loaded prior to the compilation of
     entities that call the module predicates.  This is required in
     general to allow the compiler to check if the called module
     predicate is a meta-predicate and retrieve its meta-predicate
     template to ensure proper call compilation.

The module identifier argument can also be a *note parameter variable:
a1. when using the directive in a parametric object or a parametric
category defined in a source file (the common case).  In this case,
*note dynamic binding: 36. will be used for all listed predicates (and
non-terminals).  The parameter variable must be instantiated at runtime
when the calls are made.


File: TheLogtalkHandbook-3.100.1.info,  Node: Template and modes<37>,  Next: Examples<45>,  Prev: Description<44>,  Up: use_module/2

2.3.4.63 Template and modes
...........................

     use_module(+module_identifier, +predicate_indicator_list)
     use_module(+module_identifier, +module_predicate_indicator_alias_list)

     use_module(+module_identifier, +predicate_template_alias_list)

     use_module(+module_identifier, +non_terminal_indicator_list)
     use_module(+module_identifier, +module_non_terminal_indicator_alias_list)

     use_module(+module_identifier, +operator_list)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<45>,  Prev: Template and modes<37>,  Up: use_module/2

2.3.4.64 Examples
.................

     :- use_module(lists, [append/3, member/2]).
     :- use_module(store, [data/2]).
     :- use_module(user,  [foo/1 as bar/1]).

     foo :-
         ...,
         % same as findall(X, lists:member(X, L), A)
         findall(X, member(X, L), A),
         % same as lists:append(A, B, C)
         append(A, B, C),
         % same as assertz(store:data(X, C))
         assertz(data(X, C)),
         % same as retractall(user:foo(_))
         retractall(bar(_)),
         ...

Another example, using the extended notation that allows us to define
predicate aliases:

     :- use_module(ugraphs, [transpose_ugraph/2 as transpose/2]).

     convert_graph :-
         ...,
         % the same as ugraphs:transpose_ugraph(Graph0, Graph)
         transpose(Graph0, Graph),
         ...

An example of defining a predicate alias that is also a shorthand:

     :- use_module(pairs, [
         map_list_to_pairs(length, Lists, Pairs) as length_pairs(Lists, Pairs)
     ]).

An example of using a *note parameter variable: a1. in place of the
module identifier to delay to runtime the actual module to use:

     :- object(bar(_OptionsModule_)).

         :- use_module(_OptionsModule_, [
             set/2, get/2, reset/0
         ]).

See also
........

*note use_module/1: 4c, *note uses/2: 4b, *note uses/1: 4a, *note
alias/2: 165.


File: TheLogtalkHandbook-3.100.1.info,  Node: Built-in predicates,  Next: Built-in methods<2>,  Prev: Directives<2>,  Up: Reference Manual

2.4 Built-in predicates
=======================

* Menu:

* Enumerating objects, categories and protocols: Enumerating objects categories and protocols.
* Enumerating objects, categories and protocols properties: Enumerating objects categories and protocols properties.
* Creating new objects, categories and protocols: Creating new objects categories and protocols.
* Abolishing objects, categories and protocols: Abolishing objects categories and protocols.
* Objects, categories, and protocols relations: Objects categories and protocols relations.
* Event handling: Event handling<2>.
* Multi-threading::
* Multi-threading engines::
* Compiling and loading source files::
* Flags::
* Linter::


File: TheLogtalkHandbook-3.100.1.info,  Node: Enumerating objects categories and protocols,  Next: Enumerating objects categories and protocols properties,  Up: Built-in predicates

2.4.1 Enumerating objects, categories and protocols
---------------------------------------------------

'built-in predicate'

* Menu:

* current_category/1::
* current_object/1::
* current_protocol/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: current_category/1,  Next: current_object/1,  Up: Enumerating objects categories and protocols

2.4.1.1 ‘current_category/1’
............................

* Menu:

* Description: Description<45>.
* Modes and number of proofs: Modes and number of proofs<8>.
* Errors: Errors<9>.
* Examples: Examples<46>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<45>,  Next: Modes and number of proofs<8>,  Up: current_category/1

2.4.1.2 Description
...................

     current_category(Category)

Enumerates, by backtracking, all currently defined categories.  All
categories are found, either static, dynamic, or built-in.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<8>,  Next: Errors<9>,  Prev: Description<45>,  Up: current_category/1

2.4.1.3 Modes and number of proofs
..................................

     current_category(?category_identifier) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<9>,  Next: Examples<46>,  Prev: Modes and number of proofs<8>,  Up: current_category/1

2.4.1.4 Errors
..............

     ‘Category’ is neither a variable nor a valid category identifier:
          ‘type_error(category_identifier, Category)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<46>,  Prev: Errors<9>,  Up: current_category/1

2.4.1.5 Examples
................

     % enumerate the defined categories:
     | ?- current_category(Category).

     Category = core_messages ;
     ...

See also
........

*note abolish_category/1: f5, *note category_property/2: 12c, *note
create_category/4: 11a, *note complements_object/2: c3, *note
extends_category/2-3: 129, *note imports_category/2-3: c0.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: current_object/1,  Next: current_protocol/1,  Prev: current_category/1,  Up: Enumerating objects categories and protocols

2.4.1.6 ‘current_object/1’
..........................

* Menu:

* Description: Description<46>.
* Modes and number of proofs: Modes and number of proofs<9>.
* Errors: Errors<10>.
* Examples: Examples<47>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<46>,  Next: Modes and number of proofs<9>,  Up: current_object/1

2.4.1.7 Description
...................

     current_object(Object)

Enumerates, by backtracking, all currently defined objects.  All objects
are found, either static, dynamic or built-in.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<9>,  Next: Errors<10>,  Prev: Description<46>,  Up: current_object/1

2.4.1.8 Modes and number of proofs
..................................

     current_object(?object_identifier) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<10>,  Next: Examples<47>,  Prev: Modes and number of proofs<9>,  Up: current_object/1

2.4.1.9 Errors
..............

     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<47>,  Prev: Errors<10>,  Up: current_object/1

2.4.1.10 Examples
.................

     % enumerate the defined objects:
     | ?- current_object(Object).

     Object = user ;
     Object = logtalk ;
     ...

See also
........

*note abolish_object/1: 64, *note create_object/4: 62, *note
object_property/2: c6, *note extends_object/2-3: bf, *note
instantiates_class/2-3: bd, *note specializes_class/2-3: be, *note
complements_object/2: c3.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: current_protocol/1,  Prev: current_object/1,  Up: Enumerating objects categories and protocols

2.4.1.11 ‘current_protocol/1’
.............................

* Menu:

* Description: Description<47>.
* Modes and number of proofs: Modes and number of proofs<10>.
* Errors: Errors<11>.
* Examples: Examples<48>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<47>,  Next: Modes and number of proofs<10>,  Up: current_protocol/1

2.4.1.12 Description
....................

     current_protocol(Protocol)

Enumerates, by backtracking, all currently defined protocols.  All
protocols are found, either static, dynamic, or built-in.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<10>,  Next: Errors<11>,  Prev: Description<47>,  Up: current_protocol/1

2.4.1.13 Modes and number of proofs
...................................

     current_protocol(?protocol_identifier) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<11>,  Next: Examples<48>,  Prev: Modes and number of proofs<10>,  Up: current_protocol/1

2.4.1.14 Errors
...............

     ‘Protocol’ is neither a variable nor a valid protocol identifier:
          ‘type_error(protocol_identifier, Protocol)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<48>,  Prev: Errors<11>,  Up: current_protocol/1

2.4.1.15 Examples
.................

     % enumerate the defined protocols:
     | ?- current_protocol(Protocol).

     Protocol = expanding ;
     Protocol = monitoring ;
     Protocol = forwarding ;
     ...

See also
........

*note abolish_protocol/1: e6, *note create_protocol/3: e3, *note
protocol_property/2: f4, *note conforms_to_protocol/2-3: c2, *note
extends_protocol/2-3: f0, *note implements_protocol/2-3: c1.


File: TheLogtalkHandbook-3.100.1.info,  Node: Enumerating objects categories and protocols properties,  Next: Creating new objects categories and protocols,  Prev: Enumerating objects categories and protocols,  Up: Built-in predicates

2.4.2 Enumerating objects, categories and protocols properties
--------------------------------------------------------------

'built-in predicate'

* Menu:

* category_property/2::
* object_property/2::
* protocol_property/2::


File: TheLogtalkHandbook-3.100.1.info,  Node: category_property/2,  Next: object_property/2,  Up: Enumerating objects categories and protocols properties

2.4.2.1 ‘category_property/2’
.............................

* Menu:

* Description: Description<48>.
* Modes and number of proofs: Modes and number of proofs<11>.
* Errors: Errors<12>.
* Examples: Examples<49>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<48>,  Next: Modes and number of proofs<11>,  Up: category_property/2

2.4.2.2 Description
...................

     category_property(Category, Property)

Enumerates, by backtracking, the properties associated with the defined
categories.  The valid properties are listed in the language grammar
section on *note entity properties: c8. and described in the User Manual
section on *note category properties: 12a.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<11>,  Next: Errors<12>,  Prev: Description<48>,  Up: category_property/2

2.4.2.3 Modes and number of proofs
..................................

     category_property(?category_identifier, ?category_property) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<12>,  Next: Examples<49>,  Prev: Modes and number of proofs<11>,  Up: category_property/2

2.4.2.4 Errors
..............

     ‘Category’ is neither a variable nor a valid category identifier:
          ‘type_error(category_identifier, Category)’
          
     ‘Property’ is neither a variable nor a callable term:
          ‘type_error(callable, Property)’
     ‘Property’ is a callable term but not a valid category property:
          ‘domain_error(category_property, Property)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<49>,  Prev: Errors<12>,  Up: category_property/2

2.4.2.5 Examples
................

     % enumerate the properties of the core_messages built-in category:
     | ?- category_property(core_messages, Property).

     Property = source_data ;
     Property = static ;
     Property = built_in ;
     ...

See also
........

*note abolish_category/1: f5, *note create_category/4: 11a, *note
current_category/1: f1, *note complements_object/2: c3, *note
extends_category/2-3: 129, *note imports_category/2-3: c0.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: object_property/2,  Next: protocol_property/2,  Prev: category_property/2,  Up: Enumerating objects categories and protocols properties

2.4.2.6 ‘object_property/2’
...........................

* Menu:

* Description: Description<49>.
* Modes and number of proofs: Modes and number of proofs<12>.
* Errors: Errors<13>.
* Examples: Examples<50>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<49>,  Next: Modes and number of proofs<12>,  Up: object_property/2

2.4.2.7 Description
...................

     object_property(Object, Property)

Enumerates, by backtracking, the properties associated with the defined
objects.  The valid properties are listed in the language grammar
section on *note entity properties: c8. and described in the User Manual
section on *note object properties: c5.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<12>,  Next: Errors<13>,  Prev: Description<49>,  Up: object_property/2

2.4.2.8 Modes and number of proofs
..................................

     object_property(?object_identifier, ?object_property) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<13>,  Next: Examples<50>,  Prev: Modes and number of proofs<12>,  Up: object_property/2

2.4.2.9 Errors
..............

     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Property’ is neither a variable nor a callable term:
          ‘type_error(callable, Property)’
     ‘Property’ is a callable term but not a valid object property:
          ‘domain_error(object_property, Property)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<50>,  Prev: Errors<13>,  Up: object_property/2

2.4.2.10 Examples
.................

     % enumerate the properties of the logtalk built-in object:
     | ?- object_property(logtalk, Property).

     Property = context_switching_calls ;
     Property = source_data ;
     Property = threaded ;
     Property = static ;
     Property = built_in ;
     ...

See also
........

*note abolish_object/1: 64, *note create_object/4: 62, *note
current_object/1: a6, *note extends_object/2-3: bf, *note
instantiates_class/2-3: bd, *note specializes_class/2-3: be, *note
complements_object/2: c3.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: protocol_property/2,  Prev: object_property/2,  Up: Enumerating objects categories and protocols properties

2.4.2.11 ‘protocol_property/2’
..............................

* Menu:

* Description: Description<50>.
* Modes and number of proofs: Modes and number of proofs<13>.
* Errors: Errors<14>.
* Examples: Examples<51>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<50>,  Next: Modes and number of proofs<13>,  Up: protocol_property/2

2.4.2.12 Description
....................

     protocol_property(Protocol, Property)

Enumerates, by backtracking, the properties associated with the
currently defined protocols.  The valid properties are listed in the
language grammar section on *note entity properties: c8. and described
in the User Manual section on *note protocol properties: f3.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<13>,  Next: Errors<14>,  Prev: Description<50>,  Up: protocol_property/2

2.4.2.13 Modes and number of proofs
...................................

     protocol_property(?protocol_identifier, ?protocol_property) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<14>,  Next: Examples<51>,  Prev: Modes and number of proofs<13>,  Up: protocol_property/2

2.4.2.14 Errors
...............

     ‘Protocol’ is neither a variable nor a valid protocol identifier:
          ‘type_error(protocol_identifier, Protocol)’
     ‘Property’ is neither a variable nor a callable term:
          ‘type_error(callable, Property)’
     ‘Property’ is a callable term but not a valid protocol property:
          ‘domain_error(protocol_property, Property)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<51>,  Prev: Errors<14>,  Up: protocol_property/2

2.4.2.15 Examples
.................

     % enumerate the properties of the monitoring built-in protocol:
     | ?- protocol_property(monitoring, Property).

     Property = source_data ;
     Property = static ;
     Property = built_in ;
     ...

See also
........

*note abolish_protocol/1: e6, *note create_protocol/3: e3, *note
current_protocol/1: e0, *note conforms_to_protocol/2-3: c2, *note
extends_protocol/2-3: f0, *note implements_protocol/2-3: c1.


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating new objects categories and protocols,  Next: Abolishing objects categories and protocols,  Prev: Enumerating objects categories and protocols properties,  Up: Built-in predicates

2.4.3 Creating new objects, categories and protocols
----------------------------------------------------

'built-in predicate'

* Menu:

* create_category/4::
* create_object/4::
* create_protocol/3::


File: TheLogtalkHandbook-3.100.1.info,  Node: create_category/4,  Next: create_object/4,  Up: Creating new objects categories and protocols

2.4.3.1 ‘create_category/4’
...........................

* Menu:

* Description: Description<51>.
* Modes and number of proofs: Modes and number of proofs<14>.
* Errors: Errors<15>.
* Examples: Examples<52>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<51>,  Next: Modes and number of proofs<14>,  Up: create_category/4

2.4.3.2 Description
...................

     create_category(Identifier, Relations, Directives, Clauses)

Creates a new, dynamic category.  This predicate is often used as a
primitive to implement high-level category creation methods.

Note that, when opting for runtime generated category identifiers, it’s
possible to run out of identifiers when using a *note backend Prolog
compiler: 34. with bounded integer support.  The portable solution, when
creating a large number of dynamic categories in long-running
applications, is to recycle, whenever possible, the identifiers.

When creating a new dynamic parametric category, access to the object
parameters must use the *note parameter/2: a2. built-in execution
context method.

When using Logtalk multi-threading features, predicates calling this
built-in predicate may need to be declared synchronized in order to
avoid race conditions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<14>,  Next: Errors<15>,  Prev: Description<51>,  Up: create_category/4

2.4.3.3 Modes and number of proofs
..................................

     create_category(?category_identifier, @list(category_relation), @list(category_directive), @list(clause)) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<15>,  Next: Examples<52>,  Prev: Modes and number of proofs<14>,  Up: create_category/4

2.4.3.4 Errors
..............

     ‘Relations’, ‘Directives’, or ‘Clauses’ is a variable:
          ‘instantiation_error’
     ‘Identifier’ is neither a variable nor a valid category identifier:
          ‘type_error(category_identifier, Identifier)’
     ‘Identifier’ is a valid object identifier but one of its arguments, ‘Parameter’, is not a variable:
          ‘type_error(variable, Parameter)’
     ‘Identifier’ is already in use:
          ‘permission_error(modify, category, Identifier)’
          ‘permission_error(modify, object, Identifier)’
          ‘permission_error(modify, protocol, Identifier)’
     ‘Relations’ is neither a variable nor a proper list:
          ‘type_error(list, Relations)’
     Repeated entity relation clause:
          ‘permission_error(repeat, entity_relation, implements/1)’
          ‘permission_error(repeat, entity_relation, extends/1)’
          ‘permission_error(repeat, entity_relation, complements/1)’
     ‘Directives’ is neither a variable nor a proper list:
          ‘type_error(list, Directives)’
     ‘Clauses’ is neither a variable nor a proper list:
          ‘type_error(list, Clauses)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<52>,  Prev: Errors<15>,  Up: create_category/4

2.4.3.5 Examples
................

     | ?- create_category(
             tolerances,
             [implements(comparing)],
             [],
             [epsilon(1e-15), (equal(X, Y) :- epsilon(E), abs(X-Y) =< E)]
          ).

See also
........

*note abolish_category/1: f5, *note category_property/2: 12c, *note
current_category/1: f1, *note complements_object/2: c3, *note
extends_category/2-3: 129, *note imports_category/2-3: c0.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: create_object/4,  Next: create_protocol/3,  Prev: create_category/4,  Up: Creating new objects categories and protocols

2.4.3.6 ‘create_object/4’
.........................

* Menu:

* Description: Description<52>.
* Modes and number of proofs: Modes and number of proofs<15>.
* Errors: Errors<16>.
* Examples: Examples<53>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<52>,  Next: Modes and number of proofs<15>,  Up: create_object/4

2.4.3.7 Description
...................

     create_object(Identifier, Relations, Directives, Clauses)

Creates a new, dynamic object.  The word *note object: 533. is used here
as a generic term.  This predicate can be used to create new prototypes,
instances, and classes.  This predicate is often used as a primitive to
implement high-level object creation methods.

Note that, when opting for runtime generated object identifiers, it’s
possible to run out of identifiers when using a *note backend Prolog
compiler: 34. with bounded integer support.  The portable solution, when
creating a large number of dynamic objects in long-running applications,
is to recycle, whenever possible, the identifiers.

When creating a new dynamic parametric object, access to the object
parameters must use the *note parameter/2: a2. built-in execution
context method.

Declared predicates (using scope directives in the ‘Directives’
argument) are implicitly declared also as dynamic.

When using Logtalk multi-threading features, predicates calling this
built-in predicate may need to be declared synchronized in order to
avoid race conditions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<15>,  Next: Errors<16>,  Prev: Description<52>,  Up: create_object/4

2.4.3.8 Modes and number of proofs
..................................

     create_object(?object_identifier, @list(object_relation), @list(object_directive), @list(clause)) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<16>,  Next: Examples<53>,  Prev: Modes and number of proofs<15>,  Up: create_object/4

2.4.3.9 Errors
..............

     ‘Relations’, ‘Directives’, or ‘Clauses’ is a variable:
          ‘instantiation_error’
     ‘Identifier’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Identifier)’
     ‘Identifier’ is a valid object identifier but one of its arguments, ‘Parameter’, is not a variable:
          ‘type_error(variable, Parameter)’
     ‘Identifier’ is already in use:
          ‘permission_error(modify, category, Identifier)’
          ‘permission_error(modify, object, Identifier)’
          ‘permission_error(modify, protocol, Identifier)’
     ‘Relations’ is neither a variable nor a proper list:
          ‘type_error(list, Relations)’
     Repeated entity relation clause:
          ‘permission_error(repeat, entity_relation, implements/1)’
          ‘permission_error(repeat, entity_relation, imports/1)’
          ‘permission_error(repeat, entity_relation, extends/1)’
          ‘permission_error(repeat, entity_relation, instantiates/1)’
          ‘permission_error(repeat, entity_relation, specializes/1)’
     ‘Directives’ is neither a variable nor a proper list:
          ‘type_error(list, Directives)’
     ‘Clauses’ is neither a variable nor a proper list:
          ‘type_error(list, Clauses)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<53>,  Prev: Errors<16>,  Up: create_object/4

2.4.3.10 Examples
.................

     % create a stand-alone object (a prototype):
     | ?- create_object(
              translator,
              [],
              [public(int/2)],
              [int(0, zero)]
          ).

     % create a prototype derived from a parent prototype:
     | ?- create_object(
              mickey,
              [extends(mouse)],
              [public(alias/1)],
              [alias(mortimer)]
          ).

     % create a class instance:
     | ?- create_object(
              p1,
              [instantiates(person)],
              [],
              [name('Paulo Moura'), age(42)]
          ).

     % create a subclass:
     | ?- create_object(
              hovercraft,
              [specializes(vehicle)],
              [public([propeller/2, fan/2])],
              []
          ).

     % create an object with an initialization goal:
     | ?- create_object(
              runner,
              [instantiates(runners)],
              [initialization(::start)],
              [length(22), time(60)]
          ).

     % create an object supporting dynamic predicate declarations:
     | ?- create_object(
              database,
              [],
              [set_logtalk_flag(dynamic_declarations, allow)],
              []
          ).

See also
........

*note abolish_object/1: 64, *note current_object/1: a6, *note
object_property/2: c6, *note extends_object/2-3: bf, *note
instantiates_class/2-3: bd, *note specializes_class/2-3: be, *note
complements_object/2: c3.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: create_protocol/3,  Prev: create_object/4,  Up: Creating new objects categories and protocols

2.4.3.11 ‘create_protocol/3’
............................

* Menu:

* Description: Description<53>.
* Modes and number of proofs: Modes and number of proofs<16>.
* Errors: Errors<17>.
* Examples: Examples<54>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<53>,  Next: Modes and number of proofs<16>,  Up: create_protocol/3

2.4.3.12 Description
....................

     create_protocol(Identifier, Relations, Directives)

Creates a new, dynamic, protocol.  This predicate is often used as a
primitive to implement high-level protocol creation methods.

Note that, when opting for runtime generated protocol identifiers, it’s
possible to run out of identifiers when using a *note backend Prolog
compiler: 34. with bounded integer support.  The portable solution, when
creating a large number of dynamic protocols in long-running
applications, is to recycle, whenever possible, the identifiers.

When using Logtalk multi-threading features, predicates calling this
built-in predicate may need to be declared synchronized in order to
avoid race conditions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<16>,  Next: Errors<17>,  Prev: Description<53>,  Up: create_protocol/3

2.4.3.13 Modes and number of proofs
...................................

     create_protocol(?protocol_identifier, @list(protocol_relation), @list(protocol_directive)) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<17>,  Next: Examples<54>,  Prev: Modes and number of proofs<16>,  Up: create_protocol/3

2.4.3.14 Errors
...............

     Either ‘Relations’ or ‘Directives’ is a variable:
          ‘instantiation_error’
     ‘Identifier’ is neither a variable nor a valid protocol identifier:
          ‘type_error(protocol_identifier, Identifier)’
     ‘Identifier’ is already in use:
          ‘permission_error(modify, category, Identifier)’
          ‘permission_error(modify, object, Identifier)’
          ‘permission_error(modify, protocol, Identifier)’
     ‘Relations’ is neither a variable nor a proper list:
          ‘type_error(list, Relations)’
     Repeated entity relation clause:
          ‘permission_error(repeat, entity_relation, extends/1)’
     ‘Directives’ is neither a variable nor a proper list:
          ‘type_error(list, Directives)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<54>,  Prev: Errors<17>,  Up: create_protocol/3

2.4.3.15 Examples
.................

     | ?- create_protocol(
             logging,
             [extends(monitoring)],
             [public([log_file/1, log_on/0, log_off/0])]
          ).

See also
........

*note abolish_protocol/1: e6, *note current_protocol/1: e0, *note
protocol_property/2: f4, *note conforms_to_protocol/2-3: c2, *note
extends_protocol/2-3: f0, *note implements_protocol/2-3: c1.


File: TheLogtalkHandbook-3.100.1.info,  Node: Abolishing objects categories and protocols,  Next: Objects categories and protocols relations,  Prev: Creating new objects categories and protocols,  Up: Built-in predicates

2.4.4 Abolishing objects, categories and protocols
--------------------------------------------------

'built-in predicate'

* Menu:

* abolish_category/1::
* abolish_object/1::
* abolish_protocol/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: abolish_category/1,  Next: abolish_object/1,  Up: Abolishing objects categories and protocols

2.4.4.1 ‘abolish_category/1’
............................

* Menu:

* Description: Description<54>.
* Modes and number of proofs: Modes and number of proofs<17>.
* Errors: Errors<18>.
* Examples: Examples<55>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<54>,  Next: Modes and number of proofs<17>,  Up: abolish_category/1

2.4.4.2 Description
...................

     abolish_category(Category)

Abolishes a dynamic category.  The category identifier can then be
reused when creating a new category.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<17>,  Next: Errors<18>,  Prev: Description<54>,  Up: abolish_category/1

2.4.4.3 Modes and number of proofs
..................................

     abolish_category(+category_identifier) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<18>,  Next: Examples<55>,  Prev: Modes and number of proofs<17>,  Up: abolish_category/1

2.4.4.4 Errors
..............

     ‘Category’ is a variable:
          ‘instantiation_error’
     ‘Category’ is neither a variable nor a valid category identifier:
          ‘type_error(category_identifier, Category)’
     ‘Category’ is an identifier of a static category:
          ‘permission_error(modify, static_category, Category)’
     ‘Category’ does not exist:
          ‘existence_error(category, Category)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<55>,  Prev: Errors<18>,  Up: abolish_category/1

2.4.4.5 Examples
................

     | ?- abolish_category(monitoring).

See also
........

*note category_property/2: 12c, *note create_category/4: 11a, *note
current_category/1: f1. *note complements_object/2: c3, *note
extends_category/2-3: 129, *note imports_category/2-3: c0.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: abolish_object/1,  Next: abolish_protocol/1,  Prev: abolish_category/1,  Up: Abolishing objects categories and protocols

2.4.4.6 ‘abolish_object/1’
..........................

* Menu:

* Description: Description<55>.
* Modes and number of proofs: Modes and number of proofs<18>.
* Errors: Errors<19>.
* Examples: Examples<56>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<55>,  Next: Modes and number of proofs<18>,  Up: abolish_object/1

2.4.4.7 Description
...................

     abolish_object(Object)

Abolishes a dynamic object.  The object identifier can then be reused
when creating a new object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<18>,  Next: Errors<19>,  Prev: Description<55>,  Up: abolish_object/1

2.4.4.8 Modes and number of proofs
..................................

     abolish_object(+object_identifier) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<19>,  Next: Examples<56>,  Prev: Modes and number of proofs<18>,  Up: abolish_object/1

2.4.4.9 Errors
..............

     ‘Object’ is a variable:
          ‘instantiation_error’
     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Object’ is an identifier of a static object:
          ‘permission_error(modify, static_object, Object)’
     ‘Object’ does not exist:
          ‘existence_error(object, Object)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<56>,  Prev: Errors<19>,  Up: abolish_object/1

2.4.4.10 Examples
.................

     | ?- abolish_object(list).

See also
........

*note create_object/4: 62, *note current_object/1: a6, *note
object_property/2: c6, *note extends_object/2-3: bf, *note
instantiates_class/2-3: bd, *note specializes_class/2-3: be, *note
complements_object/2: c3.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: abolish_protocol/1,  Prev: abolish_object/1,  Up: Abolishing objects categories and protocols

2.4.4.11 ‘abolish_protocol/1’
.............................

* Menu:

* Description: Description<56>.
* Modes and number of proofs: Modes and number of proofs<19>.
* Errors: Errors<20>.
* Examples: Examples<57>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<56>,  Next: Modes and number of proofs<19>,  Up: abolish_protocol/1

2.4.4.12 Description
....................

     abolish_protocol(Protocol)

Abolishes a dynamic protocol.  The protocol identifier can then be
reused when creating a new protocol.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<19>,  Next: Errors<20>,  Prev: Description<56>,  Up: abolish_protocol/1

2.4.4.13 Modes and number of proofs
...................................

     abolish_protocol(@protocol_identifier) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<20>,  Next: Examples<57>,  Prev: Modes and number of proofs<19>,  Up: abolish_protocol/1

2.4.4.14 Errors
...............

     ‘Protocol’ is a variable:
          ‘instantiation_error’
     ‘Protocol’ is neither a variable nor a valid protocol identifier:
          ‘type_error(protocol_identifier, Protocol)’
     ‘Protocol’ is an identifier of a static protocol:
          ‘permission_error(modify, static_protocol, Protocol)’
     ‘Protocol’ does not exist:
          ‘existence_error(protocol, Protocol)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<57>,  Prev: Errors<20>,  Up: abolish_protocol/1

2.4.4.15 Examples
.................

     | ?- abolish_protocol(listp).

See also
........

*note create_protocol/3: e3, *note current_protocol/1: e0, *note
protocol_property/2: f4, *note conforms_to_protocol/2-3: c2, *note
extends_protocol/2-3: f0, *note implements_protocol/2-3: c1.


File: TheLogtalkHandbook-3.100.1.info,  Node: Objects categories and protocols relations,  Next: Event handling<2>,  Prev: Abolishing objects categories and protocols,  Up: Built-in predicates

2.4.5 Objects, categories, and protocols relations
--------------------------------------------------

'built-in predicate'

* Menu:

* extends_object/2-3::
* extends_protocol/2-3::
* extends_category/2-3::
* implements_protocol/2-3::
* conforms_to_protocol/2-3::
* complements_object/2::
* imports_category/2-3::
* instantiates_class/2-3::
* specializes_class/2-3::


File: TheLogtalkHandbook-3.100.1.info,  Node: extends_object/2-3,  Next: extends_protocol/2-3,  Up: Objects categories and protocols relations

2.4.5.1 ‘extends_object/2-3’
............................

* Menu:

* Description: Description<57>.
* Modes and number of proofs: Modes and number of proofs<20>.
* Errors: Errors<21>.
* Examples: Examples<58>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<57>,  Next: Modes and number of proofs<20>,  Up: extends_object/2-3

2.4.5.2 Description
...................

     extends_object(Prototype, Parent)
     extends_object(Prototype, Parent, Scope)

Enumerates, by backtracking, all pairs of objects such that the first
one extends the second.  The relation scope is represented by the atoms
‘public’, ‘protected’, and ‘private’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<20>,  Next: Errors<21>,  Prev: Description<57>,  Up: extends_object/2-3

2.4.5.3 Modes and number of proofs
..................................

     extends_object(?object_identifier, ?object_identifier) - zero_or_more
     extends_object(?object_identifier, ?object_identifier, ?scope) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<21>,  Next: Examples<58>,  Prev: Modes and number of proofs<20>,  Up: extends_object/2-3

2.4.5.4 Errors
..............

     ‘Prototype’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Prototype)’
     ‘Parent’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Parent)’
     ‘Scope’ is neither a variable nor an atom:
          ‘type_error(atom, Scope)’
     ‘Scope’ is an atom but an invalid entity scope:
          ‘domain_error(scope, Scope)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<58>,  Prev: Errors<21>,  Up: extends_object/2-3

2.4.5.5 Examples
................

     % enumerate objects derived from the state_space prototype:
     | ?- extends_object(Object, state_space).

     % enumerate objects publicly derived from the list prototype:
     | ?- extends_object(Object, list, public).

See also
........

*note current_object/1: a6, *note instantiates_class/2-3: bd, *note
specializes_class/2-3: be.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: extends_protocol/2-3,  Next: extends_category/2-3,  Prev: extends_object/2-3,  Up: Objects categories and protocols relations

2.4.5.6 ‘extends_protocol/2-3’
..............................

* Menu:

* Description: Description<58>.
* Modes and number of proofs: Modes and number of proofs<21>.
* Errors: Errors<22>.
* Examples: Examples<59>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<58>,  Next: Modes and number of proofs<21>,  Up: extends_protocol/2-3

2.4.5.7 Description
...................

     extends_protocol(Protocol, ParentProtocol)
     extends_protocol(Protocol, ParentProtocol, Scope)

Enumerates, by backtracking, all pairs of protocols such that the first
one extends the second.  The relation scope is represented by the atoms
‘public’, ‘protected’, and ‘private’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<21>,  Next: Errors<22>,  Prev: Description<58>,  Up: extends_protocol/2-3

2.4.5.8 Modes and number of proofs
..................................

     extends_protocol(?protocol_identifier, ?protocol_identifier) - zero_or_more
     extends_protocol(?protocol_identifier, ?protocol_identifier, ?scope) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<22>,  Next: Examples<59>,  Prev: Modes and number of proofs<21>,  Up: extends_protocol/2-3

2.4.5.9 Errors
..............

     ‘Protocol’ is neither a variable nor a valid protocol identifier:
          ‘type_error(protocol_identifier, Protocol)’
     ‘ParentProtocol’ is neither a variable nor a valid protocol identifier:
          ‘type_error(protocol_identifier, ParentProtocol)’
     ‘Scope’ is neither a variable nor an atom:
          ‘type_error(atom, Scope)’
     ‘Scope’ is an atom but an invalid entity scope:
          ‘domain_error(scope, Scope)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<59>,  Prev: Errors<22>,  Up: extends_protocol/2-3

2.4.5.10 Examples
.................

     % enumerate the protocols extended by the listp protocol:
     | ?- extends_protocol(listp, Protocol).

     % enumerate protocols that privately extend the termp protocol:
     | ?- extends_protocol(Protocol, termp, private).

See also
........

*note current_protocol/1: e0, *note implements_protocol/2-3: c1, *note
conforms_to_protocol/2-3: c2.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: extends_category/2-3,  Next: implements_protocol/2-3,  Prev: extends_protocol/2-3,  Up: Objects categories and protocols relations

2.4.5.11 ‘extends_category/2-3’
...............................

* Menu:

* Description: Description<59>.
* Modes and number of proofs: Modes and number of proofs<22>.
* Errors: Errors<23>.
* Examples: Examples<60>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<59>,  Next: Modes and number of proofs<22>,  Up: extends_category/2-3

2.4.5.12 Description
....................

     extends_category(Category, ParentCategory)
     extends_category(Category, ParentCategory, Scope)

Enumerates, by backtracking, all pairs of categories such that the first
one extends the second.  The relation scope is represented by the atoms
‘public’, ‘protected’, and ‘private’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<22>,  Next: Errors<23>,  Prev: Description<59>,  Up: extends_category/2-3

2.4.5.13 Modes and number of proofs
...................................

     extends_category(?category_identifier, ?category_identifier) - zero_or_more
     extends_category(?category_identifier, ?category_identifier, ?scope) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<23>,  Next: Examples<60>,  Prev: Modes and number of proofs<22>,  Up: extends_category/2-3

2.4.5.14 Errors
...............

     ‘Category’ is neither a variable nor a valid protocol identifier:
          ‘type_error(category_identifier, Category)’
     ‘ParentCategory’ is neither a variable nor a valid protocol identifier:
          ‘type_error(category_identifier, ParentCategory)’
     ‘Scope’ is neither a variable nor an atom:
          ‘type_error(atom, Scope)’
     ‘Scope’ is an atom but an invalid entity scope:
          ‘domain_error(scope, Scope)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<60>,  Prev: Errors<23>,  Up: extends_category/2-3

2.4.5.15 Examples
.................

     % enumerate the categories extended by the derailleur category:
     | ?- extends_category(derailleur, Category).

     % enumerate categories that privately extend the basics category:
     | ?- extends_category(Category, basics, private).

See also
........

*note current_category/1: f1, *note complements_object/2: c3, *note
imports_category/2-3: c0.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: implements_protocol/2-3,  Next: conforms_to_protocol/2-3,  Prev: extends_category/2-3,  Up: Objects categories and protocols relations

2.4.5.16 ‘implements_protocol/2-3’
..................................

* Menu:

* Description: Description<60>.
* Modes and number of proofs: Modes and number of proofs<23>.
* Errors: Errors<24>.
* Examples: Examples<61>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<60>,  Next: Modes and number of proofs<23>,  Up: implements_protocol/2-3

2.4.5.17 Description
....................

     implements_protocol(Object, Protocol)
     implements_protocol(Category, Protocol)

     implements_protocol(Object, Protocol, Scope)
     implements_protocol(Category, Protocol, Scope)

Enumerates, by backtracking, all pairs of entities such that an object
or a category implements a protocol.  The relation scope is represented
by the atoms ‘public’, ‘protected’, and ‘private’.  This predicate only
returns direct implementation relations.  For a transitive closure, see
the *note conforms_to_protocol/2-3: c2. predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<23>,  Next: Errors<24>,  Prev: Description<60>,  Up: implements_protocol/2-3

2.4.5.18 Modes and number of proofs
...................................

     implements_protocol(?object_identifier, ?protocol_identifier) - zero_or_more
     implements_protocol(?category_identifier, ?protocol_identifier) - zero_or_more

     implements_protocol(?object_identifier, ?protocol_identifier, ?scope) - zero_or_more
     implements_protocol(?category_identifier, ?protocol_identifier, ?scope) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<24>,  Next: Examples<61>,  Prev: Modes and number of proofs<23>,  Up: implements_protocol/2-3

2.4.5.19 Errors
...............

     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Category’ is neither a variable nor a valid category identifier:
          ‘type_error(category_identifier, Category)’
     ‘Protocol’ is neither a variable nor a valid protocol identifier:
          ‘type_error(protocol_identifier, Protocol)’
     ‘Scope’ is neither a variable nor an atom:
          ‘type_error(atom, Scope)’
     ‘Scope’ is an atom but an invalid entity scope:
          ‘domain_error(scope, Scope)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<61>,  Prev: Errors<24>,  Up: implements_protocol/2-3

2.4.5.20 Examples
.................

     % check that the list object implements the listp protocol:
     | ?- implements_protocol(list, listp).

     % check that the list object publicly implements the listp protocol:
     | ?- implements_protocol(list, listp, public).

     % enumerate only objects that implement the listp protocol:
     | ?- current_object(Object), implements_protocol(Object, listp).

     % enumerate only categories that implement the serialization protocol:
     | ?- current_category(Category), implements_protocol(Category, serialization).

See also
........

*note current_object/1: a6, *note current_protocol/1: e0, *note
current_category/1: f1, *note conforms_to_protocol/2-3: c2.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: conforms_to_protocol/2-3,  Next: complements_object/2,  Prev: implements_protocol/2-3,  Up: Objects categories and protocols relations

2.4.5.21 ‘conforms_to_protocol/2-3’
...................................

* Menu:

* Description: Description<61>.
* Modes and number of proofs: Modes and number of proofs<24>.
* Errors: Errors<25>.
* Examples: Examples<62>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<61>,  Next: Modes and number of proofs<24>,  Up: conforms_to_protocol/2-3

2.4.5.22 Description
....................

     conforms_to_protocol(Object, Protocol)
     conforms_to_protocol(Category, Protocol)

     conforms_to_protocol(Object, Protocol, Scope)
     conforms_to_protocol(Category, Protocol, Scope)

Enumerates, by backtracking, all pairs of entities such that an object
or a category conforms to a protocol.  The relation scope is represented
by the atoms ‘public’, ‘protected’, and ‘private’.  This predicate
implements a transitive closure for the protocol implementation
relation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<24>,  Next: Errors<25>,  Prev: Description<61>,  Up: conforms_to_protocol/2-3

2.4.5.23 Modes and number of proofs
...................................

     conforms_to_protocol(?object_identifier, ?protocol_identifier) - zero_or_more
     conforms_to_protocol(?category_identifier, ?protocol_identifier) - zero_or_more

     conforms_to_protocol(?object_identifier, ?protocol_identifier, ?scope) - zero_or_more
     conforms_to_protocol(?category_identifier, ?protocol_identifier, ?scope) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<25>,  Next: Examples<62>,  Prev: Modes and number of proofs<24>,  Up: conforms_to_protocol/2-3

2.4.5.24 Errors
...............

     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Category’ is neither a variable nor a valid category identifier:
          ‘type_error(category_identifier, Category)’
     ‘Protocol’ is neither a variable nor a valid protocol identifier:
          ‘type_error(protocol_identifier, Protocol)’
     ‘Scope’ is neither a variable nor an atom:
          ‘type_error(atom, Scope)’
     ‘Scope’ is an atom but an invalid entity scope:
          ‘domain_error(scope, Scope)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<62>,  Prev: Errors<25>,  Up: conforms_to_protocol/2-3

2.4.5.25 Examples
.................

     % enumerate objects and categories that conform to the listp protocol:
     | ?- conforms_to_protocol(Object, listp).

     % enumerate objects and categories that privately conform to the listp protocol:
     | ?- conforms_to_protocol(Object, listp, private).

     % enumerate only objects that conform to the listp protocol:
     | ?- current_object(Object), conforms_to_protocol(Object, listp).

     % enumerate only categories that conform to the serialization protocol:
     | ?- current_category(Category), conforms_to_protocol(Category, serialization).

See also
........

*note current_object/1: a6, *note current_protocol/1: e0, *note
current_category/1: f1, *note implements_protocol/2-3: c1.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: complements_object/2,  Next: imports_category/2-3,  Prev: conforms_to_protocol/2-3,  Up: Objects categories and protocols relations

2.4.5.26 ‘complements_object/2’
...............................

* Menu:

* Description: Description<62>.
* Modes and number of proofs: Modes and number of proofs<25>.
* Errors: Errors<26>.
* Examples: Examples<63>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<62>,  Next: Modes and number of proofs<25>,  Up: complements_object/2

2.4.5.27 Description
....................

     complements_object(Category, Object)

Enumerates, by backtracking, all category–object pairs such that the
category explicitly complements the object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<25>,  Next: Errors<26>,  Prev: Description<62>,  Up: complements_object/2

2.4.5.28 Modes and number of proofs
...................................

     complements_object(?category_identifier, ?object_identifier) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<26>,  Next: Examples<63>,  Prev: Modes and number of proofs<25>,  Up: complements_object/2

2.4.5.29 Errors
...............

     ‘Category’ is neither a variable nor a valid category identifier:
          ‘type_error(category_identifier, Prototype)’
     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Parent)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<63>,  Prev: Errors<26>,  Up: complements_object/2

2.4.5.30 Examples
.................

     % check that the logging category complements the employee object:
     | ?- complements_object(logging, employee).

See also
........

*note current_category/1: f1, *note imports_category/2-3: c0.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: imports_category/2-3,  Next: instantiates_class/2-3,  Prev: complements_object/2,  Up: Objects categories and protocols relations

2.4.5.31 ‘imports_category/2-3’
...............................

* Menu:

* Description: Description<63>.
* Modes and number of proofs: Modes and number of proofs<26>.
* Errors: Errors<27>.
* Examples: Examples<64>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<63>,  Next: Modes and number of proofs<26>,  Up: imports_category/2-3

2.4.5.32 Description
....................

     imports_category(Object, Category)

     imports_category(Object, Category, Scope)

Enumerates, by backtracking, importation relations between objects and
categories.  The relation scope is represented by the atoms ‘public’,
‘protected’, and ‘private’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<26>,  Next: Errors<27>,  Prev: Description<63>,  Up: imports_category/2-3

2.4.5.33 Modes and number of proofs
...................................

     imports_category(?object_identifier, ?category_identifier) - zero_or_more
     imports_category(?object_identifier, ?category_identifier, ?scope) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<27>,  Next: Examples<64>,  Prev: Modes and number of proofs<26>,  Up: imports_category/2-3

2.4.5.34 Errors
...............

     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Category’ is neither a variable nor a valid category identifier:
          ‘type_error(category_identifier, Category)’
     ‘Scope’ is neither a variable nor an atom:
          ‘type_error(atom, Scope)’
     ‘Scope’ is an atom but an invalid entity scope:
          ‘domain_error(scope, Scope)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<64>,  Prev: Errors<27>,  Up: imports_category/2-3

2.4.5.35 Examples
.................

     % check that the xref_diagram object imports the diagram category:
     | ?- imports_category(xref_diagram, diagram).

     % enumerate the objects that privately import the diagram category:
     | ?- imports_category(Object, diagram, private).

See also
........

*note current_category/1: f1, *note complements_object/2: c3.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: instantiates_class/2-3,  Next: specializes_class/2-3,  Prev: imports_category/2-3,  Up: Objects categories and protocols relations

2.4.5.36 ‘instantiates_class/2-3’
.................................

* Menu:

* Description: Description<64>.
* Modes and number of proofs: Modes and number of proofs<27>.
* Errors: Errors<28>.
* Examples: Examples<65>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<64>,  Next: Modes and number of proofs<27>,  Up: instantiates_class/2-3

2.4.5.37 Description
....................

     instantiates_class(Instance, Class)
     instantiates_class(Instance, Class, Scope)

Enumerates, by backtracking, all pairs of objects such that the first
one instantiates the second.  The relation scope is represented by the
atoms ‘public’, ‘protected’, and ‘private’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<27>,  Next: Errors<28>,  Prev: Description<64>,  Up: instantiates_class/2-3

2.4.5.38 Modes and number of proofs
...................................

     instantiates_class(?object_identifier, ?object_identifier) - zero_or_more
     instantiates_class(?object_identifier, ?object_identifier, ?scope) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<28>,  Next: Examples<65>,  Prev: Modes and number of proofs<27>,  Up: instantiates_class/2-3

2.4.5.39 Errors
...............

     ‘Instance’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Instance)’
     ‘Class’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Class)’
     ‘Scope’ is neither a variable nor an atom:
          ‘type_error(atom, Scope)’
     ‘Scope’ is an atom but an invalid entity scope:
          ‘domain_error(scope, Scope)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<65>,  Prev: Errors<28>,  Up: instantiates_class/2-3

2.4.5.40 Examples
.................

     % check that the water_jug is an instante of state_space:
     | ?- instantiates_class(water_jug, state_space).

     % enumerate the state_space instances where the
     % instantiation relation is public:
     | ?- instantiates_class(Space, state_space, public).

See also
........

*note current_object/1: a6, *note extends_object/2-3: bf, *note
specializes_class/2-3: be.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: specializes_class/2-3,  Prev: instantiates_class/2-3,  Up: Objects categories and protocols relations

2.4.5.41 ‘specializes_class/2-3’
................................

* Menu:

* Description: Description<65>.
* Modes and number of proofs: Modes and number of proofs<28>.
* Errors: Errors<29>.
* Examples: Examples<66>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<65>,  Next: Modes and number of proofs<28>,  Up: specializes_class/2-3

2.4.5.42 Description
....................

     specializes_class(Class, Superclass)
     specializes_class(Class, Superclass, Scope)

Enumerates, by backtracking, all pairs of objects such that the first
one specializes the second.  The relation scope is represented by the
atoms ‘public’, ‘protected’, and ‘private’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<28>,  Next: Errors<29>,  Prev: Description<65>,  Up: specializes_class/2-3

2.4.5.43 Modes and number of proofs
...................................

     specializes_class(?object_identifier, ?object_identifier) - zero_or_more
     specializes_class(?object_identifier, ?object_identifier, ?scope) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<29>,  Next: Examples<66>,  Prev: Modes and number of proofs<28>,  Up: specializes_class/2-3

2.4.5.44 Errors
...............

     ‘Class’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Class)’
     ‘Superclass’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Superclass)’
     ‘Scope’ is neither a variable nor an atom:
          ‘type_error(atom, Scope)’
     ‘Scope’ is an atom but an invalid entity scope:
          ‘domain_error(scope, Scope)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<66>,  Prev: Errors<29>,  Up: specializes_class/2-3

2.4.5.45 Examples
.................

     % enumerate the state_space subclasses:
     | ?- specializes_class(Subclass, state_space).

     % enumerate the state_space subclasses where the
     % specialization relation is public:
     | ?- specializes_class(Subclass, state_space, public).

See also
........

*note current_object/1: a6, *note extends_object/2-3: bf, *note
instantiates_class/2-3: bd.


File: TheLogtalkHandbook-3.100.1.info,  Node: Event handling<2>,  Next: Multi-threading,  Prev: Objects categories and protocols relations,  Up: Built-in predicates

2.4.6 Event handling
--------------------

'built-in predicate'

* Menu:

* abolish_events/5::
* current_event/5::
* define_events/5::


File: TheLogtalkHandbook-3.100.1.info,  Node: abolish_events/5,  Next: current_event/5,  Up: Event handling<2>

2.4.6.1 ‘abolish_events/5’
..........................

* Menu:

* Description: Description<66>.
* Modes and number of proofs: Modes and number of proofs<29>.
* Errors: Errors<30>.
* Examples: Examples<67>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<66>,  Next: Modes and number of proofs<29>,  Up: abolish_events/5

2.4.6.2 Description
...................

     abolish_events(Event, Object, Message, Sender, Monitor)

Abolishes all matching events.  The two types of events are represented
by the atoms ‘before’ and ‘after’.  When the predicate is called with
the first argument unbound, both types of events are abolished.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<29>,  Next: Errors<30>,  Prev: Description<66>,  Up: abolish_events/5

2.4.6.3 Modes and number of proofs
..................................

     abolish_events(@term, @term, @term, @term, @term) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<30>,  Next: Examples<67>,  Prev: Modes and number of proofs<29>,  Up: abolish_events/5

2.4.6.4 Errors
..............

     ‘Event’ is neither a variable nor a valid event identifier:
          ‘type_error(event, Event)’
     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Message’ is neither a variable nor a callable term:
          ‘type_error(callable, Message)’
     ‘Sender’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Sender)’
     ‘Monitor’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Monitor)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<67>,  Prev: Errors<30>,  Up: abolish_events/5

2.4.6.5 Examples
................

     % abolish all events for messages sent to the "list"
     % object being monitored by the "debugger" object:
     | ?- abolish_events(_, list, _, _, debugger).

See also
........

*note current_event/5: 21e, *note define_events/5: 218, *note before/3:
101, *note after/3: 102.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: current_event/5,  Next: define_events/5,  Prev: abolish_events/5,  Up: Event handling<2>

2.4.6.6 ‘current_event/5’
.........................

* Menu:

* Description: Description<67>.
* Modes and number of proofs: Modes and number of proofs<30>.
* Errors: Errors<31>.
* Examples: Examples<68>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<67>,  Next: Modes and number of proofs<30>,  Up: current_event/5

2.4.6.7 Description
...................

     current_event(Event, Object, Message, Sender, Monitor)

Enumerates, by backtracking, all defined events.  The two types of
events are represented by the atoms ‘before’ and ‘after’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<30>,  Next: Errors<31>,  Prev: Description<67>,  Up: current_event/5

2.4.6.8 Modes and number of proofs
..................................

     current_event(?event, ?term, ?term, ?term, ?object_identifier) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<31>,  Next: Examples<68>,  Prev: Modes and number of proofs<30>,  Up: current_event/5

2.4.6.9 Errors
..............

     ‘Event’ is neither a variable nor a valid event identifier:
          ‘type_error(event, Event)’
     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Message’ is neither a variable nor a callable term:
          ‘type_error(callable, Message)’
     ‘Sender’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Sender)’
     ‘Monitor’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Monitor)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<68>,  Prev: Errors<31>,  Up: current_event/5

2.4.6.10 Examples
.................

     % enumerate all events monitored by the "debugger" object:
     | ?- current_event(Event, Object, Message, Sender, debugger).

See also
........

*note abolish_events/5: 21b, *note define_events/5: 218, *note before/3:
101, *note after/3: 102.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: define_events/5,  Prev: current_event/5,  Up: Event handling<2>

2.4.6.11 ‘define_events/5’
..........................

* Menu:

* Description: Description<68>.
* Modes and number of proofs: Modes and number of proofs<31>.
* Errors: Errors<32>.
* Examples: Examples<69>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<68>,  Next: Modes and number of proofs<31>,  Up: define_events/5

2.4.6.12 Description
....................

     define_events(Event, Object, Message, Sender, Monitor)

Defines a new set of events.  The two types of events are represented by
the atoms ‘before’ and ‘after’.  When the predicate is called with the
first argument unbound, both types of events are defined.  The object
‘Monitor’ must define the event handler methods required by the ‘Event’
argument.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<31>,  Next: Errors<32>,  Prev: Description<68>,  Up: define_events/5

2.4.6.13 Modes and number of proofs
...................................

     define_events(@term, @term, @term, @term, +object_identifier) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<32>,  Next: Examples<69>,  Prev: Modes and number of proofs<31>,  Up: define_events/5

2.4.6.14 Errors
...............

     ‘Event’ is neither a variable nor a valid event identifier:
          ‘type_error(event, Event)’
     ‘Object’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Object)’
     ‘Message’ is neither a variable nor a callable term:
          ‘type_error(callable, Message)’
     ‘Sender’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Sender)’
     ‘Monitor’ is a variable:
          ‘instantiation_error’
     ‘Monitor’ is neither a variable nor a valid object identifier:
          ‘type_error(object_identifier, Monitor)’
     ‘Monitor’ does not define the required ‘before/3’ method:
          ‘existence_error(procedure, before/3)’
     ‘Monitor’ does not define the required ‘after/3’ method:
          ‘existence_error(procedure, after/3)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<69>,  Prev: Errors<32>,  Up: define_events/5

2.4.6.15 Examples
.................

     % define "debugger" as a monitor for member/2 messages
     % sent to the "list" object:
     | ?- define_events(_, list, member(_, _), _ , debugger).

See also
........

*note abolish_events/5: 21b, *note current_event/5: 21e, *note before/3:
101, *note after/3: 102.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading,  Next: Multi-threading engines,  Prev: Event handling<2>,  Up: Built-in predicates

2.4.7 Multi-threading
---------------------

'built-in predicate'

* Menu:

* threaded/1::
* threaded_call/1-2::
* threaded_once/1-2::
* threaded_ignore/1::
* threaded_exit/1-2::
* threaded_peek/1-2::
* threaded_cancel/1::
* threaded_wait/1::
* threaded_notify/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded/1,  Next: threaded_call/1-2,  Up: Multi-threading

2.4.7.1 ‘threaded/1’
....................

* Menu:

* Description: Description<69>.
* Meta-predicate template::
* Modes and number of proofs: Modes and number of proofs<32>.
* Errors: Errors<33>.
* Examples: Examples<70>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<69>,  Next: Meta-predicate template,  Up: threaded/1

2.4.7.2 Description
...................

     threaded(Conjunction)
     threaded(Disjunction)

Proves each goal in a conjunction or a disjunction of goals in its own
thread.  This meta-predicate is deterministic and opaque to cuts.  The
predicate argument is 'not' flattened.

When the argument is a conjunction of goals, a call to this predicate
blocks until either all goals succeed, one of the goals fail, or one of
the goals generate an exception; the failure of one of the goals or an
exception on the execution of one of the goals results in the
termination of the remaining threads.  The predicate call is true 'iff'
all goals are true.  The predicate call fails if all goals fail.  When
one of the goals throws an exception, the predicate call re-throws that
exception.

When the argument is a disjunction of goals, a call to this predicate
blocks until either one of the goals succeeds or all the goals fail or
throw exceptions; the success of one of the goals results in the
termination of the remaining threads.  The predicate call is true 'iff'
one of the goals is true.  The predicate call fails if all goals fails.
When no goal succeeds and one of the goals throws an exception, the
predicate call re-throws that exception.

When the predicate argument is neither a conjunction nor a disjunction
of goals, no threads are used.  In this case, the predicate call is
equivalent to a ‘once/1’ predicate call.

A dedicated message queue is used per call of this predicate to collect
the individual goal results.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template,  Next: Modes and number of proofs<32>,  Prev: Description<69>,  Up: threaded/1

2.4.7.3 Meta-predicate template
...............................

     threaded(0)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<32>,  Next: Errors<33>,  Prev: Meta-predicate template,  Up: threaded/1

2.4.7.4 Modes and number of proofs
..................................

     threaded(+callable) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<33>,  Next: Examples<70>,  Prev: Modes and number of proofs<32>,  Up: threaded/1

2.4.7.5 Errors
..............

     ‘Goals’ is a variable:
          ‘instantiation_error’
     A goal in ‘Goals’ is a variable:
          ‘instantiation_error’
     ‘Goals’ is neither a variable nor a callable term:
          ‘type_error(callable, Goals)’
     A goal ‘Goal’ in ‘Goals’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<70>,  Prev: Errors<33>,  Up: threaded/1

2.4.7.6 Examples
................

     Prove a conjunction of goals, each one in its own thread:
          ‘threaded((Goal, Goals))’
     Prove a disjunction of goals, each one in its own thread:
          ‘threaded((Goal; Goals))’

See also
........

*note threaded_call/1-2: 230, *note threaded_once/1-2: 232, *note
threaded_ignore/1: 237, *note synchronized/1: 74.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_call/1-2,  Next: threaded_once/1-2,  Prev: threaded/1,  Up: Multi-threading

2.4.7.7 ‘threaded_call/1-2’
...........................

* Menu:

* Description: Description<70>.
* Meta-predicate template: Meta-predicate template<2>.
* Modes and number of proofs: Modes and number of proofs<33>.
* Errors: Errors<34>.
* Examples: Examples<71>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<70>,  Next: Meta-predicate template<2>,  Up: threaded_call/1-2

2.4.7.8 Description
...................

     threaded_call(Goal)
     threaded_call(Goal, Tag)

Proves ‘Goal’ asynchronously using a new thread.  The argument can be a
message-sending goal.  Calls to this predicate always succeed and return
immediately.  The results (success, failure, or exception) are sent back
to the message queue of the object containing the call (*note this:
114.) and can be retrieved by calling the *note threaded_exit/1: 231.
predicate.

The ‘threaded_call/2’ variant returns a threaded call identifier tag
that can be used with the *note threaded_exit/2: 231. and *note
threaded_cancel/1: 234. predicates.  Tags shall be regarded as opaque
terms; users shall not rely on their type.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<2>,  Next: Modes and number of proofs<33>,  Prev: Description<70>,  Up: threaded_call/1-2

2.4.7.9 Meta-predicate template
...............................

     threaded_call(0)
     threaded_call(0, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<33>,  Next: Errors<34>,  Prev: Meta-predicate template<2>,  Up: threaded_call/1-2

2.4.7.10 Modes and number of proofs
...................................

     threaded_call(@callable) - one
     threaded_call(@callable, --nonvar) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<34>,  Next: Examples<71>,  Prev: Modes and number of proofs<33>,  Up: threaded_call/1-2

2.4.7.11 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     ‘Tag’ is not a variable:
          ‘uninstantiation_error(Tag)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<71>,  Prev: Errors<34>,  Up: threaded_call/1-2

2.4.7.12 Examples
.................

     Prove ‘Goal’ asynchronously in a new thread:
          ‘threaded_call(Goal)’
     Prove ‘::Message’ asynchronously in a new thread:
          ‘threaded_call(::Message)’
     Prove ‘Object::Message’ asynchronously in a new thread:
          ‘threaded_call(Object::Message)’

See also
........

*note threaded_exit/1-2: 231, *note threaded_ignore/1: 237, *note
threaded_once/1-2: 232, *note threaded_peek/1-2: 233, *note
threaded_cancel/1: 234, *note threaded/1: 22b, *note synchronized/1: 74.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_once/1-2,  Next: threaded_ignore/1,  Prev: threaded_call/1-2,  Up: Multi-threading

2.4.7.13 ‘threaded_once/1-2’
............................

* Menu:

* Description: Description<71>.
* Meta-predicate template: Meta-predicate template<3>.
* Modes and number of proofs: Modes and number of proofs<34>.
* Errors: Errors<35>.
* Examples: Examples<72>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<71>,  Next: Meta-predicate template<3>,  Up: threaded_once/1-2

2.4.7.14 Description
....................

     threaded_once(Goal)
     threaded_once(Goal, Tag)

Proves ‘Goal’ asynchronously using a new thread.  Only the first goal
solution is found.  The argument can be a message-sending goal.  This
call always succeeds.  The result (success, failure, or exception) is
sent back to the message queue of the object containing the call (*note
this: 114.).

The ‘threaded_once/2’ variant returns a threaded call identifier tag
that can be used with the *note threaded_exit/2: 231. and *note
threaded_cancel/1: 234. predicates.  Tags shall be regarded as opaque
terms; users shall not rely on their type.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<3>,  Next: Modes and number of proofs<34>,  Prev: Description<71>,  Up: threaded_once/1-2

2.4.7.15 Meta-predicate template
................................

     threaded_once(0)
     threaded_once(0, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<34>,  Next: Errors<35>,  Prev: Meta-predicate template<3>,  Up: threaded_once/1-2

2.4.7.16 Modes and number of proofs
...................................

     threaded_once(@callable) - one
     threaded_once(@callable, --nonvar) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<35>,  Next: Examples<72>,  Prev: Modes and number of proofs<34>,  Up: threaded_once/1-2

2.4.7.17 Errors
...............

     Goal is a variable:
          ‘instantiation_error’
     Goal is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     Tag is not a variable:
          ‘uninstantiation_error(Tag)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<72>,  Prev: Errors<35>,  Up: threaded_once/1-2

2.4.7.18 Examples
.................

     Prove ‘Goal’ asynchronously in a new thread:
          ‘threaded_once(Goal)’
     Prove ‘::Message’ asynchronously in a new thread:
          ‘threaded_once(::Message)’
     Prove ‘Object::Message’ asynchronously in a new thread:
          ‘threaded_once(Object::Message)’

See also
........

*note threaded_call/1-2: 230, *note threaded_exit/1-2: 231, *note
threaded_ignore/1: 237, *note threaded_peek/1-2: 233, *note
threaded_cancel/1: 234, *note threaded/1: 22b, *note synchronized/1: 74.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_ignore/1,  Next: threaded_exit/1-2,  Prev: threaded_once/1-2,  Up: Multi-threading

2.4.7.19 ‘threaded_ignore/1’
............................

* Menu:

* Description: Description<72>.
* Meta-predicate template: Meta-predicate template<4>.
* Modes and number of proofs: Modes and number of proofs<35>.
* Errors: Errors<36>.
* Examples: Examples<73>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<72>,  Next: Meta-predicate template<4>,  Up: threaded_ignore/1

2.4.7.20 Description
....................

     threaded_ignore(Goal)

Proves ‘Goal’ asynchronously using a new thread.  Only the first goal
solution is found.  The argument can be a message-sending goal.  This
call always succeeds, independently of the result (success, failure, or
exception), which is simply discarded instead of being sent back to the
message queue of the object containing the call (*note this: 114.).

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<4>,  Next: Modes and number of proofs<35>,  Prev: Description<72>,  Up: threaded_ignore/1

2.4.7.21 Meta-predicate template
................................

     threaded_ignore(0)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<35>,  Next: Errors<36>,  Prev: Meta-predicate template<4>,  Up: threaded_ignore/1

2.4.7.22 Modes and number of proofs
...................................

     threaded_ignore(@callable) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<36>,  Next: Examples<73>,  Prev: Modes and number of proofs<35>,  Up: threaded_ignore/1

2.4.7.23 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<73>,  Prev: Errors<36>,  Up: threaded_ignore/1

2.4.7.24 Examples
.................

     Prove ‘Goal’ asynchronously in a new thread:
          ‘threaded_ignore(Goal)’
     Prove ‘::Message’ asynchronously in a new thread:
          ‘threaded_ignore(::Message)’
     Prove ‘Object::Message’ asynchronously in a new thread:
          ‘threaded_ignore(Object::Message)’

See also
........

*note threaded_call/1-2: 230, *note threaded_exit/1-2: 231, *note
threaded_once/1-2: 232, *note threaded_peek/1-2: 233, *note threaded/1:
22b, *note synchronized/1: 74.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_exit/1-2,  Next: threaded_peek/1-2,  Prev: threaded_ignore/1,  Up: Multi-threading

2.4.7.25 ‘threaded_exit/1-2’
............................

* Menu:

* Description: Description<73>.
* Modes and number of proofs: Modes and number of proofs<36>.
* Errors: Errors<37>.
* Examples: Examples<74>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<73>,  Next: Modes and number of proofs<36>,  Up: threaded_exit/1-2

2.4.7.26 Description
....................

     threaded_exit(Goal)
     threaded_exit(Goal, Tag)

Retrieves the result of proving ‘Goal’ in a new thread.  This predicate
blocks execution until the reply is sent to the *note this: 114. message
queue by the thread executing the goal.  When there is no thread proving
the goal, the predicate generates an exception.  This predicate is
non-deterministic, providing access to any alternative solutions of its
argument.

The argument of this predicate should be a 'variant' of the argument of
the corresponding *note threaded_call/1: 230. or *note threaded_once/1:
232. call.  When the predicate argument is subsumed by the
‘threaded_call/1’ or ‘threaded_once/1’ call argument, the
‘threaded_exit/1’ call will succeed iff its argument is a solution of
the (more general) goal.

The ‘threaded_exit/2’ variant accepts a threaded call identifier tag
generated by the calls to the *note threaded_call/2: 230. and *note
threaded_once/2: 232. predicates.  Tags shall be regarded as an opaque
term; users shall not rely on their type.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<36>,  Next: Errors<37>,  Prev: Description<73>,  Up: threaded_exit/1-2

2.4.7.27 Modes and number of proofs
...................................

     threaded_exit(+callable) - zero_or_more
     threaded_exit(+callable, +nonvar) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<37>,  Next: Examples<74>,  Prev: Modes and number of proofs<36>,  Up: threaded_exit/1-2

2.4.7.28 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     No thread is running for proving ‘Goal’ in the ‘Object’ calling context:
          ‘existence_error(thread, Object)’
     ‘Tag’ is a variable:
          ‘instantiation_error’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<74>,  Prev: Errors<37>,  Up: threaded_exit/1-2

2.4.7.29 Examples
.................

     To retrieve an asynchronous goal proof result:
          ‘threaded_exit(Goal)’
     To retrieve an asynchronous message to 'self' result:
          ‘threaded_exit(::Goal)’
     To retrieve an asynchronous message result:
          ‘threaded_exit(Object::Goal)’

See also
........

*note threaded_call/1-2: 230, *note threaded_ignore/1: 237, *note
threaded_once/1-2: 232, *note threaded_peek/1-2: 233, *note
threaded_cancel/1: 234, *note threaded/1: 22b.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_peek/1-2,  Next: threaded_cancel/1,  Prev: threaded_exit/1-2,  Up: Multi-threading

2.4.7.30 ‘threaded_peek/1-2’
............................

* Menu:

* Description: Description<74>.
* Modes and number of proofs: Modes and number of proofs<37>.
* Errors: Errors<38>.
* Examples: Examples<75>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<74>,  Next: Modes and number of proofs<37>,  Up: threaded_peek/1-2

2.4.7.31 Description
....................

     threaded_peek(Goal)
     threaded_peek(Goal, Tag)

Checks if the result of proving ‘Goal’ in a new thread is already
available.  This call succeeds or fails without blocking execution
waiting for a reply to be available.  When there is no thread proving
the goal, the predicate generates an exception.

The argument of this predicate should be a 'variant' of the argument of
the corresponding *note threaded_call/1: 230. or *note threaded_once/1:
232. call.  When the predicate argument is subsumed by the
‘threaded_call/1’ or ‘threaded_once/1’ call argument, the
‘threaded_peek/1’ call will succeed iff its argument unifies with an
already available solution of the (more general) goal.

The ‘threaded_peek/2’ variant accepts a threaded call identifier tag
generated by the calls to the *note threaded_call/2: 230. and *note
threaded_once/2: 232. predicates.  Tags shall be regarded as an opaque
term; users shall not rely on their type.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<37>,  Next: Errors<38>,  Prev: Description<74>,  Up: threaded_peek/1-2

2.4.7.32 Modes and number of proofs
...................................

     threaded_peek(+callable) - zero_or_one
     threaded_peek(+callable, +nonvar) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<38>,  Next: Examples<75>,  Prev: Modes and number of proofs<37>,  Up: threaded_peek/1-2

2.4.7.33 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     No thread is running for proving ‘Goal’ in the ‘Object’ calling context:
          ‘existence_error(thread, Object)’
     ‘Tag’ is a variable:
          ‘instantiation_error’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<75>,  Prev: Errors<38>,  Up: threaded_peek/1-2

2.4.7.34 Examples
.................

     To check for an asynchronous goal proof result:
          ‘threaded_peek(Goal)’
     To check for an asynchronous message to 'self' result:
          ‘threaded_peek(::Goal)’
     To check for an asynchronous message result:
          ‘threaded_peek(Object::Goal)’

See also
........

*note threaded_call/1-2: 230, *note threaded_exit/1-2: 231, *note
threaded_ignore/1: 237, *note threaded_once/1-2: 232, *note
threaded_cancel/1: 234, *note threaded/1: 22b.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_cancel/1,  Next: threaded_wait/1,  Prev: threaded_peek/1-2,  Up: Multi-threading

2.4.7.35 ‘threaded_cancel/1’
............................

* Menu:

* Description: Description<75>.
* Modes and number of proofs: Modes and number of proofs<38>.
* Errors: Errors<39>.
* Examples: Examples<76>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<75>,  Next: Modes and number of proofs<38>,  Up: threaded_cancel/1

2.4.7.36 Description
....................

     threaded_cancel(Tag)

Cancels a tagged threaded call.  When there is no asynchronous call with
the given tag, calling this predicate succeeds assuming the asynchronous
call has already terminated or canceled.  The threaded call identifier
tag is generated by calls to the *note threaded_call/2: 230. and *note
threaded_once/2: 232. predicates.  Tags shall be regarded as an opaque
term; users shall not rely on their type.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<38>,  Next: Errors<39>,  Prev: Description<75>,  Up: threaded_cancel/1

2.4.7.37 Modes and number of proofs
...................................

     threaded_cancel(+nonvar) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<39>,  Next: Examples<76>,  Prev: Modes and number of proofs<38>,  Up: threaded_cancel/1

2.4.7.38 Errors
...............

     ‘Tag’ is a variable:
          ‘instantiation_error’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<76>,  Prev: Errors<39>,  Up: threaded_cancel/1

2.4.7.39 Examples
.................

(none)

See also
........

*note threaded_call/1-2: 230, *note threaded_exit/1-2: 231, *note
threaded_ignore/1: 237, *note threaded_once/1-2: 232, *note threaded/1:
22b.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_wait/1,  Next: threaded_notify/1,  Prev: threaded_cancel/1,  Up: Multi-threading

2.4.7.40 ‘threaded_wait/1’
..........................

* Menu:

* Description: Description<76>.
* Modes and number of proofs: Modes and number of proofs<39>.
* Errors: Errors<40>.
* Examples: Examples<77>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<76>,  Next: Modes and number of proofs<39>,  Up: threaded_wait/1

2.4.7.41 Description
....................

     threaded_wait(Term)
     threaded_wait([Term| Terms])

Suspends the thread making the call until a notification is received
that unifies with ‘Term’.  The call must be made within the same object
(*note this: 114.) containing the calls to the *note threaded_notify/1:
23c. predicate that will eventually send the notification.  The argument
may also be a list of notifications, ‘[Term| Terms]’.  In this case, the
thread making the call will suspend until all notifications in the list
are received.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<39>,  Next: Errors<40>,  Prev: Description<76>,  Up: threaded_wait/1

2.4.7.42 Modes and number of proofs
...................................

     threaded_wait(?term) - one
     threaded_wait(+list(term)) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<40>,  Next: Examples<77>,  Prev: Modes and number of proofs<39>,  Up: threaded_wait/1

2.4.7.43 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<77>,  Prev: Errors<40>,  Up: threaded_wait/1

2.4.7.44 Examples
.................

     % wait until the "data_available" notification is received:
     ..., threaded_wait(data_available), ...

See also
........

*note threaded_notify/1: 23c.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_notify/1,  Prev: threaded_wait/1,  Up: Multi-threading

2.4.7.45 ‘threaded_notify/1’
............................

* Menu:

* Description: Description<77>.
* Modes and number of proofs: Modes and number of proofs<40>.
* Errors: Errors<41>.
* Examples: Examples<78>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<77>,  Next: Modes and number of proofs<40>,  Up: threaded_notify/1

2.4.7.46 Description
....................

     threaded_notify(Term)
     threaded_notify([Term| Terms])

Sends ‘Term’ as a notification to any thread suspended waiting for it in
order to proceed.  The call must be made within the same object (*note
this: 114.) containing the calls to the *note threaded_wait/1: 23b.
predicate waiting for the notification.  The argument may also be a list
of notifications, ‘[Term| Terms]’.  In this case, all notifications in
the list will be sent to any threads suspended waiting for them in order
to proceed.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note threads: 225. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<40>,  Next: Errors<41>,  Prev: Description<77>,  Up: threaded_notify/1

2.4.7.47 Modes and number of proofs
...................................

     threaded_notify(@term) - one
     threaded_notify(@list(term)) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<41>,  Next: Examples<78>,  Prev: Modes and number of proofs<40>,  Up: threaded_notify/1

2.4.7.48 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<78>,  Prev: Errors<41>,  Up: threaded_notify/1

2.4.7.49 Examples
.................

     % send a "data_available" notification:
     ..., threaded_notify(data_available), ...

See also
........

*note threaded_wait/1: 23b.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-threading engines,  Next: Compiling and loading source files,  Prev: Multi-threading,  Up: Built-in predicates

2.4.8 Multi-threading engines
-----------------------------

'built-in predicate'

* Menu:

* threaded_engine_create/3::
* threaded_engine_destroy/1::
* threaded_engine/1::
* threaded_engine_self/1::
* threaded_engine_next/2::
* threaded_engine_next_reified/2::
* threaded_engine_yield/1::
* threaded_engine_post/2::
* threaded_engine_fetch/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine_create/3,  Next: threaded_engine_destroy/1,  Up: Multi-threading engines

2.4.8.1 ‘threaded_engine_create/3’
..................................

* Menu:

* Description: Description<78>.
* Meta-predicate template: Meta-predicate template<5>.
* Modes and number of proofs: Modes and number of proofs<41>.
* Errors: Errors<42>.
* Examples: Examples<79>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<78>,  Next: Meta-predicate template<5>,  Up: threaded_engine_create/3

2.4.8.2 Description
...................

     threaded_engine_create(AnswerTemplate, Goal, Engine)

Creates a new engine for proving the given goal and defines an answer
template for retrieving the goal solution bindings.  A message queue for
passing arbitrary terms to the engine is also created.  If the name for
the engine is not given, a unique name is generated and returned.
Engine names shall be regarded as opaque terms; users shall not rely on
its type.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<5>,  Next: Modes and number of proofs<41>,  Prev: Description<78>,  Up: threaded_engine_create/3

2.4.8.3 Meta-predicate template
...............................

     threaded_engine_create(*, 0, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<41>,  Next: Errors<42>,  Prev: Meta-predicate template<5>,  Up: threaded_engine_create/3

2.4.8.4 Modes and number of proofs
..................................

     threaded_engine_create(@term, @callable, @nonvar) - one
     threaded_engine_create(@term, @callable, --nonvar) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<42>,  Next: Examples<79>,  Prev: Modes and number of proofs<41>,  Up: threaded_engine_create/3

2.4.8.5 Errors
..............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     ‘Engine’ is the name of an existing engine:
          ‘permission_error(create, engine, Engine)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<79>,  Prev: Errors<42>,  Up: threaded_engine_create/3

2.4.8.6 Examples
................

     % create a new engine to enumerate list elements:
     | ?- threaded_engine_create(X, member(X, [1,2,3]), worker_1).

See also
........

*note threaded_engine_destroy/1: 242, *note threaded_engine_self/1: 5e5,
*note threaded_engine/1: 5e6, *note threaded_engine_next/2: 240, *note
threaded_engine_next_reified/2: 241.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine_destroy/1,  Next: threaded_engine/1,  Prev: threaded_engine_create/3,  Up: Multi-threading engines

2.4.8.7 ‘threaded_engine_destroy/1’
...................................

* Menu:

* Description: Description<79>.
* Modes and number of proofs: Modes and number of proofs<42>.
* Errors: Errors<43>.
* Examples: Examples<80>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<79>,  Next: Modes and number of proofs<42>,  Up: threaded_engine_destroy/1

2.4.8.8 Description
...................

     threaded_engine_destroy(Engine)

Stops and destroys an engine.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<42>,  Next: Errors<43>,  Prev: Description<79>,  Up: threaded_engine_destroy/1

2.4.8.9 Modes and number of proofs
..................................

     threaded_engine_destroy(@nonvar) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<43>,  Next: Examples<80>,  Prev: Modes and number of proofs<42>,  Up: threaded_engine_destroy/1

2.4.8.10 Errors
...............

     ‘Engine’ is a variable:
          ‘instantiation_error’
     ‘Engine’ is neither a variable nor the name of an existing engine:
          ‘existence_error(engine, Engine)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<80>,  Prev: Errors<43>,  Up: threaded_engine_destroy/1

2.4.8.11 Examples
.................

     % stop the worker_1 engine:
     | ?- threaded_engine_destroy(worker_1).

     % stop all engines:
     | ?- forall(
              threaded_engine(Engine),
              threaded_engine_destroy(Engine)
          ).

See also
........

*note threaded_engine_create/3: 23f, *note threaded_engine_self/1: 5e5,
*note threaded_engine/1: 5e6.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine/1,  Next: threaded_engine_self/1,  Prev: threaded_engine_destroy/1,  Up: Multi-threading engines

2.4.8.12 ‘threaded_engine/1’
............................

* Menu:

* Description: Description<80>.
* Modes and number of proofs: Modes and number of proofs<43>.
* Errors: Errors<44>.
* Examples: Examples<81>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<80>,  Next: Modes and number of proofs<43>,  Up: threaded_engine/1

2.4.8.13 Description
....................

     threaded_engine(Engine)

Enumerates, by backtracking, all existing engines.  Engine names shall
be regarded as opaque terms; users shall not rely on their type.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<43>,  Next: Errors<44>,  Prev: Description<80>,  Up: threaded_engine/1

2.4.8.14 Modes and number of proofs
...................................

     threaded_engine(?nonvar) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<44>,  Next: Examples<81>,  Prev: Modes and number of proofs<43>,  Up: threaded_engine/1

2.4.8.15 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<81>,  Prev: Errors<44>,  Up: threaded_engine/1

2.4.8.16 Examples
.................

     % check that the worker_1 engine exists:
     | ?- threaded_engine(worker_1).

     % write the names of all existing engines:
     | ?- forall(
              threaded_engine(Engine),
              (writeq(Engine), nl)
          ).

See also
........

*note threaded_engine_create/3: 23f, *note threaded_engine_self/1: 5e5,
*note threaded_engine_destroy/1: 242.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine_self/1,  Next: threaded_engine_next/2,  Prev: threaded_engine/1,  Up: Multi-threading engines

2.4.8.17 ‘threaded_engine_self/1’
.................................

* Menu:

* Description: Description<81>.
* Modes and number of proofs: Modes and number of proofs<44>.
* Errors: Errors<45>.
* Examples: Examples<82>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<81>,  Next: Modes and number of proofs<44>,  Up: threaded_engine_self/1

2.4.8.18 Description
....................

     threaded_engine_self(Engine)

Queries the name of engine calling the predicate.  Fails if not called
from within an engine or if the argument doesn’t unify with the engine
name.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<44>,  Next: Errors<45>,  Prev: Description<81>,  Up: threaded_engine_self/1

2.4.8.19 Modes and number of proofs
...................................

     threaded_engine_self(?nonvar) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<45>,  Next: Examples<82>,  Prev: Modes and number of proofs<44>,  Up: threaded_engine_self/1

2.4.8.20 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<82>,  Prev: Errors<45>,  Up: threaded_engine_self/1

2.4.8.21 Examples
.................

     % find the name of the engine making the query:
     ..., threaded_engine_self(Engine), ...

     % check if the the engine making the query is worker_1:
     ..., threaded_engine_self(worker_1), ...

See also
........

*note threaded_engine_create/3: 23f, *note threaded_engine_destroy/1:
242, *note threaded_engine/1: 5e6.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine_next/2,  Next: threaded_engine_next_reified/2,  Prev: threaded_engine_self/1,  Up: Multi-threading engines

2.4.8.22 ‘threaded_engine_next/2’
.................................

* Menu:

* Description: Description<82>.
* Modes and number of proofs: Modes and number of proofs<45>.
* Errors: Errors<46>.
* Examples: Examples<83>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<82>,  Next: Modes and number of proofs<45>,  Up: threaded_engine_next/2

2.4.8.23 Description
....................

     threaded_engine_next(Engine, Answer)

Retrieves an answer from an engine and signals it to start computing the
next answer.  This predicate blocks until an answer becomes available.
The predicate fails when there are no more solutions to the engine goal.
If the engine goal throws an exception, calling this predicate will
re-throw the exception and subsequent calls will fail.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<45>,  Next: Errors<46>,  Prev: Description<82>,  Up: threaded_engine_next/2

2.4.8.24 Modes and number of proofs
...................................

     threaded_engine_next(@nonvar, ?term) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<46>,  Next: Examples<83>,  Prev: Modes and number of proofs<45>,  Up: threaded_engine_next/2

2.4.8.25 Errors
...............

     ‘Engine’ is a variable:
          ‘instantiation_error’
     ‘Engine’ is neither a variable nor the name of an existing engine:
          ‘existence_error(engine, Engine)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<83>,  Prev: Errors<46>,  Up: threaded_engine_next/2

2.4.8.26 Examples
.................

     % get the next answer from the worker_1 engine:
     | ?- threaded_engine_next(worker_1, Answer).

See also
........

*note threaded_engine_create/3: 23f, *note
threaded_engine_next_reified/2: 241, *note threaded_engine_yield/1: 245.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine_next_reified/2,  Next: threaded_engine_yield/1,  Prev: threaded_engine_next/2,  Up: Multi-threading engines

2.4.8.27 ‘threaded_engine_next_reified/2’
.........................................

* Menu:

* Description: Description<83>.
* Modes and number of proofs: Modes and number of proofs<46>.
* Errors: Errors<47>.
* Examples: Examples<84>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<83>,  Next: Modes and number of proofs<46>,  Up: threaded_engine_next_reified/2

2.4.8.28 Description
....................

     threaded_engine_next_reified(Engine, Answer)

Retrieves an answer from an engine and signals it to start computing the
next answer.  This predicate always succeeds and blocks until an answer
becomes available.  Answers are returned using the terms ‘the(Answer)’,
‘no’, and ‘exception(Error)’.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<46>,  Next: Errors<47>,  Prev: Description<83>,  Up: threaded_engine_next_reified/2

2.4.8.29 Modes and number of proofs
...................................

     threaded_engine_next_reified(@nonvar, ?nonvar) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<47>,  Next: Examples<84>,  Prev: Modes and number of proofs<46>,  Up: threaded_engine_next_reified/2

2.4.8.30 Errors
...............

     ‘Engine’ is a variable:
          ‘instantiation_error’
     ‘Engine’ is neither a variable nor the name of an existing engine:
          ‘existence_error(engine, Engine)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<84>,  Prev: Errors<47>,  Up: threaded_engine_next_reified/2

2.4.8.31 Examples
.................

     % get the next reified answer from the worker_1 engine:
     | ?- threaded_engine_next_reified(worker_1, Answer).

See also
........

*note threaded_engine_create/3: 23f, *note threaded_engine_next/2: 240,
*note threaded_engine_yield/1: 245.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine_yield/1,  Next: threaded_engine_post/2,  Prev: threaded_engine_next_reified/2,  Up: Multi-threading engines

2.4.8.32 ‘threaded_engine_yield/1’
..................................

* Menu:

* Description: Description<84>.
* Modes and number of proofs: Modes and number of proofs<47>.
* Errors: Errors<48>.
* Examples: Examples<85>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<84>,  Next: Modes and number of proofs<47>,  Up: threaded_engine_yield/1

2.4.8.33 Description
....................

     threaded_engine_yield(Answer)

Returns an answer independent of the solutions of the engine goal.
Fails if not called from within an engine.  This predicate is usually
used when the engine goal is a call to a recursive predicate processing
terms from the engine term queue.

This predicate blocks until the returned answer is consumed.

Note that this predicate should not be called as the last element of a
conjunction resulting in an engine goal solution as, in this case, an
answer will always be returned.  For example, instead of
‘(threaded_engine_yield(ready); member(X,[1,2,3]))’ use ‘(X=ready;
member(X,[1,2,3]))’.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<47>,  Next: Errors<48>,  Prev: Description<84>,  Up: threaded_engine_yield/1

2.4.8.34 Modes and number of proofs
...................................

     threaded_engine_yield(@term) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<48>,  Next: Examples<85>,  Prev: Modes and number of proofs<47>,  Up: threaded_engine_yield/1

2.4.8.35 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<85>,  Prev: Errors<48>,  Up: threaded_engine_yield/1

2.4.8.36 Examples
.................

     % returns the atom "ready" as an engine answer:
     ..., threaded_engine_yield(ready), ...

See also
........

*note threaded_engine_create/3: 23f, *note threaded_engine_next/2: 240,
*note threaded_engine_next_reified/2: 241.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine_post/2,  Next: threaded_engine_fetch/1,  Prev: threaded_engine_yield/1,  Up: Multi-threading engines

2.4.8.37 ‘threaded_engine_post/2’
.................................

* Menu:

* Description: Description<85>.
* Modes and number of proofs: Modes and number of proofs<48>.
* Errors: Errors<49>.
* Examples: Examples<86>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<85>,  Next: Modes and number of proofs<48>,  Up: threaded_engine_post/2

2.4.8.38 Description
....................

     threaded_engine_post(Engine, Term)

Posts a term to the engine term queue.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<48>,  Next: Errors<49>,  Prev: Description<85>,  Up: threaded_engine_post/2

2.4.8.39 Modes and number of proofs
...................................

     threaded_engine_post(@nonvar, @term) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<49>,  Next: Examples<86>,  Prev: Modes and number of proofs<48>,  Up: threaded_engine_post/2

2.4.8.40 Errors
...............

     ‘Engine’ is a variable:
          ‘instantiation_error’
     ‘Engine’ is neither a variable nor the name of an existing engine:
          ‘existence_error(engine, Engine)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<86>,  Prev: Errors<49>,  Up: threaded_engine_post/2

2.4.8.41 Examples
.................

     % post the atom "ready" to the worker_1 engine queue:
     | ?- threaded_engine_post(worker_1, ready).

See also
........

*note threaded_engine_fetch/1: 243.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: threaded_engine_fetch/1,  Prev: threaded_engine_post/2,  Up: Multi-threading engines

2.4.8.42 ‘threaded_engine_fetch/1’
..................................

* Menu:

* Description: Description<86>.
* Modes and number of proofs: Modes and number of proofs<49>.
* Errors: Errors<50>.
* Examples: Examples<87>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<86>,  Next: Modes and number of proofs<49>,  Up: threaded_engine_fetch/1

2.4.8.43 Description
....................

     threaded_engine_fetch(Term)

Fetches a term from the engine term queue.  Blocks until a term is
available.  Fails if not called from within an engine.

     Note: This predicate requires a *note backend Prolog compiler: 34.
     providing compatible multi-threading primitives.  The value of the
     read-only *note engines: 2b9. flag is set to ‘supported’ when that
     is the case.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<49>,  Next: Errors<50>,  Prev: Description<86>,  Up: threaded_engine_fetch/1

2.4.8.44 Modes and number of proofs
...................................

     threaded_engine_fetch(?term) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<50>,  Next: Examples<87>,  Prev: Modes and number of proofs<49>,  Up: threaded_engine_fetch/1

2.4.8.45 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<87>,  Prev: Errors<50>,  Up: threaded_engine_fetch/1

2.4.8.46 Examples
.................

     % fetch a term from the engine term queue:
     ..., threaded_engine_fetch(Term), ...

See also
........

*note threaded_engine_post/2: 244.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiling and loading source files,  Next: Flags,  Prev: Multi-threading engines,  Up: Built-in predicates

2.4.9 Compiling and loading source files
----------------------------------------

'built-in predicate'

* Menu:

* logtalk_compile/1::
* logtalk_compile/2::
* logtalk_load/1::
* logtalk_load/2::
* logtalk_make/0::
* logtalk_make/1::
* logtalk_make_target_action/1::
* logtalk_library_path/2::
* logtalk_load_context/2::


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_compile/1,  Next: logtalk_compile/2,  Up: Compiling and loading source files

2.4.9.1 ‘logtalk_compile/1’
...........................

* Menu:

* Description: Description<87>.
* Modes and number of proofs: Modes and number of proofs<50>.
* Errors: Errors<51>.
* Examples: Examples<88>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<87>,  Next: Modes and number of proofs<50>,  Up: logtalk_compile/1

2.4.9.2 Description
...................

     logtalk_compile(File)
     logtalk_compile(Files)

Compiles to disk a *note source file: 61c. or a list of source files
using the default compiler flag values.  The Logtalk source file name
extension (by default, ‘.lgt’) can be omitted.  Source file paths can be
absolute, relative to the current directory, or use *note library
notation: 2a8.  This predicate can also be used to compile Prolog source
files as Logtalk source code.  When no recognized Logtalk or Prolog
extension is specified, the compiler tries first to append a Logtalk
source file extension and then a Prolog source file extension.  If that
fails, the compiler tries to use the file name as-is.  The recognized
Logtalk and Prolog file extensions are defined in the *note backend
adapter files: 154.

     Note: This predicate does not load into memory the compiled source
     file.  If you want to both compile and load a source file, use
     instead the *note logtalk_load/1: 46. built-in predicate.

When this predicate is called from the top-level interpreter, relative
source file paths are resolved using the current working directory.
When the calls are made from a source file, relative source file paths
are resolved using the source file directory.

Note that only the errors related to problems in the predicate argument
are listed below.  This predicate fails on the first error found during
compilation of a source file.  In this case, no file with the compiled
code is written to disk.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<50>,  Next: Errors<51>,  Prev: Description<87>,  Up: logtalk_compile/1

2.4.9.3 Modes and number of proofs
..................................

     logtalk_compile(@source_file_name) - zero_or_one
     logtalk_compile(@list(source_file_name)) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<51>,  Next: Examples<88>,  Prev: Modes and number of proofs<50>,  Up: logtalk_compile/1

2.4.9.4 Errors
..............

     ‘File’ is a variable:
          ‘instantiation_error’
     ‘Files’ is a variable or a list with an element which is a variable:
          ‘instantiation_error’
     ‘File’, or an element ‘File’ of the ‘Files’ list, is neither a variable nor a source file name:
          ‘type_error(source_file_name, File)’
     ‘File’, or an element ‘File’ of the ‘Files’ list, uses library notation but the library does not exist:
          ‘existence_error(library, Library)’
     ‘File’ or an element ‘File’ of the ‘Files’ list does not exist:
          ‘existence_error(file, File)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<88>,  Prev: Errors<51>,  Up: logtalk_compile/1

2.4.9.5 Examples
................

     % compile to disk the "set" source file in the
     % current directory:
     | ?- logtalk_compile(set).

     % compile to disk the "tree" source file in the
     % "types" library directory:
     | ?- logtalk_load(types(tree)).

     % compile to disk the "listp" and "list" source
     % files in the current directory:
     | ?- logtalk_compile([listp, list]).

See also
........

*note logtalk_compile/2: 2b2, *note logtalk_load/1: 46, *note
logtalk_load/2: 4e, *note logtalk_make/0: 29f, *note logtalk_make/1:
2a0, *note logtalk_library_path/2: 2a7.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_compile/2,  Next: logtalk_load/1,  Prev: logtalk_compile/1,  Up: Compiling and loading source files

2.4.9.6 ‘logtalk_compile/2’
...........................

* Menu:

* Description: Description<88>.
* Modes and number of proofs: Modes and number of proofs<51>.
* Errors: Errors<52>.
* Examples: Examples<89>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<88>,  Next: Modes and number of proofs<51>,  Up: logtalk_compile/2

2.4.9.7 Description
...................

     logtalk_compile(File, Flags)
     logtalk_compile(Files, Flags)

Compiles to disk a *note source file: 61c. or a list of source files
using a list of compiler flags.  The Logtalk source file name extension
(by default, ‘.lgt’) can be omitted.  Source file paths can be absolute,
relative to the current directory, or use *note library notation: 2a8.
This predicate can also be used to compile Prolog source files as
Logtalk source code.  When no recognized Logtalk or Prolog extension is
specified, the compiler tries first to append a Logtalk source file
extension and then a Prolog source file extension.  If that fails, the
compiler tries to use the file name as-is.  Compiler flags are
represented as 'flag(value)'.  For a description of the available
compiler flags, please see the *note Compiler flags: 251. section in the
User Manual.  The recognized Logtalk and Prolog file extensions are
defined in the *note backend adapter files: 154.

     Note: This predicate does not load into memory the compiled source
     file.  If you want to both compile and load a source file, use
     instead the *note logtalk_load/2: 4e. built-in predicate.

When this predicate is called from the top-level interpreter, relative
source file paths are resolved using the current working directory.
When the calls are made from a source file, relative source file paths
are resolved by default using the source file directory (unless a *note
relative_to: 2e4. flag is passed).

Note that only the errors related to problems in the predicate argument
are listed below.  This predicate fails on the first error found during
compilation of a source file.  In this case, no file with the compiled
code is written to disk.

     Warning: The compiler flags specified in the second argument only
     apply to the files listed in the first argument.  Notably, if you
     are compiling a *note loader file: 4f, the flags only apply to the
     loader file itself.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<51>,  Next: Errors<52>,  Prev: Description<88>,  Up: logtalk_compile/2

2.4.9.8 Modes and number of proofs
..................................

     logtalk_compile(@source_file_name, @list(compiler_flag)) - zero_or_one
     logtalk_compile(@list(source_file_name), @list(compiler_flag)) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<52>,  Next: Examples<89>,  Prev: Modes and number of proofs<51>,  Up: logtalk_compile/2

2.4.9.9 Errors
..............

     ‘File’ is a variable:
          ‘instantiation_error’
     ‘Files’ is a variable or a list with an element which is a variable:
          ‘instantiation_error’
     ‘File’, or an element ‘File’ of the ‘Files’ list, is neither a variable nor a source file name:
          ‘type_error(source_file_name, File)’
     ‘File’, or an element ‘File’ of the ‘Files’ list, uses library notation but the library does not exist:
          ‘existence_error(library, Library)’
     ‘File’ or an element ‘File’ of the ‘Files’ list, does not exist:
          ‘existence_error(file, File)’
          
     ‘Flags’ is a variable or a list with an element which is a variable:
          ‘instantiation_error’
     ‘Flags’ is neither a variable nor a proper list:
          ‘type_error(list, Flags)’
     An element ‘Flag’ of the ‘Flags’ list is not a valid compiler flag:
          ‘type_error(compiler_flag, Flag)’
     An element ‘Flag’ of the ‘Flags’ list defines a value for a read-only compiler flag:
          ‘permission_error(modify, flag, Flag)’
     An element ‘Flag’ of the ‘Flags’ list defines an invalid value for a flag:
          ‘domain_error(flag_value, Flag+Value)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<89>,  Prev: Errors<52>,  Up: logtalk_compile/2

2.4.9.10 Examples
.................

     % compile to disk the "list" source file in the
     % current directory using default compiler flags:
     | ?- logtalk_compile(list, []).

     % compile to disk the "tree" source file in the "types"
     % library directory with the source_data flag turned on:
     | ?- logtalk_compile(types(tree), [source_data(on)]).

     % compile to disk the "file_system" source file in the
     % current directory with portability warnings suppressed:
     | ?- logtalk_compile(file_system, [portability(silent)]).

See also
........

*note logtalk_compile/1: 29e, *note logtalk_load/1: 46, *note
logtalk_load/2: 4e, *note logtalk_make/0: 29f, *note logtalk_make/1:
2a0, *note logtalk_library_path/2: 2a7.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_load/1,  Next: logtalk_load/2,  Prev: logtalk_compile/2,  Up: Compiling and loading source files

2.4.9.11 ‘logtalk_load/1’
.........................

* Menu:

* Description: Description<89>.
* Modes and number of proofs: Modes and number of proofs<52>.
* Errors: Errors<53>.
* Examples: Examples<90>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<89>,  Next: Modes and number of proofs<52>,  Up: logtalk_load/1

2.4.9.12 Description
....................

     logtalk_load(File)
     logtalk_load(Files)

Compiles to disk and then loads to memory a *note source file: 61c. or a
list of source files using the default compiler flag values.  The
Logtalk source file name extension (by default, ‘.lgt’) can be omitted.
Source file paths can be absolute, relative to the current directory, or
use *note library notation: 2a8.  This predicate can also be used to
compile Prolog source files as Logtalk source code.  When no recognized
Logtalk or Prolog extension is specified, the compiler tries first to
append a Logtalk source file extension and then a Prolog source file
extension.  If that fails, the compiler tries to use the file name
as-is.  The recognized Logtalk and Prolog file extensions are defined in
the *note backend adapter files: 154.

When this predicate is called from the top-level interpreter, relative
source file paths are resolved using the current working directory.
When the calls are made from a source file, relative source file paths
are resolved using the source file directory.

Note that only the errors related to problems in the predicate argument
are listed below.  This predicate fails on the first error found during
compilation of a source file.  In this case, the source file contents is
not loaded.

Depending on the *note backend Prolog compiler: 34, the shortcuts
‘{File}’ or ‘{File1, File2, ...}’ may be used as an alternative.  Check
the adapter files for the availability of these shortcuts as they are
not part of the language (and thus should only be used at the top-level
interpreter).


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<52>,  Next: Errors<53>,  Prev: Description<89>,  Up: logtalk_load/1

2.4.9.13 Modes and number of proofs
...................................

     logtalk_load(@source_file_name) - zero_or_one
     logtalk_load(@list(source_file_name)) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<53>,  Next: Examples<90>,  Prev: Modes and number of proofs<52>,  Up: logtalk_load/1

2.4.9.14 Errors
...............

     ‘File’ is a variable:
          ‘instantiation_error’
     ‘Files’ is a variable or a list with an element which is a variable:
          ‘instantiation_error’
     ‘File’, or an element ‘File’ of the ‘Files’ list, is neither a variable nor a source file name:
          ‘type_error(source_file_name, File)’
     ‘File’, or an element ‘File’ of the ‘Files’ list, uses library notation but the library does not exist:
          ‘existence_error(library, Library)’
     ‘File’ or an element ‘File’ of the ‘Files’ list, does not exist:
          ‘existence_error(file, File)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<90>,  Prev: Errors<53>,  Up: logtalk_load/1

2.4.9.15 Examples
.................

     % compile and load the "set" source file in the
     % current directory:
     | ?- logtalk_load(set).

     % compile and load the "tree" source file in the
     % "types" library directory:
     | ?- logtalk_load(types(tree)).

     % compile and load the "listp" and "list" source
     % files in the current directory:
     | ?- logtalk_load([listp, list]).

See also
........

*note logtalk_compile/1: 29e, *note logtalk_compile/2: 2b2, *note
logtalk_load/2: 4e, *note logtalk_make/0: 29f, *note logtalk_make/1:
2a0, *note logtalk_library_path/2: 2a7.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_load/2,  Next: logtalk_make/0,  Prev: logtalk_load/1,  Up: Compiling and loading source files

2.4.9.16 ‘logtalk_load/2’
.........................

* Menu:

* Description: Description<90>.
* Modes and number of proofs: Modes and number of proofs<53>.
* Errors: Errors<54>.
* Examples: Examples<91>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<90>,  Next: Modes and number of proofs<53>,  Up: logtalk_load/2

2.4.9.17 Description
....................

     logtalk_load(File, Flags)
     logtalk_load(Files, Flags)

Compiles to disk and then loads to memory a *note source file: 61c. or a
list of source files using a list of compiler flags.  The Logtalk source
file name extension (by default, ‘.lgt’) can be omitted.  Source file
paths can be absolute, relative to the current directory, or use *note
library notation: 2a8.  Compiler flags are represented as 'flag(value)'.
This predicate can also be used to compile Prolog source files as
Logtalk source code.  When no recognized Logtalk or Prolog extension is
specified, the compiler tries first to append a Logtalk source file
extension and then a Prolog source file extension.  If that fails, the
compiler tries to use the file name as-is.  For a description of the
available compiler flags, please see the *note Compiler flags: 251.
section in the User Manual.  The recognized Logtalk and Prolog file
extensions are defined in the *note backend adapter files: 154.  The
recognized Logtalk and Prolog file extensions are defined in the *note
backend adapter files: 154.

When this predicate is called from the top-level interpreter, relative
source file paths are resolved using the current working directory.
When the calls are made from a source file, relative source file paths
are resolved by default using the source file directory (unless a *note
relative_to: 2e4. flag is passed).

Note that only the errors related to problems in the predicate argument
are listed below.  This predicate fails on the first error found during
compilation of a source file.  In this case, the source file contents is
not loaded.

     Warning: The compiler flags specified in the second argument only
     apply to the files listed in the first argument and not to any
     files that those files may load or compile.  Notably, if you are
     loading a *note loader file: 4f, the flags only apply to the loader
     file itself and not to the files loaded by it.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<53>,  Next: Errors<54>,  Prev: Description<90>,  Up: logtalk_load/2

2.4.9.18 Modes and number of proofs
...................................

     logtalk_load(@source_file_name, @list(compiler_flag)) - zero_or_one
     logtalk_load(@list(source_file_name), @list(compiler_flag)) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<54>,  Next: Examples<91>,  Prev: Modes and number of proofs<53>,  Up: logtalk_load/2

2.4.9.19 Errors
...............

     ‘File’ is a variable:
          ‘instantiation_error’
     ‘Files’ is a variable or a list with an element which is a variable:
          ‘instantiation_error’
     ‘File’, or an element ‘File’ of the ‘Files’ list, is neither a variable nor a source file name:
          ‘type_error(source_file_name, File)’
     ‘File’, or an element ‘File’ of the ‘Files’ list, uses library notation but the library does not exist:
          ‘existence_error(library, Library)’
     ‘File’ or an element ‘File’ of the ‘Files’ list, does not exist:
          ‘existence_error(file, File)’
     ‘Flags’ is a variable or a list with an element which is a variable:
          ‘instantiation_error’
     ‘Flags’ is neither a variable nor a proper list:
          ‘type_error(list, Flags)’
     An element ‘Flag’ of the ‘Flags’ list is not a valid compiler flag:
          ‘type_error(compiler_flag, Flag)’
     An element ‘Flag’ of the ‘Flags’ list defines a value for a read-only compiler flag:
          ‘permission_error(modify, flag, Flag)’
     An element ‘Flag’ of the ‘Flags’ list defines an invalid value for a flag:
          ‘domain_error(flag_value, Flag+Value)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<91>,  Prev: Errors<54>,  Up: logtalk_load/2

2.4.9.20 Examples
.................

     % compile and load the "list" source file in the
     % current directory using default compiler flags:
     | ?- logtalk_load(list, []).

     % compile and load the "tree" source file in the "types"
     % library directory with the source_data flag turned on:
     | ?- logtalk_load(types(tree)).

     % compile and load the "file_system" source file in the
     % current directory with portability warnings suppressed:
     | ?- logtalk_load(file_system, [portability(silent)]).

See also
........

*note logtalk_compile/1: 29e, *note logtalk_compile/2: 2b2, *note
logtalk_load/1: 46, *note logtalk_make/0: 29f, *note logtalk_make/1:
2a0, *note logtalk_library_path/2: 2a7.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_make/0,  Next: logtalk_make/1,  Prev: logtalk_load/2,  Up: Compiling and loading source files

2.4.9.21 ‘logtalk_make/0’
.........................

* Menu:

* Description: Description<91>.
* Modes and number of proofs: Modes and number of proofs<54>.
* Errors: Errors<55>.
* Examples: Examples<92>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<91>,  Next: Modes and number of proofs<54>,  Up: logtalk_make/0

2.4.9.22 Description
....................

     logtalk_make

Reloads all Logtalk source files that have been modified since the time
they were last loaded.  Only source files loaded using the *note
logtalk_load/1: 46. and *note logtalk_load/2: 4e. predicates are
reloaded.  Non-modified files will also be reloaded when a previous
attempt to load them failed or when there is a change to the compilation
mode (i.e., when the files were loaded without explicit *note debug:
2e2. or *note optimize: 8c. flags and the default values of these flags
changed after loading; no check is made, however, for other implicit
compiler flags that may have changed since loading).  When an included
file is modified, this predicate reloads its main file (i.e., the file
that contains the *note include/1: b8. directive).

Depending on the *note backend Prolog compiler: 34, the shortcut ‘{*}’
may be used as an alternative.  Check the *note adapter files: 154. for
the availability of the shortcut as it is not part of the language.

     Warning: Only use the ‘{*}’ shortcut at the top-level interpreter
     and never in source files.

This predicate can be extended by the user by defining clauses for the
*note logtalk_make_target_action/1: 635. multifile and dynamic hook
predicate using the argument ‘all’.  The additional user defined actions
are run after the default one.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<54>,  Next: Errors<55>,  Prev: Description<91>,  Up: logtalk_make/0

2.4.9.23 Modes and number of proofs
...................................

     logtalk_make - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<55>,  Next: Examples<92>,  Prev: Modes and number of proofs<54>,  Up: logtalk_make/0

2.4.9.24 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<92>,  Prev: Errors<55>,  Up: logtalk_make/0

2.4.9.25 Examples
.................

     % reload all files modified since last loaded:
     | ?- logtalk_make.

See also
........

*note logtalk_compile/1: 29e, *note logtalk_compile/2: 2b2, *note
logtalk_load/1: 46, *note logtalk_load/2: 4e, *note logtalk_make/1: 2a0,
*note logtalk_make_target_action/1: 635.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_make/1,  Next: logtalk_make_target_action/1,  Prev: logtalk_make/0,  Up: Compiling and loading source files

2.4.9.26 ‘logtalk_make/1’
.........................

* Menu:

* Description: Description<92>.
* Modes and number of proofs: Modes and number of proofs<55>.
* Errors: Errors<56>.
* Examples: Examples<93>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<92>,  Next: Modes and number of proofs<55>,  Up: logtalk_make/1

2.4.9.27 Description
....................

     logtalk_make(Target)

Runs a make target.  Prints a warning message and fails when the target
is not valid.

Allows reloading all Logtalk source files that have been modified since
last loaded when called with the target ‘all’, deleting all intermediate
files generated by the compilation of Logtalk source files when called
with the target ‘clean’, checking for code issues when called with the
target ‘check’, listing of circular dependencies between pairs or trios
of objects when called with the target ‘circular’, generating
documentation when called with the target ‘documentation’, and deleting
the *note dynamic binding: 36. caches with the target ‘caches’.

There are also four variants of the ‘all’ target: ‘debug’, ‘normal’,
‘optimal’, and ‘force’.  The first three targets change the compilation
mode (by changing the default value of the *note debug: 2e2. and *note
optimize: 8c. flags) and reload all affected files (i.e., all files
loaded without an explicit ‘debug/1’ or ‘optimize/1’ compiler option).
The ‘force’ traget forces reloading of all files that were loaded
without an explicit ‘reload/1’ compiler option.  This target is
typically used after changing some compiler linter flag (e.g., the
‘portability’ flag).

When using the ‘all’ target, only source files loaded using the *note
logtalk_load/1: 46. and *note logtalk_load/2: 4e. predicates are
reloaded.  Non-modified files will also be reloaded when a previous
attempt to load them failed or when there is a change to the compilation
mode (i.e., when the files were loaded without explicit *note debug:
2e2. or *note optimize: 8c. flags and the default values of these flags
changed after loading; no check is made, however, for other implicit
compiler flags that may have changed since loading).  When an included
file is modified, this target reloads its main file (i.e., the file that
contains the *note include/1: b8. directive).

When using the ‘check’ or ‘circular’ targets, be sure to compile your
source files with the *note source_data: cc. flag turned on for complete
and detailed reports.

The ‘check’ target scans for missing entities (objects, protocols,
categories, and modules), missing entity predicates, and duplicated
library aliases.  Predicates for messages sent to objects that implement
the forwarding(1) built-in protocol are not reported.  While this
usually avoids only false positives, it may also result in failure to
report true missing predicates in some cases.

When using the ‘circular’ target, be prepared for a lengthy computation
time for applications with a large combined number of objects and
message calls.  Only mutual and triangular dependencies are checked due
to the computational cost.  Circular dependencies occur when an object
sends a message to a second object that, in turn, sends a message to the
first object.  These circular dependencies are often a consequence of
lack of separation of concerns.  But, when they cannot be fixed, the
only practical consequence is a small performance cost as some of the
messages would be forced to use dynamic binding.

The ‘documentation’ target requires the ‘doclet’ tool and a single *note
doclet object: 63c. to be loaded.  See the ‘doclet’ tool documentation
for more details.

Depending on the *note backend Prolog compiler: 34, the following
top-level shortcuts are usually defined:

   * ‘{*}’ - ‘logtalk_make(all)’

   * ‘{!}’ - ‘logtalk_make(clean)’

   * ‘{?}’ - ‘logtalk_make(check)’

   * ‘{@}’ - ‘logtalk_make(circular)’

   * ‘{#}’ - ‘logtalk_make(documentation)’

   * ‘{$}’ - ‘logtalk_make(caches)’

   * ‘{+d}’ - ‘logtalk_make(debug)’

   * ‘{+n}’ - ‘logtalk_make(normal)’

   * ‘{+o}’ - ‘logtalk_make(optimal)’

   * ‘{+f}’ - ‘logtalk_make(force)’

Check the *note adapter files: 154. for the availability of these
shortcuts as they are not part of the language.

     Warning: Only use the shortcuts at the top-level interpreter and
     never in source files.

The target actions can be extended by defining clauses for the multifile
and dynamic hook predicate *note logtalk_make_target_action(Target):
635. where ‘Target’ is one of the targets listed above.  The additional
user-defined actions are run after the default ones.

   ---------- Footnotes ----------

   (1) ../../../apis/forwarding_0.html#forwarding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<55>,  Next: Errors<56>,  Prev: Description<92>,  Up: logtalk_make/1

2.4.9.28 Modes and number of proofs
...................................

     logtalk_make(+atom) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<56>,  Next: Examples<93>,  Prev: Modes and number of proofs<55>,  Up: logtalk_make/1

2.4.9.29 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<93>,  Prev: Errors<56>,  Up: logtalk_make/1

2.4.9.30 Examples
.................

     % reload loaded source files in debug mode:
     | ?- logtalk_make(debug).

     % check for code issues in the loaded source files:
     | ?- logtalk_make(check).

     % delete all intermediate files generated by
     % the compilation of Logtalk source files:
     | ?- logtalk_make(clean).

See also
........

*note logtalk_compile/1: 29e, *note logtalk_compile/2: 2b2, *note
logtalk_load/1: 46, *note logtalk_load/2: 4e, *note logtalk_make/0: 29f,
*note logtalk_make_target_action/1: 635.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_make_target_action/1,  Next: logtalk_library_path/2,  Prev: logtalk_make/1,  Up: Compiling and loading source files

2.4.9.31 ‘logtalk_make_target_action/1’
.......................................

* Menu:

* Description: Description<93>.
* Modes and number of proofs: Modes and number of proofs<56>.
* Errors: Errors<57>.
* Examples: Examples<94>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<93>,  Next: Modes and number of proofs<56>,  Up: logtalk_make_target_action/1

2.4.9.32 Description
....................

     logtalk_make_target_action(Target)

Multifile and dynamic hook predicate that allows defining user actions
for the *note logtalk_make/1: 2a0. targets.  The user defined actions
are run after the default ones using a failure driven loop.  This loop
does not catch any exceptions thrown when calling the user-defined
actions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<56>,  Next: Errors<57>,  Prev: Description<93>,  Up: logtalk_make_target_action/1

2.4.9.33 Modes and number of proofs
...................................

     logtalk_make_target_action(+atom) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<57>,  Next: Examples<94>,  Prev: Modes and number of proofs<56>,  Up: logtalk_make_target_action/1

2.4.9.34 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<94>,  Prev: Errors<57>,  Up: logtalk_make_target_action/1

2.4.9.35 Examples
.................

     % integrate the dead_code_scanner tool with logtalk_make/1

     :- multifile(logtalk_make_target_action/1).
     :- dynamic(logtalk_make_target_action/1).

     logtalk_make_target_action(check) :-
         dead_code_scanner::all.

See also
........

*note logtalk_make/1: 2a0, *note logtalk_make/0: 29f.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_library_path/2,  Next: logtalk_load_context/2,  Prev: logtalk_make_target_action/1,  Up: Compiling and loading source files

2.4.9.36 ‘logtalk_library_path/2’
.................................

* Menu:

* Description: Description<94>.
* Modes and number of proofs: Modes and number of proofs<57>.
* Errors: Errors<58>.
* Examples: Examples<95>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<94>,  Next: Modes and number of proofs<57>,  Up: logtalk_library_path/2

2.4.9.37 Description
....................

     logtalk_library_path(Library, Path)

Dynamic and multifile user-defined predicate, allowing the declaration
of aliases to *note library: 6e. paths.  Library aliases may also be
used in the second argument (using the notation 'alias(path)').  Paths
must always end with the path directory separator character (‘'/'’).

     Warning: Library aliases should be unique.  The *note
     logtalk_make/1: 2a0. built-in predicate can be used to detect and
     report duplicated library aliases using the ‘check’ target.

Clauses for this predicate should preferably be facts.  Defining rules
to dynamically compute at runtime both library alias names and their
paths, although sometimes handy, can inadvertently result in endless
loops when those rules also attempt to expand library paths.  When
asserting facts for this predicate, use preferably ‘asserta/1’ instead
of ‘assertz/1’ to help ensure the facts will be used before any rules.

Relative paths (e.g., ‘'../'’ or ‘'./'’) should only be used within the
'alias(path)') notation so that library paths can always be expanded to
absolute paths independently of the (usually unpredictable) current
directory at the time the ‘logtalk_library_path/2’ predicate is called.

When working with a relocatable application, the actual application
installation directory can be retrieved by calling the *note
logtalk_load_context/2: 317. predicate with the ‘directory’ key and
using the returned value to define the ‘logtalk_library_path/2’
predicate.  On a *note settings file: 49. file or a *note loader file:
4f. file, simply use an *note initialization/1: 42. directive to wrap
the call to the ‘logtalk_load_context/2’ predicate and the assert of the
‘logtalk_library_path/2’ fact.

This predicate may be used to override the default *note scratch
directory: 293. by defining the library alias ‘scratch_directory’ in a
backend Prolog initialization file (assumed to be loaded prior to
Logtalk loading).  This allows e.g.  Logtalk to be installed in a
read-only directory by setting this alias to the operating-system
directory for temporary files.  It also allows several Logtalk instances
to run concurrently without conflict by using a unique scratch directory
per instance (e.g., using a process ID or a UUID generator).

This predicate may be used to override the default location used by the
*note packs: 649. tool to store registries and packs by defining the
‘logtalk_packs’ library alias in settings file or in a backend Prolog
initialization file (assumed to be loaded prior to Logtalk loading).

The *note logtalk: d1. built-in object provides an
expand_library_path/2(1) predicate that can be used to expand library
aliases and files expressed using library notation.

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0-expand-library-path-2


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<57>,  Next: Errors<58>,  Prev: Description<94>,  Up: logtalk_library_path/2

2.4.9.38 Modes and number of proofs
...................................

     logtalk_library_path(?atom, -atom) - zero_or_more
     logtalk_library_path(?atom, -compound) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<58>,  Next: Examples<95>,  Prev: Modes and number of proofs<57>,  Up: logtalk_library_path/2

2.4.9.39 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<95>,  Prev: Errors<58>,  Up: logtalk_library_path/2

2.4.9.40 Examples
.................

     :- initialization((
        logtalk_load_context(directory, Directory),
        asserta(logtalk_library_path(my_application_root, Directory))
     )).

     | ?- logtalk_library_path(viewpoints, Path).

     Path = examples('viewpoints/')
     yes

     | ?- logtalk_library_path(Library, Path).

     Library = home,
     Path = '$HOME/' ;

     Library = logtalk_home,
     Path = '$LOGTALKHOME/' ;

     Library = logtalk_user
     Path = '$LOGTALKUSER/' ;

     Library = examples
     Path = logtalk_user('examples/') ;

     Library = library
     Path = logtalk_user('library/') ;

     Library = viewpoints
     Path = examples('viewpoints/')
     yes

     | ?- logtalk::expand_library_path(viewpoints, Path).

     Path = '/Users/pmoura/logtalk/examples/viewpoints/'.
     yes

     | ?- logtalk::expand_library_path(viewpoints('loader.lgt'), Path).

     Path = '/Users/pmoura/logtalk/examples/viewpoints/loader.lgt'.
     yes

See also
........

*note logtalk_compile/1: 29e, *note logtalk_compile/2: 2b2, *note
logtalk_load/1: 46, *note logtalk_load/2: 4e.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_load_context/2,  Prev: logtalk_library_path/2,  Up: Compiling and loading source files

2.4.9.41 ‘logtalk_load_context/2’
.................................

* Menu:

* Description: Description<95>.
* Modes and number of proofs: Modes and number of proofs<58>.
* Errors: Errors<59>.
* Examples: Examples<96>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<95>,  Next: Modes and number of proofs<58>,  Up: logtalk_load_context/2

2.4.9.42 Description
....................

     logtalk_load_context(Key, Value)

Provides access to the Logtalk compilation/loading context.  The
following keys are currently supported:

   * ‘entity_identifier’ - identifier of the entity being compiled if
     any

   * ‘entity_prefix’ - internal prefix for the entity compiled code

   * ‘entity_type’ - returns the value ‘module’ when compiling a module
     as an object

   * ‘entity_relation’ - returns the entity relations as declared in the
     entity opening directive

   * ‘source’ - full path of the source file being compiled

   * ‘file’ - the actual file being compiled, different from ‘source’
     only when processing an ‘include/1’ directive

   * ‘basename’ - source file basename

   * ‘directory’ - source file directory

   * ‘stream’ - input stream being used to read source file terms

   * ‘target’ - the full path of the intermediate Prolog file

   * ‘flags’ - the list of the explicit flags used for the compilation
     of the source file

   * ‘term’ - the source file term being compiled

   * ‘term_position’ - the position of the term being compiled
     (‘StartLine-EndLine’)

   * ‘term_position(Term)’ - the position of the term being compiled
     (‘StartLine-EndLine’)

   * ‘variables’ - the variables of the term being compiled
     (‘[Variable1, ...]’)

   * ‘variable_names’ - the variable names of the term being compiled
     (‘[Name1=Variable1, ...]’)

   * ‘variable_names(Term)’ - the variable names of the term being
     compiled (‘[Name1=Variable1, ...]’)

   * ‘singletons’ - the singleton variables of the term being compiled
     (‘[Name1=Variable1, ...]’)

   * ‘singletons(Term)’ - the singleton variables of the term being
     compiled (‘[Name1=Variable1, ...]’)

   * ‘parameter_variables’ - list of parameter variable names and
     positions (‘[Name1-Position1, ...]’)

For the ‘entity_relation’ key, the possible values are:

   * ‘extends_protocol(Protocol, ParentProtocol, Scope)’

   * ‘implements_protocol(ObjectOrCategory, Protocol, Scope)’

   * ‘extends_category(Category, ParentCategory, Scope)’

   * ‘imports_category(Object, Category, Scope)’

   * ‘extends_object(Prototype, Parent, Scope)’

   * ‘instantiates_class(Instance, Class, Scope)’

   * ‘specializes_class(Class, Superclass, Scope)’

   * ‘complements_object(Category, Object)’

Calling this predicate with the ‘parameter_variables’ key only succeeds
when compiling a parametric entity containing parameter variables.

This predicate is usually called by the *note term_expansion/2: fc. and
*note goal_expansion/2: fd. methods.  It can also be called directly
from *note initialization/1: 42. directives in a source file.  Note that
the entity keys are only available when compiling an entity term or from
an object ‘initialization/1’ directive.

     Warning: The ‘term_position’ key is only supported in *note backend
     Prolog compilers: 34. that provide access to the start and end
     lines of a read term.  When such support is not available, the
     value ‘-1’ is returned for both the start and the end lines.

     Variables in the values of the ‘term’, ‘variables’,
     ‘variable_names’, and ‘singletons’ keys are not shared with,
     respectively, the term and goal arguments of the ‘term_expansion/2’
     and ‘goal_expansion/2’ methods.  Use instead the
     ‘variable_names(Term)’ and ‘singletons(Term)’ keys when possible.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<58>,  Next: Errors<59>,  Prev: Description<95>,  Up: logtalk_load_context/2

2.4.9.43 Modes and number of proofs
...................................

     logtalk_load_context(?callable, -nonvar) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<59>,  Next: Examples<96>,  Prev: Modes and number of proofs<58>,  Up: logtalk_load_context/2

2.4.9.44 Errors
...............

     ‘Key’ is neither a variable nor a callable term:
          ‘type_error(callable, Key)’
     ‘Key’ is a callable term but not a valid key:
          ‘domain_error(logtalk_load_context_key, Key)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<96>,  Prev: Errors<59>,  Up: logtalk_load_context/2

2.4.9.45 Examples
.................

     % expand source file terms only if they are entity terms
     term_expansion(Term, ExpandedTerms) :-
         logtalk_load_context(entity_identifier, _),
         ....

     % expand source file term while accessing its variable names
     term_expansion(Term, ExpandedTerms) :-
         logtalk_load_context(variable_names(Term), VariableNames),
         ....

     % define a library alias based on the source directory
     :- initialization((
         logtalk_load_context(directory, Directory),
         assertz(logtalk_library_path(my_app, Directory))
     )).

See also
........

*note term_expansion/2: fc, *note goal_expansion/2: fd, *note
initialization/1: 42.


File: TheLogtalkHandbook-3.100.1.info,  Node: Flags,  Next: Linter,  Prev: Compiling and loading source files,  Up: Built-in predicates

2.4.10 Flags
------------

'built-in predicate'

* Menu:

* current_logtalk_flag/2::
* set_logtalk_flag/2: set_logtalk_flag/2<2>.
* create_logtalk_flag/3::


File: TheLogtalkHandbook-3.100.1.info,  Node: current_logtalk_flag/2,  Next: set_logtalk_flag/2<2>,  Up: Flags

2.4.10.1 ‘current_logtalk_flag/2’
.................................

* Menu:

* Description: Description<96>.
* Modes and number of proofs: Modes and number of proofs<59>.
* Errors: Errors<60>.
* Examples: Examples<97>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<96>,  Next: Modes and number of proofs<59>,  Up: current_logtalk_flag/2

2.4.10.2 Description
....................

     current_logtalk_flag(Flag, Value)

Enumerates, by backtracking, the current Logtalk flag values.  For a
description of the predefined compiler flags, please see the *note
Compiler flags: 251. section in the User Manual.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<59>,  Next: Errors<60>,  Prev: Description<96>,  Up: current_logtalk_flag/2

2.4.10.3 Modes and number of proofs
...................................

     current_logtalk_flag(?atom, ?atom) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<60>,  Next: Examples<97>,  Prev: Modes and number of proofs<59>,  Up: current_logtalk_flag/2

2.4.10.4 Errors
...............

     ‘Flag’ is neither a variable nor an atom:
          ‘type_error(atom, Flag)’
     ‘Flag’ is an atom but an invalid flag:
          ‘domain_error(flag, Value)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<97>,  Prev: Errors<60>,  Up: current_logtalk_flag/2

2.4.10.5 Examples
.................

     % get the current value of the source_data flag:
     | ?- current_logtalk_flag(source_data, Value).

See also
........

*note create_logtalk_flag/3: 2e6, *note set_logtalk_flag/2: 51.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: set_logtalk_flag/2<2>,  Next: create_logtalk_flag/3,  Prev: current_logtalk_flag/2,  Up: Flags

2.4.10.6 ‘set_logtalk_flag/2’
.............................

* Menu:

* Description: Description<97>.
* Modes and number of proofs: Modes and number of proofs<60>.
* Errors: Errors<61>.
* Examples: Examples<98>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<97>,  Next: Modes and number of proofs<60>,  Up: set_logtalk_flag/2<2>

2.4.10.7 Description
....................

     set_logtalk_flag(Flag, Value)

Sets global, default, flag values.  For local flag scope, use the
corresponding *note set_logtalk_flag/2: 50. directive.  To set a global
flag value when compiling and loading a source file, wrap the calls to
this built-in predicate with an *note initialization/1: 42. directive.
For a description of the predefined compiler flags, please see the *note
Compiler flags: 251. section in the User Manual.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<60>,  Next: Errors<61>,  Prev: Description<97>,  Up: set_logtalk_flag/2<2>

2.4.10.8 Modes and number of proofs
...................................

     set_logtalk_flag(+atom, +nonvar) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<61>,  Next: Examples<98>,  Prev: Modes and number of proofs<60>,  Up: set_logtalk_flag/2<2>

2.4.10.9 Errors
...............

     ‘Flag’ is a variable:
          ‘instantiation_error’
     ‘Value’ is a variable:
          ‘instantiation_error’
     ‘Flag’ is neither a variable nor an atom:
          ‘type_error(atom, Flag)’
     ‘Flag’ is an atom but an invalid flag:
          ‘domain_error(flag, Flag)’
     ‘Value’ is not a valid value for flag ‘Flag’:
          ‘domain_error(flag_value, Flag + Value)’
     ‘Flag’ is a read-only flag:
          ‘permission_error(modify, flag, Flag)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<98>,  Prev: Errors<61>,  Up: set_logtalk_flag/2<2>

2.4.10.10 Examples
..................

     % turn off globally and by default the compiler
     % unknown entities warnings:
     | ?- set_logtalk_flag(unknown_entities, silent).

See also
........

*note create_logtalk_flag/3: 2e6, *note current_logtalk_flag/2: 2b3.

'built-in predicate'


File: TheLogtalkHandbook-3.100.1.info,  Node: create_logtalk_flag/3,  Prev: set_logtalk_flag/2<2>,  Up: Flags

2.4.10.11 ‘create_logtalk_flag/3’
.................................

* Menu:

* Description: Description<98>.
* Modes and number of proofs: Modes and number of proofs<61>.
* Errors: Errors<62>.
* Examples: Examples<99>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<98>,  Next: Modes and number of proofs<61>,  Up: create_logtalk_flag/3

2.4.10.12 Description
.....................

     create_logtalk_flag(Flag, Value, Options)

Creates a new Logtalk flag and sets its default value.  User-defined
flags can be queried and set in the same way as predefined flags by
using, respectively, the *note current_logtalk_flag/2: 2b3. and *note
set_logtalk_flag/2: 51. built-in predicates.  For a description of the
predefined compiler flags, please see the *note Compiler flags: 251.
section in the User Manual.

This predicate is based on the specification of the SWI-Prolog
‘create_prolog_flag/3’ built-in predicate and supports the same options:
‘access(Access)’, where ‘Access’ can be either ‘read_write’ (the
default) or ‘read_only’; ‘keep(Keep)’, where ‘Keep’ can be either
‘false’ (the default) or ‘true’, for deciding if an existing definition
of the flag should be kept or replaced by the new one; and ‘type(Type)’
for specifying the type of the flag, which can be ‘boolean’, ‘atom’,
‘integer’, ‘float’, or ‘term’ (which only restricts the flag value to
ground terms).  When the ‘type/1’ option is not specified, the type of
the flag is inferred from its initial value.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<61>,  Next: Errors<62>,  Prev: Description<98>,  Up: create_logtalk_flag/3

2.4.10.13 Modes and number of proofs
....................................

     create_logtalk_flag(+atom, +ground, +list(ground)) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<62>,  Next: Examples<99>,  Prev: Modes and number of proofs<61>,  Up: create_logtalk_flag/3

2.4.10.14 Errors
................

     ‘Flag’ is a variable:
          ‘instantiation_error’
     ‘Value’ is not a ground term:
          ‘instantiation_error’
     ‘Options’ is not a ground term:
          ‘instantiation_error’
     ‘Flag’ is neither a variable nor an atom:
          ‘type_error(atom, Flag)’
     ‘Options’ is neither a variable nor a list:
          ‘type_error(atom, Flag)’
     ‘Value’ is not a valid value for flag Flag:
          ‘domain_error(flag_value, Flag + Value)’
     ‘Flag’ is a system-defined flag:
          ‘permission_error(modify, flag, Flag)’
     An element ‘Option’ of the list ‘Options’ is not a valid option
          domain_error(flag_option,Option)
     The list ‘Options’ contains a ‘type(Type)’ option and ‘Value’ is not of type ‘Type’
          type_error(Type, Value)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<99>,  Prev: Errors<62>,  Up: create_logtalk_flag/3

2.4.10.15 Examples
..................

     % create a new boolean flag with default value set to false:
     | ?- create_logtalk_flag(pretty_print_blobs, false, []).

See also
........

*note current_logtalk_flag/2: 2b3, *note set_logtalk_flag/2: 51.


File: TheLogtalkHandbook-3.100.1.info,  Node: Linter,  Prev: Flags,  Up: Built-in predicates

2.4.11 Linter
-------------

'built-in predicate'

* Menu:

* logtalk_linter_hook/7::


File: TheLogtalkHandbook-3.100.1.info,  Node: logtalk_linter_hook/7,  Up: Linter

2.4.11.1 ‘logtalk_linter_hook/7’
................................

* Menu:

* Description: Description<99>.
* Modes and number of proofs: Modes and number of proofs<62>.
* Errors: Errors<63>.
* Examples: Examples<100>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<99>,  Next: Modes and number of proofs<62>,  Up: logtalk_linter_hook/7

2.4.11.2 Description
....................

     logtalk_linter_hook(Goal, Flag, File, Lines, Type, Entity, Warning)

Multifile user-defined predicate, supporting the definition of custom
linter warnings.  Experimental.  The ‘Goal’ argument can be a
message-sending goal, ‘Object::Message’, a call to a Prolog built-in
predicate, or a call to a module predicate, ‘Module:Predicate’.  The
‘Flag’ argument must be a supported linter flag.  The ‘Warning’ argument
must be a valid ‘core’ message term.  For a given ‘Goal’, only the first
successful call to this predicate is considered.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<62>,  Next: Errors<63>,  Prev: Description<99>,  Up: logtalk_linter_hook/7

2.4.11.3 Modes and number of proofs
...................................

     logtalk_linter_hook(@callable, +atom, +atom, +pair(integer), +atom, @object_identifier, --callable) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<63>,  Next: Examples<100>,  Prev: Modes and number of proofs<62>,  Up: logtalk_linter_hook/7

2.4.11.4 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<100>,  Prev: Errors<63>,  Up: logtalk_linter_hook/7

2.4.11.5 Examples
.................

     :- multifile(user::logtalk_linter_hook/7).
     % warn about using list::append/3 to construct a list from an head and a tail
     user::logtalk_linter_hook(
         list::append(L1,L2,L), suspicious_calls,
         File, Lines, Type, Entity,
         suspicious_call(File, Lines, Type, Entity, list::append(L1,L2,L), [L=[Head|L2]])
     ) :-
         nonvar(L1),
         L1 = [Head].


File: TheLogtalkHandbook-3.100.1.info,  Node: Built-in methods<2>,  Prev: Built-in predicates,  Up: Reference Manual

2.5 Built-in methods
====================

* Menu:

* Logic and control::
* Execution context::
* Reflection: Reflection<2>.
* Database::
* Meta-calls::
* Error handling: Error handling<2>.
* All solutions::
* Event handling: Event handling<3>.
* Message forwarding::
* Definite clause grammar rules: Definite clause grammar rules<2>.
* Term and goal expansion: Term and goal expansion<2>.
* Coinduction hooks::
* Message printing::
* Question asking::


File: TheLogtalkHandbook-3.100.1.info,  Node: Logic and control,  Next: Execution context,  Up: Built-in methods<2>

2.5.1 Logic and control
-----------------------

'built-in method'

* Menu:

* !/0::
* true/0::
* fail/0::
* false/0::
* repeat/0::


File: TheLogtalkHandbook-3.100.1.info,  Node: !/0,  Next: true/0,  Up: Logic and control

2.5.1.1 ‘!/0’
.............

* Menu:

* Description: Description<100>.
* Modes and number of proofs: Modes and number of proofs<63>.
* Errors: Errors<64>.
* Examples: Examples<101>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<100>,  Next: Modes and number of proofs<63>,  Up: !/0

2.5.1.2 Description
...................

     !

Always succeeds with the side-effect of discarding choice-points.  See
also the ISO Prolog standard definition.  This built-in method is
declared as a public method and can be used as a message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<63>,  Next: Errors<64>,  Prev: Description<100>,  Up: !/0

2.5.1.3 Modes and number of proofs
..................................

     ! - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<64>,  Next: Examples<101>,  Prev: Modes and number of proofs<63>,  Up: !/0

2.5.1.4 Errors
..............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<101>,  Prev: Errors<64>,  Up: !/0

2.5.1.5 Examples
................

(none)

See also
........

*note true/0: 197, *note fail/0: 198, *note false/0: 199, *note
repeat/0: 19a.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: true/0,  Next: fail/0,  Prev: !/0,  Up: Logic and control

2.5.1.6 ‘true/0’
................

* Menu:

* Description: Description<101>.
* Modes and number of proofs: Modes and number of proofs<64>.
* Errors: Errors<65>.
* Examples: Examples<102>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<101>,  Next: Modes and number of proofs<64>,  Up: true/0

2.5.1.7 Description
...................

     true

Always succeeds.  See also the ISO Prolog standard definition.  This
built-in method is declared as a public method and can be used as a
message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<64>,  Next: Errors<65>,  Prev: Description<101>,  Up: true/0

2.5.1.8 Modes and number of proofs
..................................

     true - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<65>,  Next: Examples<102>,  Prev: Modes and number of proofs<64>,  Up: true/0

2.5.1.9 Errors
..............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<102>,  Prev: Errors<65>,  Up: true/0

2.5.1.10 Examples
.................

(none)

See also
........

*note !/0: 196, *note fail/0: 198, *note false/0: 199, *note repeat/0:
19a.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: fail/0,  Next: false/0,  Prev: true/0,  Up: Logic and control

2.5.1.11 ‘fail/0’
.................

* Menu:

* Description: Description<102>.
* Modes and number of proofs: Modes and number of proofs<65>.
* Errors: Errors<66>.
* Examples: Examples<103>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<102>,  Next: Modes and number of proofs<65>,  Up: fail/0

2.5.1.12 Description
....................

     fail

Always fails.  See also the ISO Prolog standard definition.  This
built-in method is declared as a public method and can be used as a
message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<65>,  Next: Errors<66>,  Prev: Description<102>,  Up: fail/0

2.5.1.13 Modes and number of proofs
...................................

     fail - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<66>,  Next: Examples<103>,  Prev: Modes and number of proofs<65>,  Up: fail/0

2.5.1.14 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<103>,  Prev: Errors<66>,  Up: fail/0

2.5.1.15 Examples
.................

(none)

See also
........

*note !/0: 196, *note true/0: 197, *note false/0: 199, *note repeat/0:
19a.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: false/0,  Next: repeat/0,  Prev: fail/0,  Up: Logic and control

2.5.1.16 ‘false/0’
..................

* Menu:

* Description: Description<103>.
* Modes and number of proofs: Modes and number of proofs<66>.
* Errors: Errors<67>.
* Examples: Examples<104>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<103>,  Next: Modes and number of proofs<66>,  Up: false/0

2.5.1.17 Description
....................

     false

Always fails.  See also the ISO Prolog standard definition.  This
built-in method is declared as a public method and can be used as a
message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<66>,  Next: Errors<67>,  Prev: Description<103>,  Up: false/0

2.5.1.18 Modes and number of proofs
...................................

     false - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<67>,  Next: Examples<104>,  Prev: Modes and number of proofs<66>,  Up: false/0

2.5.1.19 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<104>,  Prev: Errors<67>,  Up: false/0

2.5.1.20 Examples
.................

(none)

See also
........

*note !/0: 196, *note true/0: 197, *note fail/0: 198, *note repeat/0:
19a.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: repeat/0,  Prev: false/0,  Up: Logic and control

2.5.1.21 ‘repeat/0’
...................

* Menu:

* Description: Description<104>.
* Modes and number of proofs: Modes and number of proofs<67>.
* Errors: Errors<68>.
* Examples: Examples<105>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<104>,  Next: Modes and number of proofs<67>,  Up: repeat/0

2.5.1.22 Description
....................

     repeat

Always succeeds when called and when backtracking into its call with an
infinite number of choice-points.  See also the ISO Prolog standard
definition.  This built-in method is declared as a public method and can
be used as a message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<67>,  Next: Errors<68>,  Prev: Description<104>,  Up: repeat/0

2.5.1.23 Modes and number of proofs
...................................

     repeat - one_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<68>,  Next: Examples<105>,  Prev: Modes and number of proofs<67>,  Up: repeat/0

2.5.1.24 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<105>,  Prev: Errors<68>,  Up: repeat/0

2.5.1.25 Examples
.................

(none)

See also
........

*note !/0: 196, *note true/0: 197, *note fail/0: 198, *note false/0:
199.


File: TheLogtalkHandbook-3.100.1.info,  Node: Execution context,  Next: Reflection<2>,  Prev: Logic and control,  Up: Built-in methods<2>

2.5.2 Execution context
-----------------------

'built-in method'

* Menu:

* context/1::
* parameter/2::
* self/1::
* sender/1::
* this/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: context/1,  Next: parameter/2,  Up: Execution context

2.5.2.1 ‘context/1’
...................

* Menu:

* Description: Description<105>.
* Modes and number of proofs: Modes and number of proofs<68>.
* Errors: Errors<69>.
* Examples: Examples<106>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<105>,  Next: Modes and number of proofs<68>,  Up: context/1

2.5.2.2 Description
...................

     context(Context)

Returns the execution context for a predicate clause using the term
‘logtalk(Head,ExecutionContext)’ where ‘Head’ is the head of the clause
containing the call.  This private predicate is mainly used for
providing an error context when type-checking predicate arguments.  The
‘ExecutionContext’ term should be regarded as an opaque term, which can
be decoded using the logtalk::execution_context/7(1) predicate.  Calls
to this predicate are inlined at compilation time.

     Warning: As the execution context term includes the clause head,
     the head of the clause calling the ‘context(Context)’ method cannot
     contain the ‘Context’ variable as that would result in the creation
     of a cyclic term.  The compiler detects and reports any offending
     clauses by throwing a ‘representation_error(acyclic_term)’ error.

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0-execution-context-7


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<68>,  Next: Errors<69>,  Prev: Description<105>,  Up: context/1

2.5.2.3 Modes and number of proofs
..................................

     context(--callable) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<69>,  Next: Examples<106>,  Prev: Modes and number of proofs<68>,  Up: context/1

2.5.2.4 Errors
..............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<106>,  Prev: Errors<69>,  Up: context/1

2.5.2.5 Examples
................

     foo(A, N) :-
         % type-check arguments
         context(Context),
         type::check(atom, A, Context),
         type::check(integer, N, Context),
         % arguments are fine; go ahead
         ... .

See also
........

*note parameter/2: a2, *note self/1: 67, *note sender/1: 19d, *note
this/1: 68.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: parameter/2,  Next: self/1,  Prev: context/1,  Up: Execution context

2.5.2.6 ‘parameter/2’
.....................

* Menu:

* Description: Description<106>.
* Modes and number of proofs: Modes and number of proofs<69>.
* Errors: Errors<70>.
* Examples: Examples<107>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<106>,  Next: Modes and number of proofs<69>,  Up: parameter/2

2.5.2.7 Description
...................

     parameter(Number, Term)

Used in *note parametric objects: 6a0. (and parametric categories), this
private method provides runtime access to the parameter values of the
entity that contains the predicate clause whose body is being executed
by using the argument number in the entity identifier.  This predicate
is implemented as a unification between its second argument and the
corresponding implicit execution-context argument in the predicate
clause making the call.  This unification occurs at the clause head when
the second argument is not instantiated (the most common case).  When
the second argument is instantiated, the unification must be delayed to
runtime and thus occurs at the clause body.

Entity parameters can also be accessed using 'parameter variables',
which use the syntax ‘_VariableName_’.  The compiler recognizes
occurrences of these variables in directives and clauses.  Parameter
variables allow us to abstract parameter positions, thus simplifying
code maintenance.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<69>,  Next: Errors<70>,  Prev: Description<106>,  Up: parameter/2

2.5.2.8 Modes and number of proofs
..................................

     parameter(+integer, ?term) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<70>,  Next: Examples<107>,  Prev: Modes and number of proofs<69>,  Up: parameter/2

2.5.2.9 Errors
..............

     ‘Number’ is a variable:
          ‘instantiation_error’
     ‘Number’ is neither a variable nor an integer value:
          ‘type_error(integer, Number)’
     ‘Number’ is smaller than one or greater than the parametric entity identifier arity:
          ‘domain_error(out_of_range, Number)’
     ‘Entity’ identifier is not a compound term:
          ‘type_error(compound, Entity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<107>,  Prev: Errors<70>,  Up: parameter/2

2.5.2.10 Examples
.................

     :- object(box(_Color, _Weight)).

         ...

         % this clause is translated into
         % a fact upon compilation
         color(Color) :-
             parameter(1, Color).

         % upon compilation, the >/2 call will be
         % the single goal in the clause body
         heavy :-
             parameter(2, Weight),
             Weight > 10.
         ...

The same example using 'parameter variables':

     :- object(box(_Color_, _Weight_)).

         ...

         color(_Color_).

         heavy :-
             _Weight_ > 10.

         ...

See also
........

*note context/1: 19e, *note self/1: 67, *note sender/1: 19d, *note
this/1: 68.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: self/1,  Next: sender/1,  Prev: parameter/2,  Up: Execution context

2.5.2.11 ‘self/1’
.................

* Menu:

* Description: Description<107>.
* Modes and number of proofs: Modes and number of proofs<70>.
* Errors: Errors<71>.
* Examples: Examples<108>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<107>,  Next: Modes and number of proofs<70>,  Up: self/1

2.5.2.12 Description
....................

     self(Self)

Unifies its argument with the object that received the message under
processing.

This private method is compiled into a unification between its argument
and the corresponding implicit context argument in the predicate clause
making the call.  This unification occurs at the clause head when the
argument is not bound at compile-time (the most common case).


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<70>,  Next: Errors<71>,  Prev: Description<107>,  Up: self/1

2.5.2.13 Modes and number of proofs
...................................

     self(?object_identifier) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<71>,  Next: Examples<108>,  Prev: Modes and number of proofs<70>,  Up: self/1

2.5.2.14 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<108>,  Prev: Errors<71>,  Up: self/1

2.5.2.15 Examples
.................

     % upon compilation, the write/1 call will be
     % the first goal in the clause body
     test :-
         self(Self),
         write('executing a method in behalf of '),
         writeq(Self), nl.

See also
........

*note context/1: 19e, *note parameter/2: a2, *note sender/1: 19d, *note
this/1: 68.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: sender/1,  Next: this/1,  Prev: self/1,  Up: Execution context

2.5.2.16 ‘sender/1’
...................

* Menu:

* Description: Description<108>.
* Modes and number of proofs: Modes and number of proofs<71>.
* Errors: Errors<72>.
* Examples: Examples<109>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<108>,  Next: Modes and number of proofs<71>,  Up: sender/1

2.5.2.17 Description
....................

     sender(Sender)

Unifies its argument with the object that sent the message under
processing.

This private method is translated into a unification between its
argument and the corresponding implicit context argument in the
predicate clause making the call.  This unification occurs at the clause
head when the argument is not bound at compile-time (the most common
case).


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<71>,  Next: Errors<72>,  Prev: Description<108>,  Up: sender/1

2.5.2.18 Modes and number of proofs
...................................

     sender(?object_identifier) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<72>,  Next: Examples<109>,  Prev: Modes and number of proofs<71>,  Up: sender/1

2.5.2.19 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<109>,  Prev: Errors<72>,  Up: sender/1

2.5.2.20 Examples
.................

     % after compilation, the write/1 call will
     % be the first goal in the clause body
     test :-
         sender(Sender),
         write('executing a method to answer a message sent by '),
         writeq(Sender), nl.

See also
........

*note context/1: 19e, *note parameter/2: a2, *note self/1: 67, *note
this/1: 68.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: this/1,  Prev: sender/1,  Up: Execution context

2.5.2.21 ‘this/1’
.................

* Menu:

* Description: Description<109>.
* Modes and number of proofs: Modes and number of proofs<72>.
* Errors: Errors<73>.
* Examples: Examples<110>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<109>,  Next: Modes and number of proofs<72>,  Up: this/1

2.5.2.22 Description
....................

     this(This)

Unifies its argument with the identifier of the object calling this
method.  When this method is called from a category, the argument is
unified with the object importing the category on whose behalf the
clause containing the call is being used to prove the current goal.

This private method is implemented as a unification between its argument
and the corresponding implicit execution-context argument in the
predicate clause making the call.  This unification occurs at the clause
head when the argument is not bound at compile-time (the most common
case).

This method is useful for avoiding hard-coding references to an object
identifier or for retrieving all object parameters with a single call
when using parametric objects.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<72>,  Next: Errors<73>,  Prev: Description<109>,  Up: this/1

2.5.2.23 Modes and number of proofs
...................................

     this(?object_identifier) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<73>,  Next: Examples<110>,  Prev: Modes and number of proofs<72>,  Up: this/1

2.5.2.24 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<110>,  Prev: Errors<73>,  Up: this/1

2.5.2.25 Examples
.................

     % after compilation, the write/1 call will
     % be the first goal in the clause body
     test :-
         this(This),
         write('Using a predicate clause contained in '),
         writeq(This), nl.

See also
........

*note context/1: 19e, *note parameter/2: a2, *note self/1: 67, *note
sender/1: 19d.


File: TheLogtalkHandbook-3.100.1.info,  Node: Reflection<2>,  Next: Database,  Prev: Execution context,  Up: Built-in methods<2>

2.5.3 Reflection
----------------

'built-in method'

* Menu:

* current_op/3::
* current_predicate/1::
* predicate_property/2::


File: TheLogtalkHandbook-3.100.1.info,  Node: current_op/3,  Next: current_predicate/1,  Up: Reflection<2>

2.5.3.1 ‘current_op/3’
......................

* Menu:

* Description: Description<110>.
* Modes and number of proofs: Modes and number of proofs<73>.
* Errors: Errors<74>.
* Examples: Examples<111>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<110>,  Next: Modes and number of proofs<73>,  Up: current_op/3

2.5.3.2 Description
...................

     current_op(Priority, Specifier, Operator)

Enumerates, by backtracking, the visible operators declared for an
object.  Operators not declared using a scope directive are not
enumerated.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<73>,  Next: Errors<74>,  Prev: Description<110>,  Up: current_op/3

2.5.3.3 Modes and number of proofs
..................................

     current_op(?operator_priority, ?operator_specifier, ?atom) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<74>,  Next: Examples<111>,  Prev: Modes and number of proofs<73>,  Up: current_op/3

2.5.3.4 Errors
..............

     ‘Priority’ is neither a variable nor an integer:
          ‘type_error(integer, Priority)’
     ‘Priority’ is an integer but not a valid operator priority:
          ‘domain_error(operator_priority, Priority)’
     ‘Specifier’ is neither a variable nor an atom:
          ‘type_error(atom, Specifier)’
     ‘Specifier’ is an atom but not a valid operator specifier:
          ‘domain_error(operator_specifier, Specifier)’
     ‘Operator’ is neither a variable nor an atom:
          ‘type_error(atom, Operator)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<111>,  Prev: Errors<74>,  Up: current_op/3

2.5.3.5 Examples
................

     To enumerate, by backtracking, the local operators or the operators visible in *note this: 114.:
          ‘current_op(Priority, Specifier, Operator)’
     To enumerate, by backtracking, the public and protected operators visible in *note self: 69.:
          ‘::current_op(Priority, Specifier, Operator)’
     To enumerate, by backtracking, the public operators visible for an explicit object:
          ‘Object::current_op(Priority, Specifier, Operator)’

See also
........

*note current_predicate/1: 141, *note predicate_property/2: 142, *note
op/3: 15d.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: current_predicate/1,  Next: predicate_property/2,  Prev: current_op/3,  Up: Reflection<2>

2.5.3.6 ‘current_predicate/1’
.............................

* Menu:

* Description: Description<111>.
* Modes and number of proofs: Modes and number of proofs<74>.
* Errors: Errors<75>.
* Examples: Examples<112>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<111>,  Next: Modes and number of proofs<74>,  Up: current_predicate/1

2.5.3.7 Description
...................

     current_predicate(Predicate)

Enumerates, by backtracking, visible, user-defined, object predicates.
Built-in predicates and predicates not declared using a scope directive
are not enumerated.

This predicate also succeeds for any predicates listed in *note uses/2:
4b. and *note use_module/2: 4d. directives.

When ‘Predicate’ is bound at compile-time to a ‘(:)/2’ term, this
predicate enumerates module predicates (assuming that the *note backend
Prolog compiler: 34. supports modules).


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<74>,  Next: Errors<75>,  Prev: Description<111>,  Up: current_predicate/1

2.5.3.8 Modes and number of proofs
..................................

     current_predicate(?predicate_indicator) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<75>,  Next: Examples<112>,  Prev: Modes and number of proofs<74>,  Up: current_predicate/1

2.5.3.9 Errors
..............

     ‘Predicate’ is neither a variable nor a valid predicate indicator:
          ‘type_error(predicate_indicator, Predicate)’
     ‘Predicate’ is a ‘Name/Arity’ term but ‘Functor’ is neither a variable nor an atom:
          ‘type_error(atom, Name)’
     ‘Predicate’ is a ‘Name/Arity’ term but ‘Arity’ is neither a variable nor an integer:
          ‘type_error(integer, Arity)’
     ‘Predicate’ is a ‘Name/Arity’ term but ‘Arity’ is a negative integer:
          ‘domain_error(not_less_than_zero, Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<112>,  Prev: Errors<75>,  Up: current_predicate/1

2.5.3.10 Examples
.................

     To enumerate, by backtracking, the locally visible user predicates or the user predicates visible in *note this: 114.:
          ‘current_predicate(Predicate)’
     To enumerate, by backtracking, the public and protected user predicates visible in *note self: 69.:
          ‘::current_predicate(Predicate)’
     To enumerate, by backtracking, the public user predicates visible for an explicit object:
          ‘Object::current_predicate(Predicate)’

An example of enumerating locally visible object predicates.  These
include predicates listed using *note uses/2: 4b. and *note
use_module/2: 4d. directives:

     :- object(foo).

         :- uses(bar, [
             baz/1, quux/2
         ]).

         :- public(pred/1).
         pred(X) :-
            current_predicate(X).

     :- end_object.

     | ?- foo::pred(X).
     X = pred/1 ;
     X = baz/1 ;
     X = quux/2 ;
     no

See also
........

*note current_op/3: 15e, *note predicate_property/2: 142, *note uses/2:
4b, *note use_module/2: 4d.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: predicate_property/2,  Prev: current_predicate/1,  Up: Reflection<2>

2.5.3.11 ‘predicate_property/2’
...............................

* Menu:

* Description: Description<112>.
* Modes and number of proofs: Modes and number of proofs<75>.
* Errors: Errors<76>.
* Examples: Examples<113>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<112>,  Next: Modes and number of proofs<75>,  Up: predicate_property/2

2.5.3.12 Description
....................

     predicate_property(Predicate, Property)

Enumerates, by backtracking, the properties of a visible object
predicate.  Properties for predicates not declared using a scope
directive are not enumerated.  The valid predicate properties are listed
in the language grammar section on *note predicate properties: 3ee. and
described in the User Manual section on *note predicate properties: 1cc.

When ‘Predicate’ is listed in a *note uses/2: 4b. or *note use_module/2:
4d. directive, properties are enumerated for the referenced object or
module predicate.

When ‘Predicate’ is bound at compile-time to a ‘(:)/2’ term, this
predicate enumerates properties for module predicates (assuming that the
*note backend Prolog compiler: 34. supports modules).


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<75>,  Next: Errors<76>,  Prev: Description<112>,  Up: predicate_property/2

2.5.3.13 Modes and number of proofs
...................................

     predicate_property(+callable, ?predicate_property) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<76>,  Next: Examples<113>,  Prev: Modes and number of proofs<75>,  Up: predicate_property/2

2.5.3.14 Errors
...............

     ‘Predicate’ is a variable:
          ‘instantiation_error’
     ‘Predicate’ is neither a variable nor a callable term:
          ‘type_error(callable, Predicate)’
     ‘Property’ is neither a variable nor a valid predicate property:
          ‘domain_error(predicate_property, Property)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<113>,  Prev: Errors<76>,  Up: predicate_property/2

2.5.3.15 Examples
.................

     To enumerate, by backtracking, the properties of a locally visible user predicate or a user predicate visible in *note this: 114.:
          ‘predicate_property(Predicate, Property)’
     To enumerate, by backtracking, the properties of a public or protected predicate visible in *note self: 69.:
          ‘::predicate_property(Predicate, Property)’
     To enumerate, by backtracking, the properties of a public predicate visible in an explicit object:
          ‘Object::predicate_property(Predicate, Property)’

An example of enumerating properties for locally visible object
predicates.  These include predicates listed using *note uses/2: 4b. and
*note use_module/2: 4d. directives:

     :- object(foo).

         :- uses(bar, [
             baz/1, quux/2
         ]).

         :- public(pred/1).
         pred_prop(Pred, Prop) :-
            predicate_property(Pred, Prop).

     :- end_object.

     | ?- foo::pred(baz(_), Prop).
     Prop = logtalk ;
     Prop = scope(public) ;
     Prop = public ;
     Prop = declared_in(bar) ;
     ...

See also
........

*note current_op/3: 15e, *note current_predicate/1: 141, *note uses/2:
4b, *note use_module/2: 4d.


File: TheLogtalkHandbook-3.100.1.info,  Node: Database,  Next: Meta-calls,  Prev: Reflection<2>,  Up: Built-in methods<2>

2.5.4 Database
--------------

'built-in method'

* Menu:

* abolish/1::
* asserta/1::
* assertz/1::
* clause/2::
* retract/1::
* retractall/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: abolish/1,  Next: asserta/1,  Up: Database

2.5.4.1 ‘abolish/1’
...................

* Menu:

* Description: Description<113>.
* Modes and number of proofs: Modes and number of proofs<76>.
* Errors: Errors<77>.
* Examples: Examples<114>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<113>,  Next: Modes and number of proofs<76>,  Up: abolish/1

2.5.4.2 Description
...................

     abolish(Predicate)

Abolishes a runtime declared object dynamic predicate or an object local
dynamic predicate.  Only predicates that are dynamically declared at
runtime (using a call to the *note asserta/1: 1b2. or *note assertz/1:
1b3. built-in methods) can be abolished.

When the predicate indicator is declared in a *note uses/2: 4b. or *note
use_module/2: 4d. directive, the predicate is abolished in the
referenced object or module.  When the backend Prolog compiler supports
a module system, the predicate argument can also be module qualified.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<76>,  Next: Errors<77>,  Prev: Description<113>,  Up: abolish/1

2.5.4.3 Modes and number of proofs
..................................

     abolish(@predicate_indicator) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<77>,  Next: Examples<114>,  Prev: Modes and number of proofs<76>,  Up: abolish/1

2.5.4.4 Errors
..............

     ‘Predicate’ is a variable:
          ‘instantiation_error’
     ‘Functor’ is a variable:
          ‘instantiation_error’
     ‘Arity’ is a variable:
          ‘instantiation_error’
     ‘Predicate’ is neither a variable nor a valid predicate indicator:
          ‘type_error(predicate_indicator, Predicate)’
     ‘Functor’ is neither a variable nor an atom:
          ‘type_error(atom, Functor)’
     ‘Arity’ is neither a variable nor an integer:
          ‘type_error(integer, Arity)’
     ‘Predicate’ is statically declared:
          ‘permission_error(modify, predicate_declaration, Name/Arity)’
     ‘Predicate’ is a private predicate:
          ‘permission_error(modify, private_predicate, Name/Arity)’
     ‘Predicate’ is a protected predicate:
          ‘permission_error(modify, protected_predicate, Name/Arity)’
     ‘Predicate’ is a static predicate:
          ‘permission_error(modify, static_predicate, Name/Arity)’
     ‘Predicate’ is not declared for the object receiving the message:
          ‘existence_error(predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<114>,  Prev: Errors<77>,  Up: abolish/1

2.5.4.5 Examples
................

     To abolish a local dynamic predicate or a dynamic predicate in *note this: 114.:
          ‘abolish(Predicate)’
     To abolish a public or protected dynamic predicate in *note self: 69.:
          ‘::abolish(Predicate)’
     To abolish a public dynamic predicate in an explicit object:
          ‘Object::abolish(Predicate)’

See also
........

*note asserta/1: 1b2, *note assertz/1: 1b3, *note clause/2: 1b4, *note
retract/1: 1b5, *note retractall/1: 1b6. *note dynamic/0: b1, *note
dynamic/1: 15a, *note uses/2: 4b, *note use_module/2: 4d.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: asserta/1,  Next: assertz/1,  Prev: abolish/1,  Up: Database

2.5.4.6 ‘asserta/1’
...................

* Menu:

* Description: Description<114>.
* Modes and number of proofs: Modes and number of proofs<77>.
* Errors: Errors<78>.
* Examples: Examples<115>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<114>,  Next: Modes and number of proofs<77>,  Up: asserta/1

2.5.4.7 Description
...................

     asserta(Head)
     asserta((Head:-Body))

Asserts a clause as the first one for an object dynamic predicate.

When the predicate was not previously declared (using a scope
directive), a dynamic predicate declaration is added to the object.  In
this case, the predicate scope depends on how this method is called:

‘asserta(Clause)’

     The predicate is dynamically declared as *note private: 55.

‘::asserta(Clause)’

     The predicate is dynamically declared as *note protected: 54.

‘Object::asserta(Clause)’

     The predicate is dynamically declared as *note public: 53.

Note, however, that dynamically declaring a new predicate requires
either a local assert or the *note dynamic_declarations: 2d8. compiler
flag set to ‘allow’ when the object was created or compiled.

When the predicate indicator for ‘Head’ is declared in a *note uses/2:
4b. or *note use_module/2: 4d. directive, the clause is asserted in the
referenced object or module.  When the backend Prolog compiler supports
a module system, the predicate argument can also be module qualified.

This method may be used to assert clauses for predicates that are not
declared dynamic for dynamic objects provided that the predicates are
declared in *note this: 114.  This allows easy initialization of
dynamically created objects when writing constructors.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<77>,  Next: Errors<78>,  Prev: Description<114>,  Up: asserta/1

2.5.4.8 Modes and number of proofs
..................................

     asserta(+clause) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<78>,  Next: Examples<115>,  Prev: Modes and number of proofs<77>,  Up: asserta/1

2.5.4.9 Errors
..............

     ‘Head’ is a variable:
          ‘instantiation_error’
     ‘Head’ is neither a variable nor a callable term:
          ‘type_error(callable, Head)’
     ‘Body’ cannot be converted to a goal:
          ‘type_error(callable, Body)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a private predicate:
          ‘permission_error(modify, private_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a protected predicate:
          ‘permission_error(modify, protected_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a static predicate:
          ‘permission_error(modify, static_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, does not match a declared predicate and the target object was created or compiled with support for dynamic declaration of predicates turned off:
          ‘permission_error(create, predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<115>,  Prev: Errors<78>,  Up: asserta/1

2.5.4.10 Examples
.................

     To assert a clause as the first one for a local dynamic predicate or a dynamic predicate in *note this: 114.:
          ‘asserta(Clause)’
     To assert a clause as the first one for any public or protected dynamic predicate in *note self: 69.:
          ‘::asserta(Clause)’
     To assert a clause as the first one for any public dynamic predicate in an explicit object:
          ‘Object::asserta(Clause)’

An example of asserting clauses in *note this: 114. and in *note self:
69. from a category:

     :- category(attributes,
         implements(attributes_protocol)).

         :- private(attr_/1).
         :- dynamic(attr_/1).

         set_in_this(A, X) :-
            asserta(attr_(A, X)).

         set_in_self(A, X) :-
            ::asserta(attr_(A, X)).

         ...

An example of asserting clauses into another object with the predicates
listed using a *note uses/2: 4b. directive (similar when using a *note
use_module/2: 4d. directive):

     :- object(reasoner(_KnowledgeBase_)).

         :- uses(_KnowledgeBase_, [
             foo/1, bar/1
         ]).

         baz(X) :-
            % compiled as _KnowledgeBase_::assertz(foo(X))
            asserta(foo(X)).

        foobar(Name, Argument) :-
           Clause =.. [Name, Argument],
           % runtime resolved to _KnowledgeBase_::assertz(Clause)
           % when Name is either foo or bar
           asserta(Clause).

         ...

See also
........

*note abolish/1: 1b1, *note assertz/1: 1b3, *note clause/2: 1b4, *note
retract/1: 1b5, *note retractall/1: 1b6. *note dynamic/0: b1, *note
dynamic/1: 15a, *note uses/2: 4b, *note use_module/2: 4d.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: assertz/1,  Next: clause/2,  Prev: asserta/1,  Up: Database

2.5.4.11 ‘assertz/1’
....................

* Menu:

* Description: Description<115>.
* Modes and number of proofs: Modes and number of proofs<78>.
* Errors: Errors<79>.
* Examples: Examples<116>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<115>,  Next: Modes and number of proofs<78>,  Up: assertz/1

2.5.4.12 Description
....................

     assertz(Head)
     assertz((Head:-Body))

Asserts a clause as the last one for a dynamic predicate.

When the predicate was not previously declared (using a scope
directive), a dynamic predicate declaration is added to the object.  In
this case, the predicate scope depends on how this method is called:

‘assertz(Clause)’

     The predicate is dynamically declared as *note private: 55.

‘::assertz(Clause)’

     The predicate is dynamically declared as *note protected: 54.

‘Object::assertz(Clause)’

     The predicate is dynamically declared as *note public: 53.

Note, however, that dynamically declaring a new predicate requires
either a local assert or the *note dynamic_declarations: 2d8. compiler
flag set to ‘allow’ when the object was created or compiled.

When the predicate indicator for ‘Head’ is declared in a *note uses/2:
4b. or *note use_module/2: 4d. directive, the clause is asserted in the
referenced object or module.  When the backend Prolog compiler supports
a module system, the predicate argument can also be module qualified.

This method may be used to assert clauses for predicates that are not
declared dynamic for dynamic objects provided that the predicates are
declared in *note this: 114.  This allows easy initialization of
dynamically created objects when writing constructors.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<78>,  Next: Errors<79>,  Prev: Description<115>,  Up: assertz/1

2.5.4.13 Modes and number of proofs
...................................

     assertz(+clause) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<79>,  Next: Examples<116>,  Prev: Modes and number of proofs<78>,  Up: assertz/1

2.5.4.14 Errors
...............

     ‘Head’ is a variable:
          ‘instantiation_error’
     ‘Head’ is neither a variable nor a callable term:
          ‘type_error(callable, Head)’
     ‘Body’ cannot be converted to a goal:
          ‘type_error(callable, Body)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a private predicate:
          ‘permission_error(modify, private_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a protected predicate:
          ‘permission_error(modify, protected_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a static predicate:
          ‘permission_error(modify, static_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, does not match a declared predicate and the target object was created/compiled with support for dynamic declaration of predicates turned off:
          ‘permission_error(create, predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<116>,  Prev: Errors<79>,  Up: assertz/1

2.5.4.15 Examples
.................

     To assert a clause as the last one for a local dynamic predicate or a dynamic predicate in *note this: 114.:
          ‘assertz(Clause)’
     To assert a clause as the last one for any public or protected dynamic predicate in *note self: 69.:
          ‘::assertz(Clause)’
     To assert a clause as the last one for any public dynamic predicate in an explicit object:
          ‘Object::assertz(Clause)’

An example of asserting clauses in *note this: 114. and in *note self:
69. from a category:

     :- category(attributes,
         implements(attributes_protocol)).

         :- private(attr_/1).
         :- dynamic(attr_/1).

         set_in_this(A, X) :-
            assertz(attr_(A, X)).

         set_in_self(A, X) :-
            ::assertz(attr_(A, X)).

         ...

An example of asserting clauses into another object with the predicates
listed using a *note uses/2: 4b. directive (similar when using a *note
use_module/2: 4d. directive):

     :- object(reasoner(_KnowledgeBase_)).

         :- uses(_KnowledgeBase_, [
             foo/1, bar/1
         ]).

         baz(X) :-
            % compiled as _KnowledgeBase_::assertz(foo(X))
            assertz(foo(X)).

        foobar(Name, Argument) :-
           Clause =.. [Name, Argument],
           % runtime resolved to _KnowledgeBase_::assertz(Clause)
           % when Name is either foo or bar
           assertz(Clause).

         ...

See also
........

*note abolish/1: 1b1, *note asserta/1: 1b2, *note clause/2: 1b4, *note
retract/1: 1b5, *note retractall/1: 1b6. *note dynamic/0: b1, *note
dynamic/1: 15a, *note uses/2: 4b, *note use_module/2: 4d.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: clause/2,  Next: retract/1,  Prev: assertz/1,  Up: Database

2.5.4.16 ‘clause/2’
...................

* Menu:

* Description: Description<116>.
* Modes and number of proofs: Modes and number of proofs<79>.
* Errors: Errors<80>.
* Examples: Examples<117>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<116>,  Next: Modes and number of proofs<79>,  Up: clause/2

2.5.4.17 Description
....................

     clause(Head, Body)

Enumerates, by backtracking, the clauses of a dynamic predicate.

When the predicate indicator for ‘Head’ is declared in a *note uses/2:
4b. or *note use_module/2: 4d. directive, the predicate enumerates the
clauses in the referenced object or module.  When the backend Prolog
compiler supports a module system, the head argument can also be module
qualified.

This method may be used to enumerate clauses for predicates that are not
declared dynamic for dynamic objects provided that the predicates are
declared in *note this: 114.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<79>,  Next: Errors<80>,  Prev: Description<116>,  Up: clause/2

2.5.4.18 Modes and number of proofs
...................................

     clause(+callable, ?body) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<80>,  Next: Examples<117>,  Prev: Modes and number of proofs<79>,  Up: clause/2

2.5.4.19 Errors
...............

     ‘Head’ is a variable:
          ‘instantiation_error’
     ‘Head’ is neither a variable nor a callable term:
          ‘type_error(callable, Head)’
     ‘Body’ is neither a variable nor a callable term:
          ‘type_error(callable, Body)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a private predicate:
          ‘permission_error(access, private_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a protected predicate:
          ‘permission_error(access, protected_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a static predicate:
          ‘permission_error(access, static_predicate, Name/Arity)’
     ‘Head’ is not a declared predicate:
          ‘existence_error(predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<117>,  Prev: Errors<80>,  Up: clause/2

2.5.4.20 Examples
.................

     To retrieve a matching clause of a local dynamic predicate or a dynamic predicate in *note this: 114.:
          ‘clause(Head, Body)’
     To retrieve a matching clause of a public or protected dynamic predicate in *note self: 69.:
          ‘::clause(Head, Body)’
     To retrieve a matching clause of a public dynamic predicate in an explicit object:
          ‘Object::clause(Head, Body)’

See also
........

*note abolish/1: 1b1, *note asserta/1: 1b2, *note assertz/1: 1b3, *note
retract/1: 1b5, *note retractall/1: 1b6. *note dynamic/0: b1, *note
dynamic/1: 15a, *note uses/2: 4b, *note use_module/2: 4d.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: retract/1,  Next: retractall/1,  Prev: clause/2,  Up: Database

2.5.4.21 ‘retract/1’
....................

* Menu:

* Description: Description<117>.
* Modes and number of proofs: Modes and number of proofs<80>.
* Errors: Errors<81>.
* Examples: Examples<118>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<117>,  Next: Modes and number of proofs<80>,  Up: retract/1

2.5.4.22 Description
....................

     retract(Head)
     retract((Head:-Body))

Retracts a clause for an object dynamic predicate.  On backtracking, the
predicate retracts the next matching clause.

When the predicate indicator for ‘Head’ is declared in a *note uses/2:
4b. or *note use_module/2: 4d. directive, the clause is retracted in the
referenced object or module.  When the backend Prolog compiler supports
a module system, the predicate argument can also be module qualified.

This method may be used to retract clauses for predicates that are not
declared dynamic for dynamic objects provided that the predicates are
declared in *note this: 114.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<80>,  Next: Errors<81>,  Prev: Description<117>,  Up: retract/1

2.5.4.23 Modes and number of proofs
...................................

     retract(+clause) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<81>,  Next: Examples<118>,  Prev: Modes and number of proofs<80>,  Up: retract/1

2.5.4.24 Errors
...............

     ‘Head’ is a variable:
          ‘instantiation_error’
     ‘Head’ is neither a variable nor a callable term:
          ‘type_error(callable, Head)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a private predicate:
          ‘permission_error(modify, private_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a protected predicate:
          ‘permission_error(modify, protected_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a static predicate:
          ‘permission_error(modify, static_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is not declared:
          ‘existence_error(predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<118>,  Prev: Errors<81>,  Up: retract/1

2.5.4.25 Examples
.................

     To retract a matching clause of a dynamic predicate in *note this: 114.:
          ‘retract(Clause)’
     To retract a matching clause of a public or protected dynamic predicate in *note self: 69.:
          ‘::retract(Clause)’
     To retract a matching clause of a public dynamic predicate in an explicit object:
          ‘Object::retract(Clause)’

See also
........

*note abolish/1: 1b1, *note asserta/1: 1b2, *note assertz/1: 1b3, *note
clause/2: 1b4, *note retractall/1: 1b6, *note dynamic/0: b1, *note
dynamic/1: 15a, *note uses/2: 4b, *note use_module/2: 4d.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: retractall/1,  Prev: retract/1,  Up: Database

2.5.4.26 ‘retractall/1’
.......................

* Menu:

* Description: Description<118>.
* Modes and number of proofs: Modes and number of proofs<81>.
* Errors: Errors<82>.
* Examples: Examples<119>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<118>,  Next: Modes and number of proofs<81>,  Up: retractall/1

2.5.4.27 Description
....................

     retractall(Head)

Retracts all clauses with a matching head for an object dynamic
predicate.

When the predicate indicator for ‘Head’ is declared in a *note uses/2:
4b. or *note use_module/2: 4d. directive, the clauses are retracted in
the referenced object or module.  When the backend Prolog compiler
supports a module system, the predicate argument can also be module
qualified.

This method may be used to retract clauses for predicates that are not
declared dynamic for dynamic objects provided that the predicates are
declared in *note this: 114.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<81>,  Next: Errors<82>,  Prev: Description<118>,  Up: retractall/1

2.5.4.28 Modes and number of proofs
...................................

     retractall(@callable) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<82>,  Next: Examples<119>,  Prev: Modes and number of proofs<81>,  Up: retractall/1

2.5.4.29 Errors
...............

     ‘Head’ is a variable:
          ‘instantiation_error’
     ‘Head’ is neither a variable nor a callable term:
          ‘type_error(callable, Head)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a private predicate:
          ‘permission_error(modify, private_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a protected predicate:
          ‘permission_error(modify, protected_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is that of a static predicate:
          ‘permission_error(modify, static_predicate, Name/Arity)’
     The predicate indicator of ‘Head’, ‘Name/Arity’, is not declared:
          ‘existence_error(predicate_declaration, Name/Arity)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<119>,  Prev: Errors<82>,  Up: retractall/1

2.5.4.30 Examples
.................

     To retract all clauses with a matching head of a dynamic predicate in *note this: 114.:
          ‘retractall(Head)’
     To retract all clauses with a matching head of a public or protected dynamic predicate in *note self: 69.:
          ‘::retractall(Head)’
     To retract all clauses with a matching head of a public dynamic predicate in an explicit object:
          ‘Object::retractall(Head)’

See also
........

*note abolish/1: 1b1, *note asserta/1: 1b2, *note assertz/1: 1b3, *note
clause/2: 1b4, *note retract/1: 1b5, *note dynamic/0: b1, *note
dynamic/1: 15a, *note uses/2: 4b, *note use_module/2: 4d.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-calls,  Next: Error handling<2>,  Prev: Database,  Up: Built-in methods<2>

2.5.5 Meta-calls
----------------

'built-in method'

* Menu:

* call/1-N::
* ignore/1::
* once/1::
* (\+)/1: \+ /1.


File: TheLogtalkHandbook-3.100.1.info,  Node: call/1-N,  Next: ignore/1,  Up: Meta-calls

2.5.5.1 ‘call/1-N’
..................

* Menu:

* Description: Description<119>.
* Meta-predicate template: Meta-predicate template<6>.
* Modes and number of proofs: Modes and number of proofs<82>.
* Errors: Errors<83>.
* Examples: Examples<120>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<119>,  Next: Meta-predicate template<6>,  Up: call/1-N

2.5.5.2 Description
...................

     call(Goal)
     call(Closure, Arg1, ...)

Calls a goal constructed by appending additional arguments to a *note
closure: 14f.  The upper limit for ‘N’ depends on the upper limit for
the arity of a compound term of the *note backend Prolog compiler: 34.
This built-in meta-predicate is declared as a private method and thus
cannot be used as a message to an object.  The ‘Closure’ argument can
also be a lambda expression or a Logtalk control construct.  When using
a backend Prolog compiler supporting a module system, calls in the
format ‘call(Module:Closure, Arg1, ...)’ may also be used.

This meta-predicate is opaque to cuts in its arguments.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<6>,  Next: Modes and number of proofs<82>,  Prev: Description<119>,  Up: call/1-N

2.5.5.3 Meta-predicate template
...............................

     call(0)
     call(1, *)
     call(2, *, *)
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<82>,  Next: Errors<83>,  Prev: Meta-predicate template<6>,  Up: call/1-N

2.5.5.4 Modes and number of proofs
..................................

     call(+callable) - zero_or_more
     call(+callable, ?term) - zero_or_more
     call(+callable, ?term, ?term) - zero_or_more
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<83>,  Next: Examples<120>,  Prev: Modes and number of proofs<82>,  Up: call/1-N

2.5.5.5 Errors
..............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     ‘Closure’ is a variable:
          ‘instantiation_error’
     ‘Closure’ is neither a variable nor a callable term:
          ‘type_error(callable, Closure)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<120>,  Prev: Errors<83>,  Up: call/1-N

2.5.5.6 Examples
................

     Call a goal, constructed by appending additional arguments to a closure, in the context of the object or category containing the call:
          ‘call(Closure, Arg1, Arg2, ...)’
     To send a goal, constructed by appending additional arguments to a closure, as a message to *note self: 69.:
          ‘call(::Closure, Arg1, Arg2, ...)’
     To send a goal, constructed by appending additional arguments to a closure, as a message to an explicit object:
          ‘call(Object::Closure, Arg1, Arg2, ...)’

See also
........

*note ignore/1: 180, *note once/1: 1bb, *note (\+)/1: 1bc.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: ignore/1,  Next: once/1,  Prev: call/1-N,  Up: Meta-calls

2.5.5.7 ‘ignore/1’
..................

* Menu:

* Description: Description<120>.
* Meta-predicate template: Meta-predicate template<7>.
* Modes and number of proofs: Modes and number of proofs<83>.
* Errors: Errors<84>.
* Examples: Examples<121>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<120>,  Next: Meta-predicate template<7>,  Up: ignore/1

2.5.5.8 Description
...................

     ignore(Goal)

This predicate succeeds whether its argument succeeds or fails and it is
not re-executable.  This built-in meta-predicate is declared as a
private method and thus cannot be used as a message to an object.

This meta-predicate is opaque to cuts in its argument.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<7>,  Next: Modes and number of proofs<83>,  Prev: Description<120>,  Up: ignore/1

2.5.5.9 Meta-predicate template
...............................

     ignore(0)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<83>,  Next: Errors<84>,  Prev: Meta-predicate template<7>,  Up: ignore/1

2.5.5.10 Modes and number of proofs
...................................

     ignore(+callable) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<84>,  Next: Examples<121>,  Prev: Modes and number of proofs<83>,  Up: ignore/1

2.5.5.11 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<121>,  Prev: Errors<84>,  Up: ignore/1

2.5.5.12 Examples
.................

     Call a goal and succeeding even if it fails:
          ‘ignore(Goal)’
     To send a message succeeding even if it fails to *note self: 69.:
          ‘ignore(::Goal)’
     To send a message succeeding even if it fails to an explicit object:
          ‘ignore(Object::Goal)’

See also
........

*note call/1-N: 181, *note once/1: 1bb, *note (\+)/1: 1bc.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: once/1,  Next: \+ /1,  Prev: ignore/1,  Up: Meta-calls

2.5.5.13 ‘once/1’
.................

* Menu:

* Description: Description<121>.
* Meta-predicate template: Meta-predicate template<8>.
* Modes and number of proofs: Modes and number of proofs<84>.
* Errors: Errors<85>.
* Examples: Examples<122>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<121>,  Next: Meta-predicate template<8>,  Up: once/1

2.5.5.14 Description
....................

     once(Goal)

This predicate behaves as ‘call(Goal)’ but it is not re-executable.
This built-in meta-predicate is declared as a private method and thus
cannot be used as a message to an object.

This meta-predicate is opaque to cuts in its argument.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<8>,  Next: Modes and number of proofs<84>,  Prev: Description<121>,  Up: once/1

2.5.5.15 Meta-predicate template
................................

     once(0)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<84>,  Next: Errors<85>,  Prev: Meta-predicate template<8>,  Up: once/1

2.5.5.16 Modes and number of proofs
...................................

     once(+callable) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<85>,  Next: Examples<122>,  Prev: Modes and number of proofs<84>,  Up: once/1

2.5.5.17 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<122>,  Prev: Errors<85>,  Up: once/1

2.5.5.18 Examples
.................

     Call a goal deterministically in the context of the object or category containing the call:
          ‘once(Goal)’
     To send a goal as a non-backtracable message to *note self: 69.:
          ‘once(::Goal)’
     To send a goal as a non-backtracable message to an explicit object:
          ‘once(Object::Goal)’

See also
........

*note call/1-N: 181, *note ignore/1: 180, *note (\+)/1: 1bc.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: \+ /1,  Prev: once/1,  Up: Meta-calls

2.5.5.19 ‘(\+)/1’
.................

* Menu:

* Description: Description<122>.
* Meta-predicate template: Meta-predicate template<9>.
* Modes and number of proofs: Modes and number of proofs<85>.
* Errors: Errors<86>.
* Examples: Examples<123>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<122>,  Next: Meta-predicate template<9>,  Up: \+ /1

2.5.5.20 Description
....................

     \+ Goal

Not-provable meta-predicate.  True iff ‘call(Goal)’ is false.  This
built-in meta-predicate is declared as a private method and thus cannot
be used as a message to an object.

     Warning: The argument is always compiled (for improved
     performance).  As a consequence, when the argument is a control
     construct (e.g., a conjunction), any meta-variables will be wrapped
     with the equivalent to the ‘call/1’ control construct.  Note that
     these semantics differ from the ISO Prolog Core standard
     specification for the ‘(\+)/1’ built-in predicate.  For example,
     assuming a conforming system:

          | ?- X = !, \+ (member(Y,[1,2,3]), X, write(Y), fail).
          1

          X = !

     But in Logtalk ‘X’ is compiled into a meta-call, which is not
     cut-transparent:

          yes
          | ?- logtalk << (X = !, \+ (member(Y,[1,2,3]), X, write(Y), fail)).
          123

          X = !

     Note that the ISO Prolog Core standard doesn’t specify a
     cut-transparent alternative to the ‘call/1’ control construct.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<9>,  Next: Modes and number of proofs<85>,  Prev: Description<122>,  Up: \+ /1

2.5.5.21 Meta-predicate template
................................

     \+ 0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<85>,  Next: Errors<86>,  Prev: Meta-predicate template<9>,  Up: \+ /1

2.5.5.22 Modes and number of proofs
...................................

     \+ +callable - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<86>,  Next: Examples<123>,  Prev: Modes and number of proofs<85>,  Up: \+ /1

2.5.5.23 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<123>,  Prev: Errors<86>,  Up: \+ /1

2.5.5.24 Examples
.................

     Not-provable goal in the context of the object or category containing the call:
          ‘\+ Goal’
     Not-provable goal sent as a message to *note self: 69.:
          ‘\+ ::Goal’
     Not-provable goal sent as a message to an explicit object:
          ‘\+ Object::Goal’

See also
........

*note call/1-N: 181, *note ignore/1: 180, *note once/1: 1bb.


File: TheLogtalkHandbook-3.100.1.info,  Node: Error handling<2>,  Next: All solutions,  Prev: Meta-calls,  Up: Built-in methods<2>

2.5.6 Error handling
--------------------

'built-in method'

* Menu:

* catch/3::
* throw/1::
* instantiation_error/0::
* uninstantiation_error/1::
* type_error/2::
* domain_error/2::
* consistency_error/3::
* existence_error/2::
* permission_error/3::
* representation_error/1::
* evaluation_error/1::
* resource_error/1::
* syntax_error/1::
* system_error/0::


File: TheLogtalkHandbook-3.100.1.info,  Node: catch/3,  Next: throw/1,  Up: Error handling<2>

2.5.6.1 ‘catch/3’
.................

* Menu:

* Description: Description<123>.
* Modes and number of proofs: Modes and number of proofs<86>.
* Errors: Errors<87>.
* Examples: Examples<124>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<123>,  Next: Modes and number of proofs<86>,  Up: catch/3

2.5.6.2 Description
...................

     catch(Goal, Catcher, Recovery)

Catches exceptions thrown by a goal.  See also the ISO Prolog standard
definition.  This built-in meta-predicate is declared as a private
method and thus cannot be used as a message to an object.

This method can also be used in grammar rules.  In this case, the
meta-arguments are interpreted as grammar rule bodies.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<86>,  Next: Errors<87>,  Prev: Description<123>,  Up: catch/3

2.5.6.3 Modes and number of proofs
..................................

     catch(?callable, ?term, ?callable) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<87>,  Next: Examples<124>,  Prev: Modes and number of proofs<86>,  Up: catch/3

2.5.6.4 Errors
..............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<124>,  Prev: Errors<87>,  Up: catch/3

2.5.6.5 Examples
................

(none)

See also
........

*note throw/1: 1a2, *note context/1: 19e, *note instantiation_error/0:
1a3, *note uninstantiation_error/1: 1a4, *note type_error/2: 1a5, *note
domain_error/2: 1a6, *note consistency_error/3: 718, *note
existence_error/2: 1a7, *note permission_error/3: 1a8, *note
evaluation_error/1: 1aa, *note representation_error/1: 1a9. *note
resource_error/1: 1ab, *note syntax_error/1: 1ac, *note system_error/0:
1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: throw/1,  Next: instantiation_error/0,  Prev: catch/3,  Up: Error handling<2>

2.5.6.6 ‘throw/1’
.................

* Menu:

* Description: Description<124>.
* Modes and number of proofs: Modes and number of proofs<87>.
* Errors: Errors<88>.
* Examples: Examples<125>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<124>,  Next: Modes and number of proofs<87>,  Up: throw/1

2.5.6.7 Description
...................

     throw(Exception)

Throws an exception.  See also the ISO Prolog standard definition.  This
built-in method is declared private and thus cannot be used as a message
to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<87>,  Next: Errors<88>,  Prev: Description<124>,  Up: throw/1

2.5.6.8 Modes and number of proofs
..................................

     throw(+nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<88>,  Next: Examples<125>,  Prev: Modes and number of proofs<87>,  Up: throw/1

2.5.6.9 Errors
..............

     ‘Exception’ is a variable:
          ‘instantiation_error’
     ‘Exception’ does not unify with the second argument of any call of *note catch/3: 1a1.:
          ‘system_error’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<125>,  Prev: Errors<88>,  Up: throw/1

2.5.6.10 Examples
.................

(none)

See also
........

*note catch/3: 1a1, *note context/1: 19e, *note instantiation_error/0:
1a3, *note uninstantiation_error/1: 1a4, *note type_error/2: 1a5, *note
domain_error/2: 1a6, *note consistency_error/3: 718, *note
existence_error/2: 1a7, *note permission_error/3: 1a8, *note
evaluation_error/1: 1aa, *note representation_error/1: 1a9. *note
resource_error/1: 1ab, *note syntax_error/1: 1ac, *note system_error/0:
1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: instantiation_error/0,  Next: uninstantiation_error/1,  Prev: throw/1,  Up: Error handling<2>

2.5.6.11 ‘instantiation_error/0’
................................

* Menu:

* Description: Description<125>.
* Modes and number of proofs: Modes and number of proofs<88>.
* Errors: Errors<89>.
* Examples: Examples<126>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<125>,  Next: Modes and number of proofs<88>,  Up: instantiation_error/0

2.5.6.12 Description
....................

     instantiation_error

Throws an instantiation error.  Used when an argument or one of its
sub-arguments is a variable but a non-variable term is required.  For
example, trying to open a file with a variable for the input/output
mode.

This built-in method is declared private and thus cannot be used as a
message to an object.  Calling this predicate is equivalent to the
following sequence of calls:

     ...,
     context(Context),
     throw(error(instantiation_error, Context)).

This allows the user to generate errors in the same format used by the
runtime.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<88>,  Next: Errors<89>,  Prev: Description<125>,  Up: instantiation_error/0

2.5.6.13 Modes and number of proofs
...................................

     instantiation_error - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<89>,  Next: Examples<126>,  Prev: Modes and number of proofs<88>,  Up: instantiation_error/0

2.5.6.14 Errors
...............

     When called:
          ‘instantiation_error’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<126>,  Prev: Errors<89>,  Up: instantiation_error/0

2.5.6.15 Examples
.................

     ...,
     var(Handler),
     instantiation_error.

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
uninstantiation_error/1: 1a4, *note type_error/2: 1a5, *note
domain_error/2: 1a6, *note consistency_error/3: 718, *note
existence_error/2: 1a7, *note permission_error/3: 1a8, *note
representation_error/1: 1a9, *note evaluation_error/1: 1aa, *note
resource_error/1: 1ab, *note syntax_error/1: 1ac, *note system_error/0:
1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: uninstantiation_error/1,  Next: type_error/2,  Prev: instantiation_error/0,  Up: Error handling<2>

2.5.6.16 ‘uninstantiation_error/1’
..................................

* Menu:

* Description: Description<126>.
* Modes and number of proofs: Modes and number of proofs<89>.
* Errors: Errors<90>.
* Examples: Examples<127>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<126>,  Next: Modes and number of proofs<89>,  Up: uninstantiation_error/1

2.5.6.17 Description
....................

     uninstantiation_error(Culprit)

Throws an uninstantiation error.  Used when an argument or one of its
sub-arguments is bound but a variable is required.  For example, trying
to open a file with a stream argument bound.

This built-in method is declared private and thus cannot be used as a
message to an object.  Calling this predicate is equivalent to the
following sequence of calls:

     ...,
     context(Context),
     throw(error(uninstantiation_error(Culprit), Context)).

This allows the user to generate errors in the same format used by the
runtime.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<89>,  Next: Errors<90>,  Prev: Description<126>,  Up: uninstantiation_error/1

2.5.6.18 Modes and number of proofs
...................................

     uninstantiation_error(@nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<90>,  Next: Examples<127>,  Prev: Modes and number of proofs<89>,  Up: uninstantiation_error/1

2.5.6.19 Errors
...............

     When called:
          ‘uninstantiation_error(Culprit)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<127>,  Prev: Errors<90>,  Up: uninstantiation_error/1

2.5.6.20 Examples
.................

     ...,
     var(Handler),
     uninstantiation_error(my_stream).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note type_error/2: 1a5, *note
domain_error/2: 1a6, *note consistency_error/3: 718, *note
existence_error/2: 1a7, *note permission_error/3: 1a8, *note
representation_error/1: 1a9, *note evaluation_error/1: 1aa, *note
resource_error/1: 1ab, *note syntax_error/1: 1ac, *note system_error/0:
1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: type_error/2,  Next: domain_error/2,  Prev: uninstantiation_error/1,  Up: Error handling<2>

2.5.6.21 ‘type_error/2’
.......................

* Menu:

* Description: Description<127>.
* Modes and number of proofs: Modes and number of proofs<90>.
* Errors: Errors<91>.
* Examples: Examples<128>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<127>,  Next: Modes and number of proofs<90>,  Up: type_error/2

2.5.6.22 Description
....................

     type_error(Type, Culprit)

Throws a type error.  Used when the type of an argument is incorrect.
For example, trying to use a non-callable term as a message.  This
built-in method is declared private and thus cannot be used as a message
to an object.  Calling this predicate is equivalent to the following
sequence of goals:

     ...,
     context(Context),
     throw(error(type_error(Type,Culprit), Context)).

This allows the user to generate errors in the same format used by the
runtime.

Possible values for ‘Type’ include all the types defined by the ‘type’
library object and by other libraries such as ‘os’, ‘expecteds’, and
‘optionals’.  The value of ‘Culprit’ is the argument or one of its
sub-terms that caused the error.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<90>,  Next: Errors<91>,  Prev: Description<127>,  Up: type_error/2

2.5.6.23 Modes and number of proofs
...................................

     type_error(@nonvar, @term) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<91>,  Next: Examples<128>,  Prev: Modes and number of proofs<90>,  Up: type_error/2

2.5.6.24 Errors
...............

     When called:
          ‘type_error(Type, Culprit)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<128>,  Prev: Errors<91>,  Up: type_error/2

2.5.6.25 Examples
.................

     ...,
     \+ atom(Name),
     type_error(atom, Name).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
domain_error/2: 1a6, *note consistency_error/3: 718, *note
existence_error/2: 1a7, *note permission_error/3: 1a8, *note
representation_error/1: 1a9. *note evaluation_error/1: 1aa, *note
resource_error/1: 1ab, *note syntax_error/1: 1ac, *note system_error/0:
1ad,

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: domain_error/2,  Next: consistency_error/3,  Prev: type_error/2,  Up: Error handling<2>

2.5.6.26 ‘domain_error/2’
.........................

* Menu:

* Description: Description<128>.
* Modes and number of proofs: Modes and number of proofs<91>.
* Errors: Errors<92>.
* Examples: Examples<129>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<128>,  Next: Modes and number of proofs<91>,  Up: domain_error/2

2.5.6.27 Description
....................

     domain_error(Domain, Culprit)

Throws a domain error.  Used when an argument is of the correct type but
outside the valid domain.  For example, trying to use an atom as an
operator specifier that is not a valid specifier.  This built-in method
is declared private and thus cannot be used as a message to an object.
Calling this predicate is equivalent to the following sequence of goals:

     ...,
     context(Context),
     throw(error(domain_error(Domain,Culprit), Context)).

This allows the user to generate errors in the same format used by the
runtime.

Possible values for ‘Domain’ include:

   - ‘character_code_list’

   - ‘close_option’

   - ‘flag_option’

   - ‘flag_value’

   - ‘compiler_flag’

   - ‘flag’

   - ‘prolog_flag’

   - ‘io_mode’

   - ‘non_empty_list’

   - ‘not_less_than_zero’

   - ‘operator_priority’

   - ‘operator_specifier’

   - ‘read_option’

   - ‘source_sink’

   - ‘stream’

   - ‘stream_option’

   - ‘stream_or_alias’

   - ‘stream_position’

   - ‘stream_property’

   - ‘write_option’

   - ‘character_code_list’

   - ‘text_encoding’

   - ‘directive’

   - ‘object_directive’

   - ‘protocol_directive’

   - ‘category_directive’

   - ‘object_relation’

   - ‘protocol_relation’

   - ‘category_relation’

   - ‘object_property’

   - ‘protocol_property’

   - ‘category_property’

   - ‘predicate_property’

   - ‘meta_argument_specifier’

   - ‘meta_directive_template’

   - ‘closure’

   - ‘allocation’

   - ‘redefinition’

   - ‘message_sending_goal’

   - ‘class’

   - ‘prototype’

   - ‘scope’

   - ‘boolean’

The value of ‘Culprit’ is the argument or one of its sub-terms that
caused the error.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<91>,  Next: Errors<92>,  Prev: Description<128>,  Up: domain_error/2

2.5.6.28 Modes and number of proofs
...................................

     domain_error(+atom, @nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<92>,  Next: Examples<129>,  Prev: Modes and number of proofs<91>,  Up: domain_error/2

2.5.6.29 Errors
...............

     When called:
          ‘domain_error(Domain, Culprit)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<129>,  Prev: Errors<92>,  Up: domain_error/2

2.5.6.30 Examples
.................

     ...,
     atom(Color),
     \+ color(Color),
     domain_error(color, Color).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note consistency_error/3: 718, *note
existence_error/2: 1a7, *note permission_error/3: 1a8, *note
representation_error/1: 1a9, *note evaluation_error/1: 1aa, *note
resource_error/1: 1ab, *note syntax_error/1: 1ac, *note system_error/0:
1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: consistency_error/3,  Next: existence_error/2,  Prev: domain_error/2,  Up: Error handling<2>

2.5.6.31 ‘consistency_error/3’
..............................

* Menu:

* Description: Description<129>.
* Modes and number of proofs: Modes and number of proofs<92>.
* Errors: Errors<93>.
* Examples: Examples<130>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<129>,  Next: Modes and number of proofs<92>,  Up: consistency_error/3

2.5.6.32 Description
....................

     consistency_error(Consistency, Argument1, Argument2)

Throws a consistency error.  Used when two directives or predicate
arguments are individually correct but together are not consistent.  For
example, a predicate and its alias having different arity in a ‘uses/2’
directive.  This built-in method is declared private and thus cannot be
used as a message to an object.  Calling this predicate is equivalent to
the following sequence of goals:

     ...,
     context(Context),
     throw(error(consistency_error(Consistency,Argument1,Argument2), Context)).

This allows the user to generate errors in the same format used by the
runtime.

Possible values representing ‘Consistency’ checks include:

   - ‘same_arity’

   - ‘same_number_of_parameters’

   - ‘same_number_of_arguments’

   - ‘same_closure_specification’


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<92>,  Next: Errors<93>,  Prev: Description<129>,  Up: consistency_error/3

2.5.6.33 Modes and number of proofs
...................................

     consistency_error(+atom, @nonvar, @nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<93>,  Next: Examples<130>,  Prev: Modes and number of proofs<92>,  Up: consistency_error/3

2.5.6.34 Errors
...............

     When called:
          ‘consistency_error(Consistency, Argument1, Argument2)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<130>,  Prev: Errors<93>,  Up: consistency_error/3

2.5.6.35 Examples
.................

     % code that will trigger consistency errors when compiled:

     % predicates (and non-terminals) aliases must have the same
     % arity as the original predicates (and non-terminals)
     :- uses(list, [
         member/2 as in/1
     ]).

     % meta-predicate templates should be consistent with how closures
     % are used regarding the number of additional arguments
     :- public(p/2).
     :- meta_predicate(p(1, *)).

     p(G, A) :-
         call(G, A, 2).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note existence_error/2:
1a7, *note permission_error/3: 1a8, *note representation_error/1: 1a9,
*note evaluation_error/1: 1aa, *note resource_error/1: 1ab, *note
syntax_error/1: 1ac, *note system_error/0: 1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: existence_error/2,  Next: permission_error/3,  Prev: consistency_error/3,  Up: Error handling<2>

2.5.6.36 ‘existence_error/2’
............................

* Menu:

* Description: Description<130>.
* Modes and number of proofs: Modes and number of proofs<93>.
* Errors: Errors<94>.
* Examples: Examples<131>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<130>,  Next: Modes and number of proofs<93>,  Up: existence_error/2

2.5.6.37 Description
....................

     existence_error(Thing, Culprit)

Throws an existence error.  Used when the subject of an operation does
not exist.  This built-in method is declared private and thus cannot be
used as a message to an object.  Calling this predicate is equivalent to
the following sequence of goals:

     ...,
     context(Context),
     throw(error(existence_error(Thing,Culprit), Context)).

This allows the user to generate errors in the same format used by the
runtime.

Possible values for ‘Thing’ include:

   - ‘predicate’

   - ‘non_terminal’

   - ‘predicate_declaration’

   - ‘procedure’

   - ‘source_sink’

   - ‘stream’

   - ‘object’

   - ‘protocol’

   - ‘category’

   - ‘module’

   - ‘ancestor’

   - ‘library’

   - ‘file’

   - ‘directive’

   - ‘engine’

   - ‘thread’

   - ‘goal_thread’

The value of ‘Culprit’ is the argument or one of its sub-terms that
caused the error.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<93>,  Next: Errors<94>,  Prev: Description<130>,  Up: existence_error/2

2.5.6.38 Modes and number of proofs
...................................

     existence_error(@nonvar, @nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<94>,  Next: Examples<131>,  Prev: Modes and number of proofs<93>,  Up: existence_error/2

2.5.6.39 Errors
...............

     When called:
          ‘existence_error(Thing, Culprit)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<131>,  Prev: Errors<94>,  Up: existence_error/2

2.5.6.40 Examples
.................

     ...,
     \+ current_object(payroll),
     existence_error(object, payroll).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note consistency_error/3:
718, *note evaluation_error/1: 1aa, *note permission_error/3: 1a8, *note
representation_error/1: 1a9, *note resource_error/1: 1ab, *note
syntax_error/1: 1ac, *note system_error/0: 1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: permission_error/3,  Next: representation_error/1,  Prev: existence_error/2,  Up: Error handling<2>

2.5.6.41 ‘permission_error/3’
.............................

* Menu:

* Description: Description<131>.
* Modes and number of proofs: Modes and number of proofs<94>.
* Errors: Errors<95>.
* Examples: Examples<132>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<131>,  Next: Modes and number of proofs<94>,  Up: permission_error/3

2.5.6.42 Description
....................

     permission_error(Operation, PermissionType, Culprit)

Throws a permission error.  Used when an operation is not allowed.  For
example, sending a message for a predicate that is not within the scope
of the sender.  This built-in method is declared private and thus cannot
be used as a message to an object.  Calling this predicate is equivalent
to the following sequence of goals:

     ...,
     context(Context),
     throw(error(permission_error(Operation,PermissionType,Culprit), Context)).

This allows the user to generate errors in the same format used by the
runtime.

Possible values for ‘Operation’ include:

   - ‘access’

   - ‘create’

   - ‘declare’

   - ‘define’

   - ‘modify’

   - ‘open’

   - ‘input’

   - ‘output’

   - ‘reposition’

   - ‘repeat’

Possible values for ‘PermissionType’ include:

   - ‘predicate_declaration’

   - ‘protected_predicate’

   - ‘private_predicate’

   - ‘static_predicate’

   - ‘dynamic_predicate’

   - ‘predicate’

   - ‘non_terminal’

   - ‘database’

   - ‘object’

   - ‘static_object’

   - ‘static_protocol’

   - ‘static_category’

   - ‘entity_relation’

   - ‘operator’

   - ‘flag’

   - ‘engine’

   - ‘binary_stream’

   - ‘text_stream’

   - ‘source_sink’

   - ‘stream’

   - ‘past_end_of_stream’

The value of ‘Culprit’ is the argument or one of its sub-terms that
caused the error.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<94>,  Next: Errors<95>,  Prev: Description<131>,  Up: permission_error/3

2.5.6.43 Modes and number of proofs
...................................

     permission_error(@nonvar, @nonvar, @nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<95>,  Next: Examples<132>,  Prev: Modes and number of proofs<94>,  Up: permission_error/3

2.5.6.44 Errors
...............

     When called:
          ‘permission_error(Operation, PermissionType, Culprit)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<132>,  Prev: Errors<95>,  Up: permission_error/3

2.5.6.45 Examples
.................

     ...,
     \+ writable(File),
     permission_error(modify, file, File).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note consistency_error/3:
718, *note existence_error/2: 1a7, *note representation_error/1: 1a9,
*note evaluation_error/1: 1aa, *note resource_error/1: 1ab, *note
syntax_error/1: 1ac, *note system_error/0: 1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: representation_error/1,  Next: evaluation_error/1,  Prev: permission_error/3,  Up: Error handling<2>

2.5.6.46 ‘representation_error/1’
.................................

* Menu:

* Description: Description<132>.
* Modes and number of proofs: Modes and number of proofs<95>.
* Errors: Errors<96>.
* Examples: Examples<133>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<132>,  Next: Modes and number of proofs<95>,  Up: representation_error/1

2.5.6.47 Description
....................

     representation_error(Flag)

Throws a representation error.  Used when some representation limit is
exceeded.  For example, trying to construct a compound term that exceeds
the maximum arity supported by the backend Prolog system.  This built-in
method is declared private and thus cannot be used as a message to an
object.  Calling this predicate is equivalent to the following sequence
of goals:

     ...,
     context(Context),
     throw(error(representation_error(Flag), Context)).

This allows the user to generate errors in the same format used by the
runtime.

Possible values for ‘Flag’ include:

   - ‘character’

   - ‘character_code’

   - ‘in_character_code’

   - ‘max_arity’

   - ‘max_integer’

   - ‘min_integer’

   - ‘acyclic_term’

   - ‘lambda_parameters’

   - ‘entity_prefix’


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<95>,  Next: Errors<96>,  Prev: Description<132>,  Up: representation_error/1

2.5.6.48 Modes and number of proofs
...................................

     representation_error(+atom) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<96>,  Next: Examples<133>,  Prev: Modes and number of proofs<95>,  Up: representation_error/1

2.5.6.49 Errors
...............

     When called:
          ‘representation_error(Flag)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<133>,  Prev: Errors<96>,  Up: representation_error/1

2.5.6.50 Examples
.................

     ...,
     Code > 127,
     representation_error(character_code).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note consistency_error/3:
718, *note existence_error/2: 1a7, *note permission_error/3: 1a8, *note
evaluation_error/1: 1aa, *note resource_error/1: 1ab, *note
syntax_error/1: 1ac, *note system_error/0: 1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: evaluation_error/1,  Next: resource_error/1,  Prev: representation_error/1,  Up: Error handling<2>

2.5.6.51 ‘evaluation_error/1’
.............................

* Menu:

* Description: Description<133>.
* Modes and number of proofs: Modes and number of proofs<96>.
* Errors: Errors<97>.
* Examples: Examples<134>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<133>,  Next: Modes and number of proofs<96>,  Up: evaluation_error/1

2.5.6.52 Description
....................

     evaluation_error(Error)

Throws an evaluation error.  Used when evaluating an arithmetic
expression generates an exception.  This built-in method is declared
private and thus cannot be used as a message to an object.  Calling this
predicate is equivalent to the following sequence of goals:

     ...,
     context(Context),
     throw(error(evaluation_error(Error), Context)).

This allows the user to generate errors in the same format used by the
runtime.

Possible values for ‘Error’ include:

   - ‘float_overflow’

   - ‘int_overflow’

   - ‘undefined’

   - ‘underflow’

   - ‘zero_divisor’


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<96>,  Next: Errors<97>,  Prev: Description<133>,  Up: evaluation_error/1

2.5.6.53 Modes and number of proofs
...................................

     evaluation_error(@nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<97>,  Next: Examples<134>,  Prev: Modes and number of proofs<96>,  Up: evaluation_error/1

2.5.6.54 Errors
...............

     When called:
          ‘evaluation_error(Exception)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<134>,  Prev: Errors<97>,  Up: evaluation_error/1

2.5.6.55 Examples
.................

     ...,
     Divisor =:= 0,
     evaluation_error(zero_divisor).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note consistency_error/3:
718, *note existence_error/2: 1a7, *note permission_error/3: 1a8, *note
representation_error/1: 1a9, *note resource_error/1: 1ab, *note
syntax_error/1: 1ac, *note system_error/0: 1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: resource_error/1,  Next: syntax_error/1,  Prev: evaluation_error/1,  Up: Error handling<2>

2.5.6.56 ‘resource_error/1’
...........................

* Menu:

* Description: Description<134>.
* Modes and number of proofs: Modes and number of proofs<97>.
* Errors: Errors<98>.
* Examples: Examples<135>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<134>,  Next: Modes and number of proofs<97>,  Up: resource_error/1

2.5.6.57 Description
....................

     resource_error(Resource)

Throws a resource error.  Used when a required resource (e.g., memory or
disk space) to complete execution is not available.  This built-in
method is declared private and thus cannot be used as a message to an
object.  Calling this predicate is equivalent to the following sequence
of goals:

     ...,
     context(Context),
     throw(error(resource_error(Resource), Context)).

This allows the user to generate errors in the same format used by the
runtime.

Possible values for ‘Resource’ include:

   - ‘engines’

   - ‘threads’

   - ‘coinduction’

   - ‘soft_cut_support’

   - ‘text_encoding_support’


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<97>,  Next: Errors<98>,  Prev: Description<134>,  Up: resource_error/1

2.5.6.58 Modes and number of proofs
...................................

     resource_error(@nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<98>,  Next: Examples<135>,  Prev: Modes and number of proofs<97>,  Up: resource_error/1

2.5.6.59 Errors
...............

     When called:
          ‘resource_error(Resource)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<135>,  Prev: Errors<98>,  Up: resource_error/1

2.5.6.60 Examples
.................

     ...,
     empty(Tank),
     resource_error(gas).

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note consistency_error/3:
718, *note existence_error/2: 1a7, *note permission_error/3: 1a8, *note
representation_error/1: 1a9, *note syntax_error/1: 1ac, *note
system_error/0: 1ad.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: syntax_error/1,  Next: system_error/0,  Prev: resource_error/1,  Up: Error handling<2>

2.5.6.61 ‘syntax_error/1’
.........................

* Menu:

* Description: Description<135>.
* Modes and number of proofs: Modes and number of proofs<98>.
* Errors: Errors<99>.
* Examples: Examples<136>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<135>,  Next: Modes and number of proofs<98>,  Up: syntax_error/1

2.5.6.62 Description
....................

     syntax_error(Description)

Throws a syntax error.  Used when the sequence of characters being read
are not syntactically valid.  This built-in method is declared private
and thus cannot be used as a message to an object.  Calling this
predicate is equivalent to the following sequence of goals:

     ...,
     context(Context),
     throw(error(syntax_error(Description), Context)).

This allows the user to generate errors in the same format used by the
runtime.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<98>,  Next: Errors<99>,  Prev: Description<135>,  Up: syntax_error/1

2.5.6.63 Modes and number of proofs
...................................

     syntax_error(@nonvar) - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<99>,  Next: Examples<136>,  Prev: Modes and number of proofs<98>,  Up: syntax_error/1

2.5.6.64 Errors
...............

     When called:
          ‘syntax_error(Description)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<136>,  Prev: Errors<99>,  Up: syntax_error/1

2.5.6.65 Examples
.................

(none)

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note consistency_error/3:
718, *note existence_error/2: 1a7, *note permission_error/3: 1a8, *note
representation_error/1: 1a9, *note system_error/0: 1ad. *note
resource_error/1: 1ab.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: system_error/0,  Prev: syntax_error/1,  Up: Error handling<2>

2.5.6.66 ‘system_error/0’
.........................

* Menu:

* Description: Description<136>.
* Modes and number of proofs: Modes and number of proofs<99>.
* Errors: Errors<100>.
* Examples: Examples<137>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<136>,  Next: Modes and number of proofs<99>,  Up: system_error/0

2.5.6.67 Description
....................

     system_error

Throws a system error.  Used when runtime execution can no longer
proceed.  For example, an exception is thrown without an active catcher.
This built-in method is declared private and thus cannot be used as a
message to an object.  Calling this predicate is equivalent to the
following sequence of goals:

     ...,
     context(Context),
     throw(error(system_error, Context)).

This allows the user to generate errors in the same format used by the
runtime.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<99>,  Next: Errors<100>,  Prev: Description<136>,  Up: system_error/0

2.5.6.68 Modes and number of proofs
...................................

     system_error - error


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<100>,  Next: Examples<137>,  Prev: Modes and number of proofs<99>,  Up: system_error/0

2.5.6.69 Errors
...............

     When called:
          ‘system_error’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<137>,  Prev: Errors<100>,  Up: system_error/0

2.5.6.70 Examples
.................

(none)

See also
........

*note catch/3: 1a1, *note throw/1: 1a2, *note context/1: 19e, *note
instantiation_error/0: 1a3, *note uninstantiation_error/1: 1a4, *note
type_error/2: 1a5, *note domain_error/2: 1a6, *note consistency_error/3:
718, *note existence_error/2: 1a7, *note permission_error/3: 1a8, *note
representation_error/1: 1a9. *note evaluation_error/1: 1aa, *note
resource_error/1: 1ab, *note syntax_error/1: 1ac,


File: TheLogtalkHandbook-3.100.1.info,  Node: All solutions,  Next: Event handling<3>,  Prev: Error handling<2>,  Up: Built-in methods<2>

2.5.7 All solutions
-------------------

'built-in method'

* Menu:

* bagof/3::
* findall/3::
* findall/4::
* forall/2::
* setof/3::


File: TheLogtalkHandbook-3.100.1.info,  Node: bagof/3,  Next: findall/3,  Up: All solutions

2.5.7.1 ‘bagof/3’
.................

* Menu:

* Description: Description<137>.
* Meta-predicate template: Meta-predicate template<10>.
* Modes and number of proofs: Modes and number of proofs<100>.
* Errors: Errors<101>.
* Examples: Examples<138>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<137>,  Next: Meta-predicate template<10>,  Up: bagof/3

2.5.7.2 Description
...................

     bagof(Template, Goal, List)

Collects a bag of solutions for the goal for each set of instantiations
of the free variables in the goal.  The order of the elements in the bag
follows the order of the goal solutions.  The free variables in the goal
are the variables that occur in the goal but not in the template.  Free
variables can be ignored, however, by using the ‘^/2’ existential
qualifier.  For example, if ‘T’ is term containing all the free
variables that we want to ignore, we can write ‘T^Goal’.  Note that the
term ‘T’ can be written as ‘V1^V2^...’.

When there are free variables, this method is re-executable on
backtracking.  This method fails when there are no solutions, never
returning an empty list.

This built-in meta-predicate is declared as a private method and thus
cannot be used as a message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<10>,  Next: Modes and number of proofs<100>,  Prev: Description<137>,  Up: bagof/3

2.5.7.3 Meta-predicate template
...............................

     bagof(*, ^, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<100>,  Next: Errors<101>,  Prev: Meta-predicate template<10>,  Up: bagof/3

2.5.7.4 Modes and number of proofs
..................................

     bagof(@term, +callable, -list) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<101>,  Next: Examples<138>,  Prev: Modes and number of proofs<100>,  Up: bagof/3

2.5.7.5 Errors
..............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     ‘Goal’ is a call to a non-existing predicate:
          ‘existence_error(procedure, Predicate)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<138>,  Prev: Errors<101>,  Up: bagof/3

2.5.7.6 Examples
................

     To find a bag of solutions in the context of the object or category containing the call:
          ‘bagof(Template, Goal, List)’
     To find a bag of solutions of sending a message to *note self: 69.:
          ‘bagof(Template, ::Message, List)’
     To find a bag of solutions of sending a message to an explicit object:
          ‘bagof(Template, Object::Message, List)’

See also
........

*note findall/3: 1c0, *note findall/4: 1c1, *note forall/2: 1c3, *note
setof/3: 1c2.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: findall/3,  Next: findall/4,  Prev: bagof/3,  Up: All solutions

2.5.7.7 ‘findall/3’
...................

* Menu:

* Description: Description<138>.
* Meta-predicate template: Meta-predicate template<11>.
* Modes and number of proofs: Modes and number of proofs<101>.
* Errors: Errors<102>.
* Examples: Examples<139>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<138>,  Next: Meta-predicate template<11>,  Up: findall/3

2.5.7.8 Description
...................

     findall(Template, Goal, List)

Collects a list of solutions for the goal.  The order of the elements in
the list follows the order of the goal solutions.  It succeeds returning
an empty list when the goal has no solutions.

This built-in meta-predicate is declared as a private method and thus
cannot be used as a message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<11>,  Next: Modes and number of proofs<101>,  Prev: Description<138>,  Up: findall/3

2.5.7.9 Meta-predicate template
...............................

     findall(*, 0, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<101>,  Next: Errors<102>,  Prev: Meta-predicate template<11>,  Up: findall/3

2.5.7.10 Modes and number of proofs
...................................

     findall(?term, +callable, ?list) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<102>,  Next: Examples<139>,  Prev: Modes and number of proofs<101>,  Up: findall/3

2.5.7.11 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     ‘Goal’ is a call to a non-existing predicate:
          ‘existence_error(procedure, Predicate)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<139>,  Prev: Errors<102>,  Up: findall/3

2.5.7.12 Examples
.................

     To find all solutions in the context of the object or category containing the call:
          ‘findall(Template, Goal, List)’
     To find all solutions of sending a message to *note self: 69.:
          ‘findall(Template, ::Message, List)’
     To find all solutions of sending a message to an explicit object:
          ‘findall(Template, Object::Message, List)’

See also
........

*note bagof/3: 1bf, *note findall/4: 1c1, *note forall/2: 1c3, *note
setof/3: 1c2.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: findall/4,  Next: forall/2,  Prev: findall/3,  Up: All solutions

2.5.7.13 ‘findall/4’
....................

* Menu:

* Description: Description<139>.
* Meta-predicate template: Meta-predicate template<12>.
* Modes and number of proofs: Modes and number of proofs<102>.
* Errors: Errors<103>.
* Examples: Examples<140>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<139>,  Next: Meta-predicate template<12>,  Up: findall/4

2.5.7.14 Description
....................

     findall(Template, Goal, List, Tail)

Variant of the *note findall/3: 1c0. method that allows passing the tail
of the results list.  It succeeds returning the tail argument when the
goal has no solutions.

This built-in meta-predicate is declared as a private method and thus
cannot be used as a message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<12>,  Next: Modes and number of proofs<102>,  Prev: Description<139>,  Up: findall/4

2.5.7.15 Meta-predicate template
................................

     findall(*, 0, *, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<102>,  Next: Errors<103>,  Prev: Meta-predicate template<12>,  Up: findall/4

2.5.7.16 Modes and number of proofs
...................................

     findall(?term, +callable, ?list, ?term) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<103>,  Next: Examples<140>,  Prev: Modes and number of proofs<102>,  Up: findall/4

2.5.7.17 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     ‘Goal’ is a call to a non-existing predicate:
          ‘existence_error(procedure, Predicate)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<140>,  Prev: Errors<103>,  Up: findall/4

2.5.7.18 Examples
.................

     To find all solutions in the context of the object or category containing the call:
          ‘findall(Template, Goal, List, Tail)’
     To find all solutions of sending a message to *note self: 69.:
          ‘findall(Template, ::Message, List, Tail)’
     To find all solutions of sending a message to an explicit object:
          ‘findall(Template, Object::Message, List, Tail)’

See also
........

*note bagof/3: 1bf, *note findall/3: 1c0, *note forall/2: 1c3, *note
setof/3: 1c2.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: forall/2,  Next: setof/3,  Prev: findall/4,  Up: All solutions

2.5.7.19 ‘forall/2’
...................

* Menu:

* Description: Description<140>.
* Meta-predicate template: Meta-predicate template<13>.
* Modes and number of proofs: Modes and number of proofs<103>.
* Errors: Errors<104>.
* Examples: Examples<141>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<140>,  Next: Meta-predicate template<13>,  Up: forall/2

2.5.7.20 Description
....................

     forall(Generator, Test)

For all solutions of ‘Generator’, ‘Test’ is true.  This meta-predicate
implements a 'generate-and-test' loop using a definition equivalent to
‘\+ (Generator, \+ Test)’.  As a consequence, no variables in the
arguments are bound by a call to this predicate.  This predicate often
provides a better alternative to a 'failure-driven loop' as an
unexpected ‘Test’ failure will not be ignored as it will make the
‘forall/2’ call fail.

This built-in meta-predicate is declared as a private method and thus
cannot be used as a message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<13>,  Next: Modes and number of proofs<103>,  Prev: Description<140>,  Up: forall/2

2.5.7.21 Meta-predicate template
................................

     forall(0, 0)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<103>,  Next: Errors<104>,  Prev: Meta-predicate template<13>,  Up: forall/2

2.5.7.22 Modes and number of proofs
...................................

     forall(@callable, @callable) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<104>,  Next: Examples<141>,  Prev: Modes and number of proofs<103>,  Up: forall/2

2.5.7.23 Errors
...............

     Either ‘Generator’ or ‘Test’ is a variable:
          ‘instantiation_error’
     ‘Generator’ is neither a variable nor a callable term:
          ‘type_error(callable, Generator)’
     ‘Test’ is neither a variable nor a callable term:
          ‘type_error(callable, Test)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<141>,  Prev: Errors<104>,  Up: forall/2

2.5.7.24 Examples
.................

     To call both goals in the context of the object or category containing the call:
          ‘forall(Generator, Test)’
     To send both goals as messages to *note self: 69.:
          ‘forall(::Generator, ::Test)’
     To send both goals as messages to explicit objects:
          ‘forall(Object1::Generator, Object2::Test)’

See also
........

*note bagof/3: 1bf, *note findall/3: 1c0, *note findall/4: 1c1, *note
setof/3: 1c2.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: setof/3,  Prev: forall/2,  Up: All solutions

2.5.7.25 ‘setof/3’
..................

* Menu:

* Description: Description<141>.
* Meta-predicate template: Meta-predicate template<14>.
* Modes and number of proofs: Modes and number of proofs<104>.
* Errors: Errors<105>.
* Examples: Examples<142>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<141>,  Next: Meta-predicate template<14>,  Up: setof/3

2.5.7.26 Description
....................

     setof(Template, Goal, List)

Collects a set of solutions for the goal for each set of instantiations
of the free variables in the goal.  The solutions are sorted using
standard term order.  The free variables in the goal are the variables
that occur in the goal but not in the template.  Free variables can be
ignored, however, by using the ‘^/2’ existential qualifier.  For
example, if ‘T’ is term containing all the free variables that we want
to ignore, we can write ‘T^Goal’.  Note that the term ‘T’ can be written
as ‘V1^V2^...’.

When there are free variables, this method is re-executable on
backtracking.  This method fails when there are no solutions, never
returning an empty list.

This built-in meta-predicate is declared as a private method and thus
cannot be used as a message to an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<14>,  Next: Modes and number of proofs<104>,  Prev: Description<141>,  Up: setof/3

2.5.7.27 Meta-predicate template
................................

     setof(*, ^, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<104>,  Next: Errors<105>,  Prev: Meta-predicate template<14>,  Up: setof/3

2.5.7.28 Modes and number of proofs
...................................

     setof(@term, +callable, -list) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<105>,  Next: Examples<142>,  Prev: Modes and number of proofs<104>,  Up: setof/3

2.5.7.29 Errors
...............

     ‘Goal’ is a variable:
          ‘instantiation_error’
     ‘Goal’ is neither a variable nor a callable term:
          ‘type_error(callable, Goal)’
     ‘Goal’ is a call to a non-existing predicate:
          ‘existence_error(procedure, Predicate)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<142>,  Prev: Errors<105>,  Up: setof/3

2.5.7.30 Examples
.................

     To find a set of solutions in the context of the object or category containing the call:
          ‘setof(Template, Goal, List)’
     To find a set of solutions of sending a message to *note self: 69.:
          ‘setof(Template, ::Message, List)’
     To find a set of solutions of sending a message to an explicit object:
          ‘setof(Template, Object::Message, List)’

See also
........

*note bagof/3: 1bf, *note findall/3: 1c0, *note findall/4: 1c1, *note
forall/2: 1c3.


File: TheLogtalkHandbook-3.100.1.info,  Node: Event handling<3>,  Next: Message forwarding,  Prev: All solutions,  Up: Built-in methods<2>

2.5.8 Event handling
--------------------

'built-in method'

* Menu:

* before/3::
* after/3::


File: TheLogtalkHandbook-3.100.1.info,  Node: before/3,  Next: after/3,  Up: Event handling<3>

2.5.8.1 ‘before/3’
..................

* Menu:

* Description: Description<142>.
* Modes and number of proofs: Modes and number of proofs<105>.
* Errors: Errors<106>.
* Examples: Examples<143>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<142>,  Next: Modes and number of proofs<105>,  Up: before/3

2.5.8.2 Description
...................

     before(Object, Message, Sender)

User-defined method for handling *note before events: 205.  This method
is declared in the monitoring(1) built-in protocol as a public predicate
and is automatically called by the runtime for messages sent using the
*note (;;)/2: 7e. control construct from within objects compiled with
the *note events: 89. flag set to ‘allow’.

Note that you can make this predicate scope protected or private by
using, respectively, *note protected or private implementation: 9e. of
the ‘monitoring’ protocol.

   ---------- Footnotes ----------

   (1) ../../../apis/monitoring_0.html#monitoring-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<105>,  Next: Errors<106>,  Prev: Description<142>,  Up: before/3

2.5.8.3 Modes and number of proofs
..................................

     before(?object_identifier, ?callable, ?object_identifier) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<106>,  Next: Examples<143>,  Prev: Modes and number of proofs<105>,  Up: before/3

2.5.8.4 Errors
..............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<143>,  Prev: Errors<106>,  Up: before/3

2.5.8.5 Examples
................

     :- object(...,
         implements(monitoring),
         ...).

         % write a log message when a message is sent:
         before(Object, Message, Sender) :-
             writeq(Object), write('::'), writeq(Message),
             write(' from '), writeq(Sender), nl.

See also
........

*note after/3: 102, *note abolish_events/5: 21b, *note current_event/5:
21e, *note define_events/5: 218.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: after/3,  Prev: before/3,  Up: Event handling<3>

2.5.8.6 ‘after/3’
.................

* Menu:

* Description: Description<143>.
* Modes and number of proofs: Modes and number of proofs<106>.
* Errors: Errors<107>.
* Examples: Examples<144>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<143>,  Next: Modes and number of proofs<106>,  Up: after/3

2.5.8.7 Description
...................

     after(Object, Message, Sender)

User-defined method for handling *note after events: 205.  This method
is declared in the monitoring(1) built-in protocol as a public predicate
and is automatically called by the runtime for messages sent using the
*note (;;)/2: 7e. control construct from within objects compiled with
the *note events: 89. flag set to ‘allow’.

Note that you can make this predicate scope protected or private by
using, respectively, *note protected or private implementation: 9e. of
the ‘monitoring’ protocol.

   ---------- Footnotes ----------

   (1) ../../../apis/monitoring_0.html#monitoring-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<106>,  Next: Errors<107>,  Prev: Description<143>,  Up: after/3

2.5.8.8 Modes and number of proofs
..................................

     after(?object_identifier, ?callable, ?object_identifier) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<107>,  Next: Examples<144>,  Prev: Modes and number of proofs<106>,  Up: after/3

2.5.8.9 Errors
..............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<144>,  Prev: Errors<107>,  Up: after/3

2.5.8.10 Examples
.................

     :- object(...,
         implements(monitoring),
         ...).

         % write a log message when a message is successful:
         after(Object, Message, Sender) :-
             writeq(Object), write('::'), writeq(Message),
             write(' from '), writeq(Sender), nl.

See also
........

*note before/3: 101, *note abolish_events/5: 21b, *note current_event/5:
21e, *note define_events/5: 218.


File: TheLogtalkHandbook-3.100.1.info,  Node: Message forwarding,  Next: Definite clause grammar rules<2>,  Prev: Event handling<3>,  Up: Built-in methods<2>

2.5.9 Message forwarding
------------------------

'built-in method'

* Menu:

* forward/1::


File: TheLogtalkHandbook-3.100.1.info,  Node: forward/1,  Up: Message forwarding

2.5.9.1 ‘forward/1’
...................

* Menu:

* Description: Description<144>.
* Modes and number of proofs: Modes and number of proofs<107>.
* Errors: Errors<108>.
* Examples: Examples<145>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<144>,  Next: Modes and number of proofs<107>,  Up: forward/1

2.5.9.2 Description
...................

     forward(Message)

User-defined method for forwarding unknown messages sent to an object
(using the *note (;;)/2: 7e. control construct), automatically called by
the runtime when defined.  This method is declared in the forwarding(1)
built-in protocol as a *note public: 143. predicate.  Note that you can
make its scope protected or private by using, respectively, *note
protected or private implementation: 9e. of the ‘forwarding’ protocol.

   ---------- Footnotes ----------

   (1) ../../../apis/forwarding_0.html#forwarding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<107>,  Next: Errors<108>,  Prev: Description<144>,  Up: forward/1

2.5.9.3 Modes and number of proofs
..................................

     forward(+callable) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<108>,  Next: Examples<145>,  Prev: Modes and number of proofs<107>,  Up: forward/1

2.5.9.4 Errors
..............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<145>,  Prev: Errors<108>,  Up: forward/1

2.5.9.5 Examples
................

     :- object(proxy,
         implements(forwarding),
         ...).

         forward(Message) :-
             % delegate unknown messages to the "real" object
             [real::Message].

See also
........

*note []/1: 81.


File: TheLogtalkHandbook-3.100.1.info,  Node: Definite clause grammar rules<2>,  Next: Term and goal expansion<2>,  Prev: Message forwarding,  Up: Built-in methods<2>

2.5.10 Definite clause grammar rules
------------------------------------

'built-in method'

* Menu:

* call//1-N::
* eos//0::
* phrase//1::
* phrase/2::
* phrase/3::


File: TheLogtalkHandbook-3.100.1.info,  Node: call//1-N,  Next: eos//0,  Up: Definite clause grammar rules<2>

2.5.10.1 ‘call//1-N’
....................

* Menu:

* Description: Description<145>.
* Meta-non-terminal template::
* Modes and number of proofs: Modes and number of proofs<108>.
* Errors: Errors<109>.
* Examples: Examples<146>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<145>,  Next: Meta-non-terminal template,  Up: call//1-N

2.5.10.2 Description
....................

     call(Closure)
     call(Closure, Arg1, ...)
     call(Object::Closure, Arg1, ...)
     call(::Closure, Arg1, ...)
     call(^^Closure, Arg1, ...)
     ...

This non-terminal takes a *note closure: 14f. and is processed by
appending the two implicit grammar rule arguments to the arguments of
the closure.  This built-in non-terminal is interpreted as a private
non-terminal and thus cannot be used as a message to an object.

Using this non-terminal is recommended when calling a predicate whose
last two arguments are the two implicit grammar rule arguments to avoid
hard-coding assumptions about how grammar rules are compiled into
clauses.  Note that the compiler ensures zero overhead when using this
non-terminal with a bound argument at compile-time.  To call a predicate
with a different argument order, use a *note lambda expression: 182. or
define a *note predicate alias: ca.  For example:

     square -->
         call([Number, Double]>>(Double is Number*Number)).

When using a *note backend Prolog compiler: 34. supporting a module
system, calls in the format ‘call(Module:Closure)’ may also be used.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-non-terminal template,  Next: Modes and number of proofs<108>,  Prev: Description<145>,  Up: call//1-N

2.5.10.3 Meta-non-terminal template
...................................

     call(0)
     call(1, *)
     call(2, *, *)
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<108>,  Next: Errors<109>,  Prev: Meta-non-terminal template,  Up: call//1-N

2.5.10.4 Modes and number of proofs
...................................

     call(+callable) - zero_or_more
     call(+callable, ?term) - zero_or_more
     call(+callable, ?term, ?term) - zero_or_more
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<109>,  Next: Examples<146>,  Prev: Modes and number of proofs<108>,  Up: call//1-N

2.5.10.5 Errors
...............

     ‘Closure’ is a variable:
          ‘instantiation_error’
     ‘Closure’ is neither a variable nor a callable term:
          ‘type_error(callable, Closure)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<146>,  Prev: Errors<109>,  Up: call//1-N

2.5.10.6 Examples
.................

     Calls a goal, constructed by appending the two implicit grammar rule arguments to the closure, in in the context of the object or category containing the call:
          ‘call(Closure)’
     To make a 'super' call, constructed by appending the two implicit grammar rule arguments to the closure:
          ‘call(^^Closure)’
     To send a goal, constructed by appending the two implicit grammar rule arguments to the closure, as a message to *note self: 69.:
          ‘call(::Closure)’
     To send a goal, constructed by appending the two implicit grammar rule arguments to the closure, as a message to an explicit object:
          ‘call(Object::Closure)’

See also
........

*note eos//0: 1ca, *note phrase//1: 1c8, *note phrase/2: 18e, *note
phrase/3: 18f.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: eos//0,  Next: phrase//1,  Prev: call//1-N,  Up: Definite clause grammar rules<2>

2.5.10.7 ‘eos//0’
.................

* Menu:

* Description: Description<146>.
* Modes and number of proofs: Modes and number of proofs<109>.
* Errors: Errors<110>.
* Examples: Examples<147>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<146>,  Next: Modes and number of proofs<109>,  Up: eos//0

2.5.10.8 Description
....................

     eos

This non-terminal matches the end-of-input.  It is implemented by
checking that the implicit difference list unifies with ‘[]-[]’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<109>,  Next: Errors<110>,  Prev: Description<146>,  Up: eos//0

2.5.10.9 Modes and number of proofs
...................................

     eos - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<110>,  Next: Examples<147>,  Prev: Modes and number of proofs<109>,  Up: eos//0

2.5.10.10 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<147>,  Prev: Errors<110>,  Up: eos//0

2.5.10.11 Examples
..................

     abc --> a, b, c, eos.

See also
........

*note call//1-N: 1c9, *note phrase//1: 1c8, *note phrase/2: 18e, *note
phrase/3: 18f.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: phrase//1,  Next: phrase/2,  Prev: eos//0,  Up: Definite clause grammar rules<2>

2.5.10.12 ‘phrase//1’
.....................

* Menu:

* Description: Description<147>.
* Meta-non-terminal template: Meta-non-terminal template<2>.
* Modes and number of proofs: Modes and number of proofs<110>.
* Errors: Errors<111>.
* Examples: Examples<148>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<147>,  Next: Meta-non-terminal template<2>,  Up: phrase//1

2.5.10.13 Description
.....................

     phrase(GrammarRuleBody)

This non-terminal takes a grammar rule body and parses it using the two
implicit grammar rule arguments.  A common use is to wrap what otherwise
would be a *note naked meta-variable: 7b8. in a grammar rule body when
defining a meta non-terminal.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-non-terminal template<2>,  Next: Modes and number of proofs<110>,  Prev: Description<147>,  Up: phrase//1

2.5.10.14 Meta-non-terminal template
....................................

     phrase(0)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<110>,  Next: Errors<111>,  Prev: Meta-non-terminal template<2>,  Up: phrase//1

2.5.10.15 Modes and number of proofs
....................................

     phrase(+callable) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<111>,  Next: Examples<148>,  Prev: Modes and number of proofs<110>,  Up: phrase//1

2.5.10.16 Errors
................

     ‘GrammarRuleBody’ is a variable:
          ‘instantiation_error’
     ‘GrammarRuleBody’ is neither a variable nor a callable term:
          ‘type_error(callable, GrammarRuleBody)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<148>,  Prev: Errors<111>,  Up: phrase//1

2.5.10.17 Examples
..................

     (none)

See also
........

*note call//1-N: 1c9, *note phrase/2: 18e, *note phrase/3: 18f.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: phrase/2,  Next: phrase/3,  Prev: phrase//1,  Up: Definite clause grammar rules<2>

2.5.10.18 ‘phrase/2’
....................

* Menu:

* Description: Description<148>.
* Meta-predicate template: Meta-predicate template<15>.
* Modes and number of proofs: Modes and number of proofs<111>.
* Errors: Errors<112>.
* Examples: Examples<149>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<148>,  Next: Meta-predicate template<15>,  Up: phrase/2

2.5.10.19 Description
.....................

     phrase(GrammarRuleBody, Input)
     phrase(::GrammarRuleBody, Input)
     phrase(Object::GrammarRuleBody, Input)

True when the ‘GrammarRuleBody’ grammar rule body can be applied to the
‘Input’ list of tokens.  In the most common case, ‘GrammarRuleBody’ is a
non-terminal defined by a grammar rule.  This built-in method is
declared private and thus cannot be used as a message to an object.
When using a *note backend Prolog compiler: 34. supporting a module
system, calls in the format ‘phrase(Module:GrammarRuleBody, Input)’ may
also be used.

This method is opaque to cuts in the first argument.  When the first
argument is sufficiently instantiated at compile-time, the method call
is compiled in order to eliminate the implicit overheads of converting
the grammar rule body into a goal and meta-calling it.  For performance
reasons, the second argument is only type-checked at compile-time.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<15>,  Next: Modes and number of proofs<111>,  Prev: Description<148>,  Up: phrase/2

2.5.10.20 Meta-predicate template
.................................

     phrase(2, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<111>,  Next: Errors<112>,  Prev: Meta-predicate template<15>,  Up: phrase/2

2.5.10.21 Modes and number of proofs
....................................

     phrase(+callable, ?list) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<112>,  Next: Examples<149>,  Prev: Modes and number of proofs<111>,  Up: phrase/2

2.5.10.22 Errors
................

     ‘GrammarRuleBody’ is a variable:
          ‘instantiation_error’
     ‘GrammarRuleBody’ is neither a variable nor a callable term:
          ‘type_error(callable, GrammarRuleBody)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<149>,  Prev: Errors<112>,  Up: phrase/2

2.5.10.23 Examples
..................

     To parse a list of tokens using a local non-terminal:
          ‘phrase(NonTerminal, Input)’
     To parse a list of tokens using a non-terminal within the scope of *note self: 69.:
          ‘phrase(::NonTerminal, Input)’
     To parse a list of tokens using a public non-terminal of an explicit object:
          ‘phrase(Object::NonTerminal, Input)’

See also
........

*note call//1-N: 1c9, *note phrase//1: 1c8, *note phrase/3: 18f.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: phrase/3,  Prev: phrase/2,  Up: Definite clause grammar rules<2>

2.5.10.24 ‘phrase/3’
....................

* Menu:

* Description: Description<149>.
* Meta-predicate template: Meta-predicate template<16>.
* Modes and number of proofs: Modes and number of proofs<112>.
* Errors: Errors<113>.
* Examples: Examples<150>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<149>,  Next: Meta-predicate template<16>,  Up: phrase/3

2.5.10.25 Description
.....................

     phrase(GrammarRuleBody, Input, Rest)
     phrase(::GrammarRuleBody, Input, Rest)
     phrase(Object::GrammarRuleBody, Input, Rest)

True when the ‘GrammarRuleBody’ grammar rule body can be applied to the
‘Input-Rest’ difference list of tokens.  In the most common case,
‘GrammarRuleBody’ is a non-terminal defined by a grammar rule.  This
built-in method is declared private and thus cannot be used as a message
to an object.  When using a *note backend Prolog compiler: 34.
supporting a module system, calls in the format
‘phrase(Module:GrammarRuleBody, Input, Rest)’ may also be used.

This method is opaque to cuts in the first argument.  When the first
argument is sufficiently instantiated at compile-time, the method call
is compiled in order to eliminate the implicit overheads of converting
the grammar rule body into a goal and meta-calling it.  For performance
reasons, the second and third arguments are only type-checked at compile
time.


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<16>,  Next: Modes and number of proofs<112>,  Prev: Description<149>,  Up: phrase/3

2.5.10.26 Meta-predicate template
.................................

     phrase(2, *, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<112>,  Next: Errors<113>,  Prev: Meta-predicate template<16>,  Up: phrase/3

2.5.10.27 Modes and number of proofs
....................................

     phrase(+callable, ?list, ?list) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<113>,  Next: Examples<150>,  Prev: Modes and number of proofs<112>,  Up: phrase/3

2.5.10.28 Errors
................

     ‘GrammarRuleBody’ is a variable:
          ‘instantiation_error’
     ‘GrammarRuleBody’ is neither a variable nor a callable term:
          ‘type_error(callable, GrammarRuleBody)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<150>,  Prev: Errors<113>,  Up: phrase/3

2.5.10.29 Examples
..................

     To parse a list of tokens using a local non-terminal:
          ‘phrase(NonTerminal, Input, Rest)’
     To parse a list of tokens using a non-terminal within the scope of *note self: 69.:
          ‘phrase(::NonTerminal, Input, Rest)’
     To parse a list of tokens using a public non-terminal of an explicit object:
          ‘phrase(Object::NonTerminal, Input, Rest)’

See also
........

*note call//1-N: 1c9, *note phrase/2: 18e, *note phrase/3: 18f.


File: TheLogtalkHandbook-3.100.1.info,  Node: Term and goal expansion<2>,  Next: Coinduction hooks,  Prev: Definite clause grammar rules<2>,  Up: Built-in methods<2>

2.5.11 Term and goal expansion
------------------------------

'built-in method'

* Menu:

* expand_term/2::
* term_expansion/2::
* expand_goal/2::
* goal_expansion/2::


File: TheLogtalkHandbook-3.100.1.info,  Node: expand_term/2,  Next: term_expansion/2,  Up: Term and goal expansion<2>

2.5.11.1 ‘expand_term/2’
........................

* Menu:

* Description: Description<150>.
* Modes and number of proofs: Modes and number of proofs<113>.
* Errors: Errors<114>.
* Examples: Examples<151>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<150>,  Next: Modes and number of proofs<113>,  Up: expand_term/2

2.5.11.2 Description
....................

     expand_term(Term, Expansion)

Expands a term.  The most common use is to expand a grammar rule into a
clause.  Users may override the default Logtalk grammar rule translator
by defining clauses for the *note term_expansion/2: fc. hook predicate.

The expansion works as follows: if the first argument is a variable,
then it is unified with the second argument; if the first argument is
not a variable and there are local or inherited clauses for the
‘term_expansion/2’ hook predicate within scope, then this predicate is
called to provide an expansion that is then unified with the second
argument; if the ‘term_expansion/2’ predicate is not used and the first
argument is a compound term with functor ‘(-->)/2’ then the default
Logtalk grammar rule translator is used, with the resulting clause being
unified with the second argument; when the translator is not used, the
two arguments are unified.  The ‘expand_term/2’ predicate may return a
single term or a list of terms.

This built-in method may be used to expand a grammar rule into a clause
for use with the built-in database methods.

Automatic term expansion is only performed at compile-time (to expand
terms read from a source file) when using a *note hook object: 39e.
This predicate can be used by the user to manually perform term
expansion at runtime (for example, to convert a grammar rule into a
clause).


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<113>,  Next: Errors<114>,  Prev: Description<150>,  Up: expand_term/2

2.5.11.3 Modes and number of proofs
...................................

     expand_term(?term, ?term) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<114>,  Next: Examples<151>,  Prev: Modes and number of proofs<113>,  Up: expand_term/2

2.5.11.4 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<151>,  Prev: Errors<114>,  Up: expand_term/2

2.5.11.5 Examples
.................

(none)

See also
........

*note expand_goal/2: 312, *note goal_expansion/2: fd, *note
term_expansion/2: fc.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: term_expansion/2,  Next: expand_goal/2,  Prev: expand_term/2,  Up: Term and goal expansion<2>

2.5.11.6 ‘term_expansion/2’
...........................

* Menu:

* Description: Description<151>.
* Modes and number of proofs: Modes and number of proofs<114>.
* Errors: Errors<115>.
* Examples: Examples<152>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<151>,  Next: Modes and number of proofs<114>,  Up: term_expansion/2

2.5.11.7 Description
....................

     term_expansion(Term, Expansion)

Defines an expansion for a term.  This predicate, when defined and
within scope, is automatically called by the *note expand_term/2: 1b7.
method.  When that is not the case, the ‘expand_term/2’ method only uses
the default expansions.  Use of this predicate by the ‘expand_term/2’
method may be restricted by changing its default public scope.

The ‘term_expansion/2’ predicate may return a list of terms.  Returning
an empty list effectively suppresses the term.

Term expansion may also be applied when compiling source files by
defining the object providing access to the ‘term_expansion/2’ clauses
as a *note hook object: 39e.  Clauses for the ‘term_expansion/2’
predicate defined within an object or a category are 'never' used in the
compilation of the object or the category itself.  Moreover, in this
context, terms wrapped using the *note {}/1: 191. compiler bypass
control construct are not expanded and any expanded term wrapped in this
control construct will not be further expanded.

Objects and categories implementing this predicate should declare that
they implement the expanding(1) protocol if no ancestor already declares
it.  This protocol implementation relation can be declared as either
*note protected or private: 9e. to restrict the scope of this predicate.

   ---------- Footnotes ----------

   (1) ../../../apis/expanding_0.html#expanding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<114>,  Next: Errors<115>,  Prev: Description<151>,  Up: term_expansion/2

2.5.11.8 Modes and number of proofs
...................................

     term_expansion(+nonvar, -nonvar) - zero_or_one
     term_expansion(+nonvar, -list(nonvar)) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<115>,  Next: Examples<152>,  Prev: Modes and number of proofs<114>,  Up: term_expansion/2

2.5.11.9 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<152>,  Prev: Errors<115>,  Up: term_expansion/2

2.5.11.10 Examples
..................

     term_expansion((:- license(default)), (:- license(gplv3))).
     term_expansion(data(Millimeters), data(Meters)) :- Meters is Millimeters / 1000.

See also
........

*note expand_goal/2: 312, *note expand_term/2: 1b7, *note
goal_expansion/2: fd, *note logtalk_load_context/2: 317.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: expand_goal/2,  Next: goal_expansion/2,  Prev: term_expansion/2,  Up: Term and goal expansion<2>

2.5.11.11 ‘expand_goal/2’
.........................

* Menu:

* Description: Description<152>.
* Modes and number of proofs: Modes and number of proofs<115>.
* Errors: Errors<116>.
* Examples: Examples<153>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<152>,  Next: Modes and number of proofs<115>,  Up: expand_goal/2

2.5.11.12 Description
.....................

     expand_goal(Goal, ExpandedGoal)

Expands a goal.  The expansion works as follows: if the first argument
is a variable, then it is unified with the second argument; if the first
argument is not a variable and there are local or inherited clauses for
the ‘goal_expansion/2’ hook predicate within scope, then this predicate
is recursively called until a fixed-point is reached to provide an
expansion that is then unified with the second argument; if the
‘goal_expansion/2’ predicate is not within scope, the two arguments are
unified.

Automatic goal expansion is only performed at compile-time (to expand
the body of clauses and meta-directives read from a source file) when
using *note hook objects: 39e.  This predicate can be used by the user
to manually perform goal expansion at runtime (for example, before
asserting a clause).


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<115>,  Next: Errors<116>,  Prev: Description<152>,  Up: expand_goal/2

2.5.11.13 Modes and number of proofs
....................................

     expand_goal(?term, ?term) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<116>,  Next: Examples<153>,  Prev: Modes and number of proofs<115>,  Up: expand_goal/2

2.5.11.14 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<153>,  Prev: Errors<116>,  Up: expand_goal/2

2.5.11.15 Examples
..................

(none)

See also
........

*note expand_term/2: 1b7, *note goal_expansion/2: fd, *note
term_expansion/2: fc.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: goal_expansion/2,  Prev: expand_goal/2,  Up: Term and goal expansion<2>

2.5.11.16 ‘goal_expansion/2’
............................

* Menu:

* Description: Description<153>.
* Modes and number of proofs: Modes and number of proofs<116>.
* Errors: Errors<117>.
* Examples: Examples<154>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<153>,  Next: Modes and number of proofs<116>,  Up: goal_expansion/2

2.5.11.17 Description
.....................

     goal_expansion(Goal, ExpandedGoal)

Defines an expansion for a goal.  The first argument is the goal to be
expanded.  The expanded goal is returned in the second argument.  This
predicate is called recursively on the expanded goal until a fixed point
is reached.  Thus, care must be taken to avoid compilation loops.  This
predicate, when defined and within scope, is automatically called by the
*note expand_goal/2: 312. method.  Use of this predicate by the
‘expand_goal/2’ method may be restricted by changing its default public
scope.

Goal expansion may also be applied when compiling source files by
defining the object providing access to the ‘goal_expansion/2’ clauses
as a *note hook object: 39e.  Clauses for the ‘goal_expansion/2’
predicate defined within an object or a category are 'never' used in the
compilation of the object or the category itself.  Moreover, in this
context, goals wrapped using the *note {}/1: 191. compiler bypass
control construct are not expanded and any expanded goal wrapped in this
control construct will not be further expanded.

Objects and categories implementing this predicate should declare that
they implement the expanding(1) built-in protocol if no ancestor already
declares it.  This protocol implementation relation can be declared as
either *note protected or private: 9e. to restrict the scope of this
predicate.

   ---------- Footnotes ----------

   (1) ../../../apis/expanding_0.html#expanding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<116>,  Next: Errors<117>,  Prev: Description<153>,  Up: goal_expansion/2

2.5.11.18 Modes and number of proofs
....................................

     goal_expansion(+callable, -callable) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<117>,  Next: Examples<154>,  Prev: Modes and number of proofs<116>,  Up: goal_expansion/2

2.5.11.19 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<154>,  Prev: Errors<117>,  Up: goal_expansion/2

2.5.11.20 Examples
..................

     goal_expansion(write(Term), (write_term(Term, []), nl)).
     goal_expansion(read(Term), (write('Input: '), {read(Term)})).

See also
........

*note expand_goal/2: 312, *note expand_term/2: 1b7, *note
term_expansion/2: fc, *note logtalk_load_context/2: 317.


File: TheLogtalkHandbook-3.100.1.info,  Node: Coinduction hooks,  Next: Message printing,  Prev: Term and goal expansion<2>,  Up: Built-in methods<2>

2.5.12 Coinduction hooks
------------------------

'built-in method'

* Menu:

* coinductive_success_hook/1-2::


File: TheLogtalkHandbook-3.100.1.info,  Node: coinductive_success_hook/1-2,  Up: Coinduction hooks

2.5.12.1 ‘coinductive_success_hook/1-2’
.......................................

* Menu:

* Description: Description<154>.
* Modes and number of proofs: Modes and number of proofs<117>.
* Errors: Errors<118>.
* Examples: Examples<155>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<154>,  Next: Modes and number of proofs<117>,  Up: coinductive_success_hook/1-2

2.5.12.2 Description
....................

     coinductive_success_hook(Head, Hypothesis)
     coinductive_success_hook(Head)

User-defined hook predicates that are automatically called in case of
coinductive success when proving a query for a coinductive predicates.
The hook predicates are called with the head of the coinductive
predicate on coinductive success and, optionally, with the hypothesis
that has used to reach coinductive success.

When both hook predicates are defined, the ‘coinductive_success_hook/1’
clauses are only used if no ‘coinductive_success_hook/2’ clause applies.
The compiler ensures zero performance penalties when defining
coinductive predicates without a corresponding definition for the
coinductive success hook predicates.

The compiler assumes that these hook predicates are defined as static
predicates in order to optimize their use.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<117>,  Next: Errors<118>,  Prev: Description<154>,  Up: coinductive_success_hook/1-2

2.5.12.3 Modes and number of proofs
...................................

     coinductive_success_hook(+callable, +callable) - zero_or_one
     coinductive_success_hook(+callable) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<118>,  Next: Examples<155>,  Prev: Modes and number of proofs<117>,  Up: coinductive_success_hook/1-2

2.5.12.4 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<155>,  Prev: Errors<118>,  Up: coinductive_success_hook/1-2

2.5.12.5 Examples
.................

     % Are there "occurrences" of arg1 in arg2?
     :- public(member/2).
     :- coinductive(member/2).

     member(X, [X| _]).
     member(X, [_| T]) :-
         member(X, T).

     % Are there infinitely many "occurrences" of arg1 in arg2?
     :- public(comember/2).
     :- coinductive(comember/2).
     comember(X, [_| T]) :-
         comember(X, T).

     coinductive_success_hook(member(_, _)) :-
         fail.
     coinductive_success_hook(comember(X, L)) :-
         member(X, L).

See also
........

*note coinductive/1: 171.


File: TheLogtalkHandbook-3.100.1.info,  Node: Message printing,  Next: Question asking,  Prev: Coinduction hooks,  Up: Built-in methods<2>

2.5.13 Message printing
-----------------------

'built-in method'

* Menu:

* print_message/3::
* message_tokens//2::
* message_hook/4::
* message_prefix_stream/4::
* message_prefix_file/6::
* print_message_tokens/3::
* print_message_token/4::


File: TheLogtalkHandbook-3.100.1.info,  Node: print_message/3,  Next: message_tokens//2,  Up: Message printing

2.5.13.1 ‘print_message/3’
..........................

* Menu:

* Description: Description<155>.
* Modes and number of proofs: Modes and number of proofs<118>.
* Errors: Errors<119>.
* Examples: Examples<156>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<155>,  Next: Modes and number of proofs<118>,  Up: print_message/3

2.5.13.2 Description
....................

     print_message(Kind, Component, Term)

Built-in method for printing a message represented by a term, which is
converted to the message text using the *note
logtalk;;message_tokens(Term, Component): 300. hook non-terminal.  This
method is declared in the logtalk(1) built-in object as a public
predicate.  The line prefix and the output stream used for each
‘Kind-Component’ pair can be found using the *note
logtalk;;message_prefix_stream(Kind, Component, Prefix, Stream): 304.
hook predicate.

This predicate starts by converting the message term to a list of tokens
and by calling the *note logtalk;;message_hook(Message, Kind, Component,
Tokens): 306. hook predicate.  If this predicate succeeds, the
‘print_message/3’ predicate assumes that the message has been
successfully printed.

By default: messages of kind ‘debug’ or ‘debug(_)’ are only printed when
the ‘debug’ flag is turned on; messages of kind ‘banner’, ‘comment’, or
‘comment(_)’ are only printed when the ‘report’ flag is set to ‘on’;
messages of kind ‘warning’ and ‘warning(_)’ are not printed when the
‘report’ flag is set to ‘off’; messages of kind ‘silent’ and ‘silent()’
are not printed (but can be intercepted).

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<118>,  Next: Errors<119>,  Prev: Description<155>,  Up: print_message/3

2.5.13.3 Modes and number of proofs
...................................

     print_message(+nonvar, +nonvar, +nonvar) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<119>,  Next: Examples<156>,  Prev: Modes and number of proofs<118>,  Up: print_message/3

2.5.13.4 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<156>,  Prev: Errors<119>,  Up: print_message/3

2.5.13.5 Examples
.................

     ..., logtalk::print_message(information, core, redefining_entity(object, foo)), ...

See also
........

*note message_hook/4: 306, *note message_prefix_stream/4: 304, *note
message_tokens//2: 300, *note print_message_tokens/3: 7f8, *note
print_message_token/4: 7f9, *note ask_question/5: 30b, *note
question_hook/6: 30d, *note question_prompt_stream/4: 7fa.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: message_tokens//2,  Next: message_hook/4,  Prev: print_message/3,  Up: Message printing

2.5.13.6 ‘message_tokens//2’
............................

* Menu:

* Description: Description<156>.
* Modes and number of proofs: Modes and number of proofs<119>.
* Errors: Errors<120>.
* Examples: Examples<157>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<156>,  Next: Modes and number of proofs<119>,  Up: message_tokens//2

2.5.13.7 Description
....................

     message_tokens(Message, Component)

User-defined non-terminal hook used to rewrite a message term into a
list of tokens and declared in the logtalk(1) built-in object as a
public, multifile, and dynamic non-terminal.  The list of tokens can be
printed by calling the *note print_message_tokens/3: 7f8. method.  This
non-terminal hook is automatically called by the *note print_message/3:
2fe. method.

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<119>,  Next: Errors<120>,  Prev: Description<156>,  Up: message_tokens//2

2.5.13.8 Modes and number of proofs
...................................

     message_tokens(+nonvar, +nonvar) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<120>,  Next: Examples<157>,  Prev: Modes and number of proofs<119>,  Up: message_tokens//2

2.5.13.9 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<157>,  Prev: Errors<120>,  Up: message_tokens//2

2.5.13.10 Examples
..................

     :- multifile(logtalk::message_tokens//2).
     :- dynamic(logtalk::message_tokens//2).

     logtalk::message_tokens(redefining_entity(Type, Entity), core) -->
         ['Redefining ~w ~q'-[Type, Entity], nl].

See also
........

*note message_hook/4: 306, *note message_prefix_stream/4: 304, *note
print_message/3: 2fe, *note print_message_tokens/3: 7f8, *note
print_message_token/4: 7f9, *note ask_question/5: 30b, *note
question_hook/6: 30d, *note question_prompt_stream/4: 7fa.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: message_hook/4,  Next: message_prefix_stream/4,  Prev: message_tokens//2,  Up: Message printing

2.5.13.11 ‘message_hook/4’
..........................

* Menu:

* Description: Description<157>.
* Modes and number of proofs: Modes and number of proofs<120>.
* Errors: Errors<121>.
* Examples: Examples<158>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<157>,  Next: Modes and number of proofs<120>,  Up: message_hook/4

2.5.13.12 Description
.....................

     message_hook(Message, Kind, Component, Tokens)

User-defined hook method for intercepting printing of a message,
declared in the logtalk(1) built-in object as a public, multifile, and
dynamic predicate.  This hook method is automatically called by the
*note print_message/3: 2fe. method.  When the call succeeds, the
‘print_message/3’ method assumes that the message has been successfully
printed.

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<120>,  Next: Errors<121>,  Prev: Description<157>,  Up: message_hook/4

2.5.13.13 Modes and number of proofs
....................................

     message_hook(@nonvar, @nonvar, @nonvar, @list(nonvar)) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<121>,  Next: Examples<158>,  Prev: Modes and number of proofs<120>,  Up: message_hook/4

2.5.13.14 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<158>,  Prev: Errors<121>,  Up: message_hook/4

2.5.13.15 Examples
..................

     :- multifile(logtalk::message_hook/4).
     :- dynamic(logtalk::message_hook/4).

     % print silent messages instead of discarding them as default
     logtalk::message_hook(_, silent, core, Tokens) :-
         logtalk::message_prefix_stream(silent, core, Prefix, Stream),
         logtalk::print_message_tokens(Stream, Prefix, Tokens).

See also
........

*note message_prefix_stream/4: 304, *note message_tokens//2: 300, *note
print_message/3: 2fe, *note print_message_tokens/3: 7f8, *note
print_message_token/4: 7f9, *note ask_question/5: 30b, *note
question_hook/6: 30d, *note question_prompt_stream/4: 7fa.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: message_prefix_stream/4,  Next: message_prefix_file/6,  Prev: message_hook/4,  Up: Message printing

2.5.13.16 ‘message_prefix_stream/4’
...................................

* Menu:

* Description: Description<158>.
* Modes and number of proofs: Modes and number of proofs<121>.
* Errors: Errors<122>.
* Examples: Examples<159>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<158>,  Next: Modes and number of proofs<121>,  Up: message_prefix_stream/4

2.5.13.17 Description
.....................

     message_prefix_stream(Kind, Component, Prefix, Stream)

User-defined hook method for specifying the default prefix and stream
for printing a message for a given kind and *note component: 353.  This
method is declared in the logtalk(1) built-in object as a public,
multifile, and dynamic predicate.

The prefix is printed for each line in the list of tokens generated by
the message tokenization (new lines are specified using the ‘nl’ token;
see the documentation of the logtalk(2) built-in object for details).

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0

   (2) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<121>,  Next: Errors<122>,  Prev: Description<158>,  Up: message_prefix_stream/4

2.5.13.18 Modes and number of proofs
....................................

     message_prefix_stream(?nonvar, ?nonvar, ?atom, ?stream_or_alias) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<122>,  Next: Examples<159>,  Prev: Modes and number of proofs<121>,  Up: message_prefix_stream/4

2.5.13.19 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<159>,  Prev: Errors<122>,  Up: message_prefix_stream/4

2.5.13.20 Examples
..................

     :- multifile(logtalk::message_prefix_stream/4).
     :- dynamic(logtalk::message_prefix_stream/4).

     logtalk::message_prefix_stream(information, core, '% ', user_output).

See also
........

*note message_prefix_file/6: 307, *note message_hook/4: 306, *note
message_tokens//2: 300, *note print_message/3: 2fe, *note
print_message_tokens/3: 7f8, *note print_message_token/4: 7f9, *note
ask_question/5: 30b, *note question_hook/6: 30d, *note
question_prompt_stream/4: 7fa.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: message_prefix_file/6,  Next: print_message_tokens/3,  Prev: message_prefix_stream/4,  Up: Message printing

2.5.13.21 ‘message_prefix_file/6’
.................................

* Menu:

* Description: Description<159>.
* Modes and number of proofs: Modes and number of proofs<122>.
* Errors: Errors<123>.
* Examples: Examples<160>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<159>,  Next: Modes and number of proofs<122>,  Up: message_prefix_file/6

2.5.13.22 Description
.....................

     message_prefix_file(Kind, Component, Prefix, File, Mode, Options)

Experimental user-defined hook method for specifying the prefix and file
for copying messages for a given kind and *note component: 353.  This
method is declared in the logtalk(1) built-in object as a public,
multifile, and dynamic predicate.  The valid values for ‘Mode’ are
‘write’ and ‘append’.  The valid options are the same as the standard
‘open/4’ predicate.

The prefix is printed for each line in the list of tokens generated by
the message tokenization (new lines are specified using the ‘nl’ token;
see the documentation of the logtalk(2) built-in object for details).

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0

   (2) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<122>,  Next: Errors<123>,  Prev: Description<159>,  Up: message_prefix_file/6

2.5.13.23 Modes and number of proofs
....................................

     message_prefix_file(?nonvar, ?nonvar, ?atom, ?atom, ?atom, ?list(compound)) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<123>,  Next: Examples<160>,  Prev: Modes and number of proofs<122>,  Up: message_prefix_file/6

2.5.13.24 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<160>,  Prev: Errors<123>,  Up: message_prefix_file/6

2.5.13.25 Examples
..................

     :- multifile(logtalk::message_prefix_file/6).
     :- dynamic(logtalk::message_prefix_file/6).

     logtalk::message_prefix_file(comment, app, '% ', 'comments.txt', append, []).

See also
........

*note message_prefix_stream/4: 304, *note message_hook/4: 306, *note
message_tokens//2: 300, *note print_message/3: 2fe, *note
print_message_tokens/3: 7f8, *note print_message_token/4: 7f9, *note
ask_question/5: 30b, *note question_hook/6: 30d, *note
question_prompt_stream/4: 7fa.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: print_message_tokens/3,  Next: print_message_token/4,  Prev: message_prefix_file/6,  Up: Message printing

2.5.13.26 ‘print_message_tokens/3’
..................................

* Menu:

* Description: Description<160>.
* Modes and number of proofs: Modes and number of proofs<123>.
* Errors: Errors<124>.
* Examples: Examples<161>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<160>,  Next: Modes and number of proofs<123>,  Up: print_message_tokens/3

2.5.13.27 Description
.....................

     print_message_tokens(Stream, Prefix, Tokens)

Built-in method for printing a list of message tokens, declared in the
logtalk(1) built-in object as a public predicate.  This method is
automatically called by the *note print_message/3: 2fe. method (assuming
that the message was not intercepted by a *note message_hook/4: 306.
definition) and calls the user-defined hook predicate *note
print_message_token/4: 7f9. for each token.  When a call to this hook
predicate succeeds, the ‘print_message_tokens/3’ predicate assumes that
the token has been printed.  When the call fails, the
‘print_message_tokens/3’ predicate uses a default printing procedure for
the token.

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<123>,  Next: Errors<124>,  Prev: Description<160>,  Up: print_message_tokens/3

2.5.13.28 Modes and number of proofs
....................................

     print_message_tokens(@stream_or_alias, +atom, @list(nonvar)) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<124>,  Next: Examples<161>,  Prev: Modes and number of proofs<123>,  Up: print_message_tokens/3

2.5.13.29 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<161>,  Prev: Errors<124>,  Up: print_message_tokens/3

2.5.13.30 Examples
..................

     ...,
     logtalk::print_message_tokens(user_error, '% ', ['Redefining ~w ~q'-[object,foo], nl]),
     ...

See also
........

*note message_hook/4: 306, *note message_prefix_stream/4: 304, *note
message_tokens//2: 300, *note print_message/3: 2fe, *note
print_message_token/4: 7f9, *note ask_question/5: 30b, *note
question_hook/6: 30d, *note question_prompt_stream/4: 7fa.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: print_message_token/4,  Prev: print_message_tokens/3,  Up: Message printing

2.5.13.31 ‘print_message_token/4’
.................................

* Menu:

* Description: Description<161>.
* Modes and number of proofs: Modes and number of proofs<124>.
* Errors: Errors<125>.
* Examples: Examples<162>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<161>,  Next: Modes and number of proofs<124>,  Up: print_message_token/4

2.5.13.32 Description
.....................

     print_message_token(Stream, Prefix, Token, Tokens)

User-defined hook method for printing a message token, declared in the
logtalk(1) built-in object as a public, multifile, and dynamic
predicate.  It allows the user to intercept the printing of a message
token.  This hook method is automatically called by the *note
print_message_tokens/3: 7f8. built-in method for each token.

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<124>,  Next: Errors<125>,  Prev: Description<161>,  Up: print_message_token/4

2.5.13.33 Modes and number of proofs
....................................

     print_message_token(@stream_or_alias, @atom, @nonvar, @list(nonvar)) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<125>,  Next: Examples<162>,  Prev: Modes and number of proofs<124>,  Up: print_message_token/4

2.5.13.34 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<162>,  Prev: Errors<125>,  Up: print_message_token/4

2.5.13.35 Examples
..................

     :- multifile(logtalk::print_message_token/4).
     :- dynamic(logtalk::print_message_token/4).

     % ignore all flush tokens
     logtalk::print_message_token(_Stream, _Prefix, flush, _Tokens).

See also
........

*note message_hook/4: 306, *note message_prefix_stream/4: 304, *note
message_tokens//2: 300, *note print_message/3: 2fe, *note
print_message_tokens/3: 7f8, *note ask_question/5: 30b, *note
question_hook/6: 30d, *note question_prompt_stream/4: 7fa.


File: TheLogtalkHandbook-3.100.1.info,  Node: Question asking,  Prev: Message printing,  Up: Built-in methods<2>

2.5.14 Question asking
----------------------

'built-in method'

* Menu:

* ask_question/5::
* question_hook/6::
* question_prompt_stream/4::


File: TheLogtalkHandbook-3.100.1.info,  Node: ask_question/5,  Next: question_hook/6,  Up: Question asking

2.5.14.1 ‘ask_question/5’
.........................

* Menu:

* Description: Description<162>.
* Modes and number of proofs: Modes and number of proofs<125>.
* Meta-predicate template: Meta-predicate template<17>.
* Errors: Errors<126>.
* Examples: Examples<163>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<162>,  Next: Modes and number of proofs<125>,  Up: ask_question/5

2.5.14.2 Description
....................

     ask_question(Kind, Component, Question, Check, Answer)

Built-in method for asking a question represented by a term, ‘Question’,
which is converted to the question text using the *note
logtalk;;message_tokens(Question, Component): 300. hook predicate.  This
method is declared in the ‘logtalk’ built-in object as a public
predicate.  The default question prompt and the input stream used for
each ‘Kind-Component’ pair can be found using the *note
logtalk;;question_prompt_stream(Kind, Component, Prompt, Stream): 7fa.
hook predicate.  The ‘Check’ argument is a *note closure: 14f. that is
converted into a checking goal by extending it with the user supplied
answer.  This predicate implements a read-loop that terminates when the
check goal succeeds.

This predicate starts by calling the *note
logtalk;;question_hook(Question, Kind, Component, Tokens, Check,
Answer): 30d. hook predicate.  If this predicate succeeds, the
‘ask_question/5’ predicate assumes that the question have been
successfully asked and replied.


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<125>,  Next: Meta-predicate template<17>,  Prev: Description<162>,  Up: ask_question/5

2.5.14.3 Modes and number of proofs
...................................

     ask_question(+nonvar, +nonvar, +nonvar, +callable, -term) - one


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<17>,  Next: Errors<126>,  Prev: Modes and number of proofs<125>,  Up: ask_question/5

2.5.14.4 Meta-predicate template
................................

     ask_question(*, *, *, 1, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<126>,  Next: Examples<163>,  Prev: Meta-predicate template<17>,  Up: ask_question/5

2.5.14.5 Errors
...............

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<163>,  Prev: Errors<126>,  Up: ask_question/5

2.5.14.6 Examples
.................

     ...,
     logtalk::ask_question(enter_age, question, my_app, integer, Age),
     ...

See also
........

*note question_hook/6: 30d, *note question_prompt_stream/4: 7fa, *note
message_hook/4: 306, *note message_prefix_stream/4: 304, *note
message_tokens//2: 300, *note print_message/3: 2fe, *note
print_message_tokens/3: 7f8, *note print_message_token/4: 7f9.

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: question_hook/6,  Next: question_prompt_stream/4,  Prev: ask_question/5,  Up: Question asking

2.5.14.7 ‘question_hook/6’
..........................

* Menu:

* Description: Description<163>.
* Modes and number of proofs: Modes and number of proofs<126>.
* Meta-predicate template: Meta-predicate template<18>.
* Errors: Errors<127>.
* Examples: Examples<164>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<163>,  Next: Modes and number of proofs<126>,  Up: question_hook/6

2.5.14.8 Description
....................

     question_hook(Question, Kind, Component, Tokens, Check, Answer)

User-defined hook method for intercepting asking a question, declared in
the logtalk(1) built-in object as a public, multifile, and dynamic
predicate.  This hook method is automatically called by the *note
ask_question/5: 30b. method.  When the call succeeds, the
‘ask_question/5’ method assumes that the question have been successfully
asked and replied.

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<126>,  Next: Meta-predicate template<18>,  Prev: Description<163>,  Up: question_hook/6

2.5.14.9 Modes and number of proofs
...................................

     question_hook(+nonvar, +nonvar, +nonvar, +list(nonvar), +callable, -term) - zero_or_one


File: TheLogtalkHandbook-3.100.1.info,  Node: Meta-predicate template<18>,  Next: Errors<127>,  Prev: Modes and number of proofs<126>,  Up: question_hook/6

2.5.14.10 Meta-predicate template
.................................

     question_hook(*, *, *, *, 1, *)


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<127>,  Next: Examples<164>,  Prev: Meta-predicate template<18>,  Up: question_hook/6

2.5.14.11 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<164>,  Prev: Errors<127>,  Up: question_hook/6

2.5.14.12 Examples
..................

     :- multifile(logtalk::question_hook/6).
     :- dynamic(logtalk::question_hook/6).

     % use a pre-defined answer instead of asking the user
     logtalk::question_hook(upper_limit, question, my_app, _, _, 3.7).

See also
........

*note ask_question/5: 30b, *note question_prompt_stream/4: 7fa. *note
message_hook/4: 306, *note message_prefix_stream/4: 304, *note
message_tokens//2: 300, *note print_message/3: 2fe, *note
print_message_tokens/3: 7f8, *note print_message_token/4: 7f9,

'built-in method'


File: TheLogtalkHandbook-3.100.1.info,  Node: question_prompt_stream/4,  Prev: question_hook/6,  Up: Question asking

2.5.14.13 ‘question_prompt_stream/4’
....................................

* Menu:

* Description: Description<164>.
* Modes and number of proofs: Modes and number of proofs<127>.
* Errors: Errors<128>.
* Examples: Examples<165>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<164>,  Next: Modes and number of proofs<127>,  Up: question_prompt_stream/4

2.5.14.14 Description
.....................

     question_prompt_stream(Kind, Component, Prompt, Stream)

User-defined hook method for specifying the default prompt and input
stream for asking a question for a given kind and *note component: 353.
This method is declared in the logtalk(1) built-in object as a public,
multifile, and dynamic predicate.

   ---------- Footnotes ----------

   (1) ../../../apis/logtalk_0.html#logtalk-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Modes and number of proofs<127>,  Next: Errors<128>,  Prev: Description<164>,  Up: question_prompt_stream/4

2.5.14.15 Modes and number of proofs
....................................

     question_prompt_stream(?nonvar, ?nonvar, ?atom, ?stream_or_alias) - zero_or_more


File: TheLogtalkHandbook-3.100.1.info,  Node: Errors<128>,  Next: Examples<165>,  Prev: Modes and number of proofs<127>,  Up: question_prompt_stream/4

2.5.14.16 Errors
................

(none)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<165>,  Prev: Errors<128>,  Up: question_prompt_stream/4

2.5.14.17 Examples
..................

     :- multifile(logtalk::question_prompt_stream/4).
     :- dynamic(logtalk::question_prompt_stream/4).

     logtalk::question_prompt_stream(question, debugger, '    > ', user_input).

See also
........

*note ask_question/5: 30b, *note question_hook/6: 30d, *note
message_hook/4: 306, *note message_prefix_stream/4: 304, *note
message_tokens//2: 300, *note print_message/3: 2fe, *note
print_message_tokens/3: 7f8, *note print_message_token/4: 7f9.


File: TheLogtalkHandbook-3.100.1.info,  Node: Tutorial,  Next: FAQ,  Prev: Reference Manual,  Up: Top

3 Tutorial
**********

* Menu:

* List predicates::
* Dynamic object attributes::
* A reflective class-based system::
* Profiling programs::


File: TheLogtalkHandbook-3.100.1.info,  Node: List predicates,  Next: Dynamic object attributes,  Up: Tutorial

3.1 List predicates
===================

In this example, we will illustrate the use of:

   - objects

   - protocols

by using common list utility predicates.

* Menu:

* Defining a list object::
* Defining a list protocol::
* Summary::


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a list object,  Next: Defining a list protocol,  Up: List predicates

3.1.1 Defining a list object
----------------------------

We will start by defining an object, ‘list’, containing predicate
definitions for some common list predicates like ‘append/3’, ‘length/2’,
and ‘member/2’:

     :- object(list).

         :- public([
             append/3, length/2, member/2
         ]).

         append([], List, List).
         append([Head| Tail], List, [Head| Tail2]) :-
             append(Tail, List, Tail2).

         length(List, Length) :-
             length(List, 0, Length).

         length([], Length, Length).
         length([_| Tail], Acc, Length) :-
             Acc2 is Acc + 1,
             length(Tail, Acc2, Length).

         member(Element, [Element| _]).
         member(Element, [_| List]) :-
             member(Element, List).

     :- end_object.

What is different here from a regular Prolog program?  The definitions
of the list predicates are the usual ones.  We have two new directives,
*note object/1-5: 9a. and *note end_object/0: 9b, that encapsulate the
object’s code.  In Logtalk, by default, all object predicates are
private; therefore, we have to explicitly declare all predicates that we
want to be public, that is, that we want to call from outside the
object.  This is done using the *note public/1: 143. scope directive.

After we copy the object code to a text file and saved it under the name
‘list.lgt’, we need to change the Prolog working directory to the one
used to save our file (consult your Prolog compiler reference manual).
Then, after starting Logtalk (see the *note Installing and running
Logtalk: 370. section on the User Manual), we can compile and load the
object using the *note logtalk_load/1: 46. Logtalk built-in predicate:

     | ?- logtalk_load(list).

     object list loaded
     yes

We can now try goals like:

     | ?- list::member(X, [1, 2, 3]).

     X = 1;
     X = 2;
     X = 3;
     no

or:

     | ?- list::length([1, 2, 3], L).

     L = 3
     yes

The infix operator *note (;;)/2: 7e. is used in Logtalk to send a
message to an object.  The message must match a public object predicate.
If we try to call a non-public predicate such as the ‘length/3’
auxiliary predicate an exception will be generated:

     | ?- list::length([1, 2, 3], 0, L).

     uncaught exception:
         error(
             existence_error(predicate_declaration, length/3),
             logtalk(list::length([1,2,3],0,_), ...)
         )

The exception term describes the type of error and the context where the
error occurred.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a list protocol,  Next: Summary,  Prev: Defining a list object,  Up: List predicates

3.1.2 Defining a list protocol
------------------------------

As we saw in the above example, a Logtalk object may contain predicate
directives and predicate definitions (clauses).  The set of predicate
directives defines what we call the object’s 'protocol' or interface.
An interface may have several implementations.  For instance, we may
want to define a new object that implements the list predicates using
difference lists.  However, we do not want to repeat the predicate
directives in the new object.  Therefore, what we need is to split the
object’s protocol from the object’s implementation by defining a new
Logtalk entity known as a protocol.  Logtalk protocols are compilation
units, at the same level as objects and categories.  That said, let us
define a ‘listp’ protocol:

     :- protocol(listp).

         :- public([
             append/3, length/2, member/2
         ]).

     :- end_protocol.

Similar to what we have done for objects, we use the *note protocol/1-2:
dc. and *note end_protocol/0: dd. directives to encapsulate the
predicate directives.  We can improve this protocol by documenting the
call/return modes and the number of proofs of each predicate using the
*note mode/2: 149. directive:

     :- protocol(listp).

         :- public(append/3).
         :- mode(append(?list, ?list, ?list), zero_or_more).

         :- public(length/2).
         :- mode(length(?list, ?integer), zero_or_more).

         :- public(member/2).
         :- mode(member(?term, ?list), zero_or_more).

     :- end_protocol.

We now need to change our definition of the ‘list’ object by removing
the predicate directives and by declaring that the object implements the
‘listp’ protocol:

     :- object(list,
         implements(listp)).

         append([], List, List).
         append([Head| Tail], List, [Head| Tail2]) :-
             append(Tail, List, Tail2).
         ...

     :- end_object.

The protocol declared in ‘listp’ may now be alternatively implemented
using difference lists by defining a new object, ‘difflist’:

     :- object(difflist,
         implements(listp).

         append(L1-X, X-L2, L1-L2).
         ...

     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Summary,  Prev: Defining a list protocol,  Up: List predicates

3.1.3 Summary
-------------

   * It is easy to define a simple object: just write your Prolog code
     inside starting and ending object directives and add the necessary
     scope directives.  The object will be self-defining and ready to
     use.

   * Define a protocol when you may want to provide or enable several
     alternative definitions to a given set of predicates.  This way we
     avoid needless repetition of predicate directives.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dynamic object attributes,  Next: A reflective class-based system,  Prev: List predicates,  Up: Tutorial

3.2 Dynamic object attributes
=============================

In this example, we will illustrate the use of:

   - categories

   - category predicates

   - dynamic predicates

by defining a category that implements a set of predicates for handling
dynamic object attributes.

* Menu:

* Defining a category::
* Importing the category::
* Summary: Summary<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a category,  Next: Importing the category,  Up: Dynamic object attributes

3.2.1 Defining a category
-------------------------

We want to define a set of predicates to handle dynamic object
attributes.  We need public predicates to set, get, and delete
attributes, and a private dynamic predicate to store the attribute
values.  Let us name these predicates ‘set_attribute/2’ and
‘get_attribute/2’, for getting and setting an attribute value,
‘del_attribute/2’ and ‘del_attributes/2’, for deleting attributes, and
‘attribute_/2’, for storing the attributes values.

But we do not want to encapsulate these predicates in an object.  Why?
Because they are a set of useful, closely related, predicates that may
be used by several, unrelated, objects.  If defined at an object level,
we would be constrained to use inheritance in order to have the
predicates available to other objects.  Furthermore, this could force us
to use multi-inheritance or to have some kind of generic root object
containing all kinds of possible useful predicates.

For this kind of situation, Logtalk enables the programmer to
encapsulate the predicates in a 'category', so that they can be used in
any object.  A category is a Logtalk entity, at the same level as
objects and protocols.  It can contain predicate directives and
predicate definitions.  Category predicates can be imported by any
object, without code duplication and without resorting to inheritance.

When defining category predicates, we need to remember that a category
can be imported by more than one object.  Thus, calls to the built-in
methods that handle the private dynamic predicate (such as *note
assertz/1: 1b3. or *note retract/1: 1b5.) must be made either in the
context of 'self', using the 'message to self' control structure, *note
(;;)/1: 5c, or in the context of 'this' (i.e., in the context of the
object importing the category).  This way, we ensure that when we call
one of the attribute predicates on an object, the intended object own
definition of ‘attribute_/2’ will be used.  The predicate definitions
are straightforward.  For example, if opting to store the attributes in
'self':

     :- category(attributes).

         :- public(set_attribute/2).
         :- mode(set_attribute(+nonvar, +nonvar), one).

         :- public(get_attribute/2).
         :- mode(get_attribute(?nonvar, ?nonvar), zero_or_more).

         :- public(del_attribute/2).
         :- mode(del_attribute(?nonvar, ?nonvar), zero_or_more).

         :- public(del_attributes/2).
         :- mode(del_attributes(@term, @term), one).

         :- private(attribute_/2).
         :- mode(attribute_(?nonvar, ?nonvar), zero_or_more).
         :- dynamic(attribute_/2).

         set_attribute(Attribute, Value):-
             ::retractall(attribute_(Attribute, _)),
             ::assertz(attribute_(Attribute, Value)).

         get_attribute(Attribute, Value):-
             ::attribute_(Attribute, Value).

         del_attribute(Attribute, Value):-
             ::retract(attribute_(Attribute, Value)).

         del_attributes(Attribute, Value):-
             ::retractall(attribute_(Attribute, Value)).

     :- end_category.

The alternative, opting to store the attributes on 'this', is similar:
just delete the ‘(::)/1’ operator from the code above.

We have two new directives, *note category/1-4: 10e. and *note
end_category/0: 10f, that encapsulate the category code.  If needed, we
can put the predicate directives inside a protocol that will be
implemented by the category:

     :- category(attributes,
         implements(attributes_protocol)).

         ...

     :- end_category.

Any protocol can be implemented by either an object, a category, or
both.


File: TheLogtalkHandbook-3.100.1.info,  Node: Importing the category,  Next: Summary<2>,  Prev: Defining a category,  Up: Dynamic object attributes

3.2.2 Importing the category
----------------------------

We reuse a category’s predicates by importing them into an object:

     :- object(person,
         imports(attributes)).

         ...

     :- end_object.

After compiling and loading this object and our category, we can now try
queries like:

     | ?- person::set_attribute(name, paulo).

     yes

     | ?- person::set_attribute(gender, male).

     yes

     | ?- person::get_attribute(Attribute, Value).

     Attribute = name, Value = paulo ;
     Attribute = gender, Value = male ;
     no


File: TheLogtalkHandbook-3.100.1.info,  Node: Summary<2>,  Prev: Importing the category,  Up: Dynamic object attributes

3.2.3 Summary
-------------

   - Categories are similar to objects: we just write our predicate
     directives and definitions bracketed by opening and ending category
     directives.

   - An object reuses a category by importing it.  The imported
     predicates behave as if they have been defined in the object
     itself.

   - When do we use a category instead of an object?  Whenever we have a
     set of closely related predicates that we want to reuse in several,
     unrelated, objects without being constrained by inheritance
     relations.  Thus, categories can be interpreted as object building
     components.


File: TheLogtalkHandbook-3.100.1.info,  Node: A reflective class-based system,  Next: Profiling programs,  Prev: Dynamic object attributes,  Up: Tutorial

3.3 A reflective class-based system
===================================

When compiling an object, Logtalk distinguishes prototypes from
instances or classes by examining the object relations.  If an object
instantiates and/or specializes another object, then it is compiled as
an instance or class, otherwise it is compiled as a prototype.  A
consequence of this is that, in order to work with instance or classes,
we always have to define root objects for the instantiation and
specialization hierarchies (however, we are not restricted to a single
hierarchy).  The best solution is often to define a reflective
class-based system *note [Maes87]: 14, where every class is also an
object and, as such, an instance of some class.

In this example, we are going to define the basis for a reflective
class-based system, based on an extension of the ideas presented in
*note [Cointe87]: 9c.  This extension provides, along with root objects
for the instantiation and specialization hierarchies, explicit support
for abstract classes *note [Moura94]: 9d.

* Menu:

* Defining the base classes::
* Summary: Summary<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining the base classes,  Next: Summary<3>,  Up: A reflective class-based system

3.3.1 Defining the base classes
-------------------------------

We will start by defining three classes: ‘object’, ‘abstract_class’, and
‘class’.  The class ‘object’ will contain all predicates common to all
objects.  It will be the root of the inheritance graph:

     :- object(object,
         instantiates(class)).

         % predicates common to all objects

     :- end_object.

The class ‘abstract_class’ specializes ‘object’ by adding predicates
common to all classes.  It will be the default meta-class for abstract
classes:

     :- object(abstract_class,
         instantiates(class),
         specializes(object)).

         % predicates common to all classes

     :- end_object.

The class ‘class’ specializes ‘abstract_class’ by adding predicates
common to all instantiable classes.  It will be the root of the
instantiation graph and the default meta-class for instantiable classes:

     :- object(class,
         instantiates(class),
         specializes(abstract_class)).

         % predicates common to all instantiable classes

     :- end_object.

Note that all three objects are instances of class ‘class’.  The
instantiation and specialization relationships are chosen so that each
object may use the predicates defined in itself and in the other two
objects, with no danger of *note message lookup: 37. endless loops.


File: TheLogtalkHandbook-3.100.1.info,  Node: Summary<3>,  Prev: Defining the base classes,  Up: A reflective class-based system

3.3.2 Summary
-------------

   - An object that does not instantiate or specialize other objects is
     always compiled as a prototype.

   - An instance must instantiate at least one object (its class).
     Similarly, a class must at least specialize or instantiate other
     object.

   - The distinction between abstract classes and instantiable classes
     is an operational one, depending on the class inherited methods.  A
     class is instantiable if inherits methods for creating instances.
     Conversely, a class is abstract if does not inherit any instance
     creation method.


File: TheLogtalkHandbook-3.100.1.info,  Node: Profiling programs,  Prev: A reflective class-based system,  Up: Tutorial

3.4 Profiling programs
======================

In this example, we will illustrate the use of:

   - events

   - monitors

by defining a simple profiler that prints the starting and ending time
for processing a message sent to an object.

* Menu:

* Messages as events::
* Profilers as monitors::
* Summary: Summary<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Messages as events,  Next: Profilers as monitors,  Up: Profiling programs

3.4.1 Messages as events
------------------------

In a pure object-oriented system, all computations start by sending
messages to objects.  We can thus define an 'event' as the sending of a
message to an object.  An event can then be specified by the tuple
‘(Object, Message, Sender)’.  This definition can be refined by
interpreting the sending of a message and the return of the control to
the object that has sent the message as two distinct events.  We call
these events respectively ‘before’ and ‘after’.  Therefore, we end up by
representing an event by the tuple ‘(Event, Object, Message, Sender)’.
For instance, if we send the message:

     | ?- foo::bar(X).

     X = 1
     yes

the two corresponding events will be:

     (before, foo, bar(X), user)
     (after, foo, bar(1), user)

Note that the second event is only generated if the message succeeds.
If the message as a goal has multiple solutions, then an ‘after’ event
will be generated for each solution.

Events are automatically generated by the message-sending mechanisms for
each public message sent using the *note (;;)/2: 7e. operator.


File: TheLogtalkHandbook-3.100.1.info,  Node: Profilers as monitors,  Next: Summary<4>,  Prev: Messages as events,  Up: Profiling programs

3.4.2 Profilers as monitors
---------------------------

A monitor is an object that reacts whenever a spied event occurs.  The
monitor actions are defined by two event handlers: *note before/3: 101.
for ‘before’ events and *note after/3: 102. for ‘after’ events.  These
predicates are automatically called by the message-sending mechanisms
when an event registered for the monitor occurs.  These event handlers
are declared as public predicates in the ‘monitoring’ built-in protocol.

In our example, we need a way to get the current time before and after
we process a message.  We will assume that we have a ‘time’ object
implementing a ‘cpu_time/1’ predicate that returns the current CPU time
for the Prolog session:

     :- object(time).

         :- public(cpu_time/1).
         :- mode(cpu_time(-number), one).
         ...

     :- end_object.

Our profiler will be named ‘stop_watch’.  It must define event handlers
for the ‘before’ and ‘after’ events that will print the event
description (object, message, and sender) and the current time:

     :- object(stop_watch,
         % event handler predicates protocol
         implements(monitoring)).

         :- uses(time, [cpu_time/1]).

         before(Object, Message, Sender) :-
             write(Object), write(' <-- '), writeq(Message),
             write(' from '), write(Sender), nl, write('STARTING at '),
             cpu_time(Seconds), write(Seconds), write(' seconds'), nl.

         after(Object, Message, Sender) :-
             write(Object), write(' <-- '), writeq(Message),
             write(' from '), write(Sender), nl, write('ENDING at '),
             cpu_time(Seconds), write(Seconds), write(' seconds'), nl.

     :- end_object.

After compiling and loading the ‘stop_watch’ object (and the objects
that we want to profile), we can use the *note define_events/5: 218.
built-in predicate to set up our profiler.  For example, to profile all
messages that are sent to the object ‘foo’, we need to call the goal:

     | ?- define_events(_, foo, _, _, stop_watch).

     yes

This call will register ‘stop_watch’ as a monitor to all messages sent
to object ‘foo’, for both ‘before’ and ‘after’ events.  Note that we say
“as a monitor”, not “the monitor”: we can have any number of monitors
over the same events.

From now on, every time we sent a message to ‘foo’, the ‘stop_watch’
monitor will print the starting and ending times for the message
execution.  For instance:

     | ?- foo::bar(X).

     foo <-- bar(X) from user
     STARTING at 12.87415 seconds
     foo <-- bar(1) from user
     ENDING at 12.87419 seconds

     X = 1
     yes

To stop profiling the messages sent to ‘foo’ we use the *note
abolish_events/5: 21b. built-in predicate:

     | ?- abolish_events(_, foo, _, _, stop_watch).

     yes

This call will abolish all events defined over the object ‘foo’ assigned
to the ‘stop_watch’ monitor.


File: TheLogtalkHandbook-3.100.1.info,  Node: Summary<4>,  Prev: Profilers as monitors,  Up: Profiling programs

3.4.3 Summary
-------------

   - An event is defined as the sending of a (public) message to an
     object.

   - There are two kinds of events: ‘before’ events, generated before a
     message is processed, and ‘after’ events, generated after the
     message processing has completed successfully.

   - Any object can be declared as a monitor to any event.  A monitor
     shall reference the ‘monitoring’ built-in protocol in the object
     opening directive.

   - A monitor defines event handlers, the predicates *note before/3:
     101. and *note after/3: 102, that are automatically called by the
     runtime engine when a spied event occurs.

   - Three built-in predicates, *note define_events/5: 218, *note
     current_event/5: 21e, and *note abolish_events/5: 21b, enables us
     to define, query, and abolish both events and monitors.


File: TheLogtalkHandbook-3.100.1.info,  Node: FAQ,  Next: Developer Tools,  Prev: Tutorial,  Up: Top

4 FAQ
*****

* Menu:

* General::
* Compatibility::
* Installation::
* Portability::
* Programming::
* Troubleshooting::
* Usability::
* Deployment::
* Performance: Performance<3>.
* Licensing::
* Support::


File: TheLogtalkHandbook-3.100.1.info,  Node: General,  Next: Compatibility,  Up: FAQ

4.1 General
===========

   * *note Why are all versions of Logtalk numbered 2.x or 3.x?: 857.

   * *note Why do I need a Prolog compiler to use Logtalk?: 858.

   * *note Is the Logtalk implementation based on Prolog modules?: 859.

   * *note Does the Logtalk implementation use term-expansion?: 85a.

* Menu:

* Why are all versions of Logtalk numbered 2.x or 3.x?: Why are all versions of Logtalk numbered 2 x or 3 x?.
* Why do I need a Prolog compiler to use Logtalk?::
* Is the Logtalk implementation based on Prolog modules?::
* Does the Logtalk implementation use term-expansion?::


File: TheLogtalkHandbook-3.100.1.info,  Node: Why are all versions of Logtalk numbered 2 x or 3 x?,  Next: Why do I need a Prolog compiler to use Logtalk?,  Up: General

4.1.1 Why are all versions of Logtalk numbered 2.x or 3.x?
----------------------------------------------------------

The numbers “2” and “3” in the Logtalk version string refer to,
respectively, the second and the third generations of the Logtalk
language.  Development of Logtalk 2 started in January 1998, with the
first alpha release for registered users in July and the first public
beta on October.  The first stable version of Logtalk 2 was released in
February 9, 1999.  Development of Logtalk 3 started in April 2012, with
the first public alpha released in August 21, 2012.  The first stable
version of Logtalk 3 was released in January 7, 2015.


File: TheLogtalkHandbook-3.100.1.info,  Node: Why do I need a Prolog compiler to use Logtalk?,  Next: Is the Logtalk implementation based on Prolog modules?,  Prev: Why are all versions of Logtalk numbered 2 x or 3 x?,  Up: General

4.1.2 Why do I need a Prolog compiler to use Logtalk?
-----------------------------------------------------

Currently, the Logtalk language is implemented as a 'trans-compiler' to
Prolog instead of as a standalone compiler.  Compilation of Logtalk
source files is performed in two steps.  First, the Logtalk compiler
converts a source file to a Prolog file.  Second, the chosen Prolog
compiler is called by Logtalk to compile the intermediate Prolog file
generated on the first step.  The implementation of Logtalk as a
trans-compiler allows users to use Logtalk together with features only
available on specific Prolog compilers.


File: TheLogtalkHandbook-3.100.1.info,  Node: Is the Logtalk implementation based on Prolog modules?,  Next: Does the Logtalk implementation use term-expansion?,  Prev: Why do I need a Prolog compiler to use Logtalk?,  Up: General

4.1.3 Is the Logtalk implementation based on Prolog modules?
------------------------------------------------------------

No.  Logtalk is (currently) implemented in plain Prolog code.  Only a
few Prolog compilers include a module system, with several compatibility
problems between them.  Moreover, the current ISO Prolog standard for
modules is next to worthless and is ignored by most of the Prolog
community.  Nevertheless, the Logtalk compiler is able to compile simple
modules (using a common subset of module directives) as objects for
backward-compatibility with existing code (see the *note Prolog
integration and migration: 389. for details).


File: TheLogtalkHandbook-3.100.1.info,  Node: Does the Logtalk implementation use term-expansion?,  Prev: Is the Logtalk implementation based on Prolog modules?,  Up: General

4.1.4 Does the Logtalk implementation use term-expansion?
---------------------------------------------------------

No.  Term-expansion mechanisms are not standard and are not available in
all supported Prolog compilers.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compatibility,  Next: Installation,  Prev: General,  Up: FAQ

4.2 Compatibility
=================

   * *note What are the backend Prolog compiler requirements to run
     Logtalk?: 862.

   * *note Can I use constraint-based packages with Logtalk?: 863.

   * *note Can I use Logtalk objects and Prolog modules at the same
     time?: 864.

* Menu:

* What are the backend Prolog compiler requirements to run Logtalk?::
* Can I use constraint-based packages with Logtalk?::
* Can I use Logtalk objects and Prolog modules at the same time?::


File: TheLogtalkHandbook-3.100.1.info,  Node: What are the backend Prolog compiler requirements to run Logtalk?,  Next: Can I use constraint-based packages with Logtalk?,  Up: Compatibility

4.2.1 What are the backend Prolog compiler requirements to run Logtalk?
-----------------------------------------------------------------------

See the backend Prolog compiler requirements guide(1).

   ---------- Footnotes ----------

   (1) https://logtalk.org/backend_requirements.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Can I use constraint-based packages with Logtalk?,  Next: Can I use Logtalk objects and Prolog modules at the same time?,  Prev: What are the backend Prolog compiler requirements to run Logtalk?,  Up: Compatibility

4.2.2 Can I use constraint-based packages with Logtalk?
-------------------------------------------------------

Usually, yes.  Some constraint-based packages may define operators which
clash with the ones defined by Logtalk.  In these cases, compatibility
with Logtalk depends on the constraint-based packages providing an
alternative for accessing the functionality provided by those operators.
When the constraint solver is encapsulated using a Prolog module, a
possible workaround is to use either explicit module qualification or
encapsulate the call using the *note {}/1: 191. control construct (thus
bypassing the Logtalk compiler).


File: TheLogtalkHandbook-3.100.1.info,  Node: Can I use Logtalk objects and Prolog modules at the same time?,  Prev: Can I use constraint-based packages with Logtalk?,  Up: Compatibility

4.2.3 Can I use Logtalk objects and Prolog modules at the same time?
--------------------------------------------------------------------

Yes.  In order to call a module predicate from within an object (or
category) you may use an *note use_module/2: 4d. directive or use
explicit module qualification (possibly wrapping the call using the
Logtalk control construct *note {}/1: 191. that allows bypassing of the
Logtalk compiler when compiling a predicate call).  Logtalk also allows
modules to be compiled as objects (see the *note Prolog integration and
migration: 389. for details).


File: TheLogtalkHandbook-3.100.1.info,  Node: Installation,  Next: Portability,  Prev: Compatibility,  Up: FAQ

4.3 Installation
================

   * *note The integration scripts/shortcuts are not working!: 86b.

   * *note I get errors when starting up Logtalk after upgrading to the
     latest version!: 86c.

* Menu:

* The integration scripts/shortcuts are not working!::
* I get errors when starting up Logtalk after upgrading to the latest version!::


File: TheLogtalkHandbook-3.100.1.info,  Node: The integration scripts/shortcuts are not working!,  Next: I get errors when starting up Logtalk after upgrading to the latest version!,  Up: Installation

4.3.1 The integration scripts/shortcuts are not working!
--------------------------------------------------------

Check that the ‘LOGTALKHOME’ and ‘LOGTALKUSER’ environment variables are
defined, that the Logtalk user folder is available in the location
pointed by ‘LOGTALKUSER’ (you can create this folder by running the
‘logtalk_user_setup’ shell script), and that the Prolog compilers that
you want to use are supported and available from the system path.  If
the problem persists, run the shell script that creates the integration
script or shortcut manually and check for any error message or
additional instructions.  For some Prolog compilers such as XSB and
Ciao, the first call of the integration script or shortcut must be made
by an administrator user.  If you are using Windows, make sure that any
anti-virus or other security software that you might have installed is
not silently blocking some of the installer tasks.


File: TheLogtalkHandbook-3.100.1.info,  Node: I get errors when starting up Logtalk after upgrading to the latest version!,  Prev: The integration scripts/shortcuts are not working!,  Up: Installation

4.3.2 I get errors when starting up Logtalk after upgrading to the latest version!
----------------------------------------------------------------------------------

Changes in the Logtalk compiler between releases may render Prolog
adapter files from older versions incompatible with new ones.  You may
need to update your local Logtalk user files by running e.g.  the
‘logtalk_user_setup’ shell script.  Check the ‘UPGRADING.md’ file on the
root of the Logtalk installation directory and the release notes for any
incompatible changes to the adapter files.


File: TheLogtalkHandbook-3.100.1.info,  Node: Portability,  Next: Programming,  Prev: Installation,  Up: FAQ

4.4 Portability
===============

   * *note Are my Logtalk applications portable across Prolog
     compilers?: 872.

   * *note Are my Logtalk applications portable across operating
     systems?: 873.

* Menu:

* Are my Logtalk applications portable across Prolog compilers?::
* Are my Logtalk applications portable across operating systems?::


File: TheLogtalkHandbook-3.100.1.info,  Node: Are my Logtalk applications portable across Prolog compilers?,  Next: Are my Logtalk applications portable across operating systems?,  Up: Portability

4.4.1 Are my Logtalk applications portable across Prolog compilers?
-------------------------------------------------------------------

Yes, as long you don’t use built-in predicates or special features only
available on some Prolog compilers.  There is a *note portability: 1d1.
compiler flag that you can set to instruct Logtalk to print a warning
for each occurrence of non-ISO Prolog standard features such as
proprietary built-in predicates.  In addition, it is advisable that you
constrain, if possible, the use of platform or compiler dependent code
to a small number of objects with clearly defined protocols.  You may
also use Logtalk support for conditional compilation to compile
different entity or predicate definitions depending on the backend
Prolog compiler being used.


File: TheLogtalkHandbook-3.100.1.info,  Node: Are my Logtalk applications portable across operating systems?,  Prev: Are my Logtalk applications portable across Prolog compilers?,  Up: Portability

4.4.2 Are my Logtalk applications portable across operating systems?
--------------------------------------------------------------------

Yes, as long you don’t use built-in predicates or special features that
your chosen backend Prolog compiler only supports on some
operating-systems.  You may need to change the end-of-line characters of
your source files to match the ones on the target operating system and
the expectations of your Prolog compiler.  Some Prolog compilers
silently fail to compile source files with the wrong end-of-line
characters.


File: TheLogtalkHandbook-3.100.1.info,  Node: Programming,  Next: Troubleshooting,  Prev: Portability,  Up: FAQ

4.5 Programming
===============

   * *note Should I use prototypes or classes in my application?: 879.

   * *note Can I use both classes and prototypes in the same
     application?: 87a.

   * *note Can I mix classes and prototypes in the same hierarchy?: 87b.

   * *note Can I use a protocol or a category with both prototypes and
     classes?: 87c.

   * *note What support is provided in Logtalk for defining and using
     components?: 87d.

   * *note What support is provided in Logtalk for reflective
     programming?: 87e.

* Menu:

* Should I use prototypes or classes in my application?::
* Can I use both classes and prototypes in the same application?::
* Can I mix classes and prototypes in the same hierarchy?::
* Can I use a protocol or a category with both prototypes and classes?::
* What support is provided in Logtalk for defining and using components?::
* What support is provided in Logtalk for reflective programming?::


File: TheLogtalkHandbook-3.100.1.info,  Node: Should I use prototypes or classes in my application?,  Next: Can I use both classes and prototypes in the same application?,  Up: Programming

4.5.1 Should I use prototypes or classes in my application?
-----------------------------------------------------------

Prototypes and classes provide different patterns of code reuse.  A
prototype encapsulates code that can be used by itself and by its
descendent prototypes.  A class encapsulates code to be used by its
descendent instances.  Prototypes provide the best replacement to the
use of modules as encapsulation units, avoiding the need to instantiate
a class in order to access its code.


File: TheLogtalkHandbook-3.100.1.info,  Node: Can I use both classes and prototypes in the same application?,  Next: Can I mix classes and prototypes in the same hierarchy?,  Prev: Should I use prototypes or classes in my application?,  Up: Programming

4.5.2 Can I use both classes and prototypes in the same application?
--------------------------------------------------------------------

Yes.  In addition, you may freely exchange messages between prototypes,
classes, and instances.


File: TheLogtalkHandbook-3.100.1.info,  Node: Can I mix classes and prototypes in the same hierarchy?,  Next: Can I use a protocol or a category with both prototypes and classes?,  Prev: Can I use both classes and prototypes in the same application?,  Up: Programming

4.5.3 Can I mix classes and prototypes in the same hierarchy?
-------------------------------------------------------------

No.  However, you may define as many prototype hierarchies and class
hierarchies and classes as needed by your application.


File: TheLogtalkHandbook-3.100.1.info,  Node: Can I use a protocol or a category with both prototypes and classes?,  Next: What support is provided in Logtalk for defining and using components?,  Prev: Can I mix classes and prototypes in the same hierarchy?,  Up: Programming

4.5.4 Can I use a protocol or a category with both prototypes and classes?
--------------------------------------------------------------------------

Yes.  A protocol may be implemented by both prototypes and classes in
the same application.  Likewise, a category may be imported by both
prototypes and classes in the same application.


File: TheLogtalkHandbook-3.100.1.info,  Node: What support is provided in Logtalk for defining and using components?,  Next: What support is provided in Logtalk for reflective programming?,  Prev: Can I use a protocol or a category with both prototypes and classes?,  Up: Programming

4.5.5 What support is provided in Logtalk for defining and using components?
----------------------------------------------------------------------------

Logtalk supports component-based programming (since its inception on
January 1998), by using 'categories' (which are first-class entities
like objects and protocols).  Logtalk categories can be used with both
classes and prototypes and are inspired by the Smalltalk-80
(documentation-only) concept of method categories and by Objective-C
categories, hence the name.  For more information, please consult the
*note Categories: 109. section and the examples provided with the
distribution.


File: TheLogtalkHandbook-3.100.1.info,  Node: What support is provided in Logtalk for reflective programming?,  Prev: What support is provided in Logtalk for defining and using components?,  Up: Programming

4.5.6 What support is provided in Logtalk for reflective programming?
---------------------------------------------------------------------

Logtalk supports meta-classes, behavioral reflection through the use of
event-driven programming, and structural reflection through the use of a
set of built-in predicates and built-in methods which allow us to query
the system about existing entities, entity relations, and entity
predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Troubleshooting,  Next: Usability,  Prev: Programming,  Up: FAQ

4.6 Troubleshooting
===================

   * *note Using compiler options on calls to the Logtalk compiling and
     loading predicates does not work!: 888.

   * *note Gecko-based browsers (e.g., Firefox) show non-rendered HTML
     entities when browsing XML documenting files!: 889.

   * *note Compiling a source file results in errors or warnings but the
     Logtalk compiler reports a successful compilation with zero errors
     and zero warnings!: 88a.

* Menu:

* Using compiler options on calls to the Logtalk compiling and loading predicates does not work!::
* Gecko-based browsers (e.g., Firefox) show non-rendered HTML entities when browsing XML documenting files!: Gecko-based browsers e g Firefox show non-rendered HTML entities when browsing XML documenting files!.
* Compiling a source file results in errors or warnings but the Logtalk compiler reports a successful compilation with zero errors and zero warnings!::


File: TheLogtalkHandbook-3.100.1.info,  Node: Using compiler options on calls to the Logtalk compiling and loading predicates does not work!,  Next: Gecko-based browsers e g Firefox show non-rendered HTML entities when browsing XML documenting files!,  Up: Troubleshooting

4.6.1 Using compiler options on calls to the Logtalk compiling and loading predicates does not work!
----------------------------------------------------------------------------------------------------

Using compiler options on calls to the Logtalk *note logtalk_compile/2:
2b2. and *note logtalk_load/2: 4e. built-in predicates only apply to the
file being compiled.  If the first argument is a *note loader file: 4f,
the compiler options will only be used in the compilation of the loader
file itself, not in the compilation of the files loaded by the loader
file.  The solution is to edit the loader file and add the compiler
options to the calls that compile/load the individual files.


File: TheLogtalkHandbook-3.100.1.info,  Node: Gecko-based browsers e g Firefox show non-rendered HTML entities when browsing XML documenting files!,  Next: Compiling a source file results in errors or warnings but the Logtalk compiler reports a successful compilation with zero errors and zero warnings!,  Prev: Using compiler options on calls to the Logtalk compiling and loading predicates does not work!,  Up: Troubleshooting

4.6.2 Gecko-based browsers (e.g., Firefox) show non-rendered HTML entities when browsing XML documenting files!
---------------------------------------------------------------------------------------------------------------

Using Gecko-based browsers (e.g., Firefox) show non-rendered HTML
entities (e.g., ‘&ndash;’) when browsing XML documenting files after
running the ‘lgt2xml’ shell script in the directory containing the XML
documenting files.  This is a consequence of the lack of support for the
‘disable-output-escaping’ attribute in the browser XSLT processor.  The
workaround is to use another browser (e.g., Safari or Opera) or to use
instead the ‘lgt2html’ shell script in the directory containing the XML
documenting files to convert them to (X)HTML files for browsing.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiling a source file results in errors or warnings but the Logtalk compiler reports a successful compilation with zero errors and zero warnings!,  Prev: Gecko-based browsers e g Firefox show non-rendered HTML entities when browsing XML documenting files!,  Up: Troubleshooting

4.6.3 Compiling a source file results in errors or warnings but the Logtalk compiler reports a successful compilation with zero errors and zero warnings!
---------------------------------------------------------------------------------------------------------------------------------------------------------

This may happen when your Prolog compiler implementation of the ISO
Prolog standard ‘write_canonical/2’ built-in predicate is buggy and
writes terms that cannot be read back when consulting the intermediate
Prolog files generated by the Logtalk compiler.  Often, syntax errors
found when consulting result in error messages but not in exceptions as
the Prolog compiler tries to continue the compilation despite the
problems found.  As the Logtalk compiler relies on the exception
mechanisms to catch compilation problems, it may report zero errors and
zero warnings despite the error messages.  Send a bug report to the
Prolog compiler developers asking them to fix the ‘write_canonical/2’
buggy implementation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usability,  Next: Deployment,  Prev: Troubleshooting,  Up: FAQ

4.7 Usability
=============

   * *note Is there a shortcut for compiling and loading source files?:
     891.

   * *note Is there an equivalent directive to the ensure_loaded/1
     Prolog directive?: 892.

   * *note Are there shortcuts for the make functionality?: 893.

* Menu:

* Is there a shortcut for compiling and loading source files?::
* Is there an equivalent directive to the ensure_loaded/1 Prolog directive?::
* Are there shortcuts for the make functionality?::


File: TheLogtalkHandbook-3.100.1.info,  Node: Is there a shortcut for compiling and loading source files?,  Next: Is there an equivalent directive to the ensure_loaded/1 Prolog directive?,  Up: Usability

4.7.1 Is there a shortcut for compiling and loading source files?
-----------------------------------------------------------------

Yes.  With most backend Prolog compilers, you can use ‘{File}’ as a
shortcut for ‘logtalk_load(File)’.  For compiling and loading multiple
files simply use ‘{File1, File2, ...}’.  See the documentation of the
*note logtalk_load/1: 46. predicate for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Is there an equivalent directive to the ensure_loaded/1 Prolog directive?,  Next: Are there shortcuts for the make functionality?,  Prev: Is there a shortcut for compiling and loading source files?,  Up: Usability

4.7.2 Is there an equivalent directive to the ‘ensure_loaded/1’ Prolog directive?
---------------------------------------------------------------------------------

You can use the goal ‘logtalk_load(File, [reload(skip)])’ to ensure that
‘File’ it is only loaded once.  See the documentation of the *note
logtalk_load/2: 4e. predicate for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Are there shortcuts for the make functionality?,  Prev: Is there an equivalent directive to the ensure_loaded/1 Prolog directive?,  Up: Usability

4.7.3 Are there shortcuts for the make functionality?
-----------------------------------------------------

Yes.  With most backend Prolog compilers, you can use ‘{*}’ as a
shortcut for ‘logtalk_make(all)’ to reload all files modified since last
compiled and loaded, ‘{!}’ as a shortcut for ‘logtalk_make(clean)’ to
delete all intermediate Prolog files generated by the compilation of
Logtalk source files, ‘{?}’ as a shortcut for ‘logtalk_make(missing)’ to
list missing entities and predicates, and ‘{@}’ as a shortcut for
‘logtalk_make(circular)’ to list circular references.  See the
documentation of the *note logtalk_make/1: 2a0. predicate for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Deployment,  Next: Performance<3>,  Prev: Usability,  Up: FAQ

4.8 Deployment
==============

   * *note Can I create standalone applications with Logtalk?: 89a.

* Menu:

* Can I create standalone applications with Logtalk?::


File: TheLogtalkHandbook-3.100.1.info,  Node: Can I create standalone applications with Logtalk?,  Up: Deployment

4.8.1 Can I create standalone applications with Logtalk?
--------------------------------------------------------

It depends on the Prolog compiler that you use to run Logtalk.  Assuming
that your Prolog compiler supports the creation of standalone
executables, your application must include the adapter file for your
compiler and the Logtalk compiler and runtime.  The distribution
includes embedding scripts for selected backend Prolog compilers and
embedding examples.

For instructions on how to embed Logtalk and Logtalk applications, see
the embedding guide(1).

   ---------- Footnotes ----------

   (1) https://logtalk.org/embedding.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Performance<3>,  Next: Licensing,  Prev: Deployment,  Up: FAQ

4.9 Performance
===============

   * *note Is Logtalk implemented as a meta-interpreter?: 89f.

   * *note What kind of code Logtalk generates when compiling objects?
     Dynamic code?  Static code?: 8a0.

   * *note How about message-sending performance?  Does Logtalk use
     static binding or dynamic binding?: 8a1.

   * *note How does Logtalk performance compare with plain Prolog and
     with Prolog modules?: 8a2.

* Menu:

* Is Logtalk implemented as a meta-interpreter?::
* What kind of code Logtalk generates when compiling objects? Dynamic code? Static code?::
* How about message-sending performance? Does Logtalk use static binding or dynamic binding?::
* Which Prolog-dependent factors are most crucial for good Logtalk performance?::
* How does Logtalk performance compare with plain Prolog and with Prolog modules?::


File: TheLogtalkHandbook-3.100.1.info,  Node: Is Logtalk implemented as a meta-interpreter?,  Next: What kind of code Logtalk generates when compiling objects? Dynamic code? Static code?,  Up: Performance<3>

4.9.1 Is Logtalk implemented as a meta-interpreter?
---------------------------------------------------

No.  Objects and their encapsulated predicates are compiled, not
meta-interpreted.  In particular, inheritance relations are pre-compiled
for improved performance.  Moreover, no meta-interpreter is used even
for objects compiled in debug mode.


File: TheLogtalkHandbook-3.100.1.info,  Node: What kind of code Logtalk generates when compiling objects? Dynamic code? Static code?,  Next: How about message-sending performance? Does Logtalk use static binding or dynamic binding?,  Prev: Is Logtalk implemented as a meta-interpreter?,  Up: Performance<3>

4.9.2 What kind of code Logtalk generates when compiling objects? Dynamic code? Static code?
--------------------------------------------------------------------------------------------

Static objects are compiled to static code.  Static objects containing
dynamic predicates are also compiled to static code, except, of course,
for the dynamic predicates themselves.  Dynamic objects are necessarily
compiled to dynamic code.  As in Prolog programming, for best
performance, dynamic object predicates and dynamic objects should only
be used when truly needed.


File: TheLogtalkHandbook-3.100.1.info,  Node: How about message-sending performance? Does Logtalk use static binding or dynamic binding?,  Next: Which Prolog-dependent factors are most crucial for good Logtalk performance?,  Prev: What kind of code Logtalk generates when compiling objects? Dynamic code? Static code?,  Up: Performance<3>

4.9.3 How about message-sending performance? Does Logtalk use static binding or dynamic binding?
------------------------------------------------------------------------------------------------

Logtalk supports both static binding and dynamic binding.  When static
binding is not possible, Logtalk uses dynamic binding coupled with a
caching mechanism that avoids repeated lookups of predicate declarations
and predicate definitions.  This is a solution common to other
programming languages supporting dynamic binding.  Message lookups are
automatically cached the first time a message is sent.  Cache entries
are automatically removed when loading entities or using Logtalk dynamic
features that invalidate the cached lookups.  Whenever static binding is
used, message-sending performance is essentially the same as a predicate
call in plain Prolog.  Performance of dynamic binding when lookups are
cached is close to the performance that would be achieved with static
binding.  See the User Manual section on *note performance: 38. for more
details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Which Prolog-dependent factors are most crucial for good Logtalk performance?,  Next: How does Logtalk performance compare with plain Prolog and with Prolog modules?,  Prev: How about message-sending performance? Does Logtalk use static binding or dynamic binding?,  Up: Performance<3>

4.9.4 Which Prolog-dependent factors are most crucial for good Logtalk performance?
-----------------------------------------------------------------------------------

Logtalk compiles objects assuming first-argument indexing for static
code.  First-argument indexing of dynamic code, when available, helps to
improve performance due to the automatic caching of method lookups and
the necessary use of book-keeping tables by the runtime engine (this is
specially important when using event-driven programming).  Dynamic
objects and static objects containing dynamic predicates also benefit
from first-argument indexing of dynamic predicates.  The availability of
multi-argument indexing, notably for dynamic predicates, also benefits
dynamic binding performance.


File: TheLogtalkHandbook-3.100.1.info,  Node: How does Logtalk performance compare with plain Prolog and with Prolog modules?,  Prev: Which Prolog-dependent factors are most crucial for good Logtalk performance?,  Up: Performance<3>

4.9.5 How does Logtalk performance compare with plain Prolog and with Prolog modules?
-------------------------------------------------------------------------------------

Plain Prolog, Prolog modules, and Logtalk objects provide different
trade-offs between performance and features.  In general, for a given
predicate definition, the best performance will be attained using plain
Prolog, second will be Prolog modules (assuming no explicitly qualified
calls are used), and finally Logtalk objects.  Whenever static binding
is used, the performance of Logtalk is equal or close to that of plain
Prolog (depending on the Prolog virtual machine implementation and
compiler optimizations).  See the simple benchmark test results(1) using
some popular Prolog compilers.

   ---------- Footnotes ----------

   (1) https://logtalk.org/performance.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Licensing,  Next: Support,  Prev: Performance<3>,  Up: FAQ

4.10 Licensing
==============

   * *note What’s the Logtalk distribution license?: 8ab.

   * *note Can Logtalk be used in commercial applications?: 8ac.

   * *note What’s the final license for a combination of Logtalk with a
     Prolog compiler?: 8ad.

* Menu:

* What’s the Logtalk distribution license?::
* Can Logtalk be used in commercial applications?::
* What’s the final license for a combination of Logtalk with a Prolog compiler?::


File: TheLogtalkHandbook-3.100.1.info,  Node: What’s the Logtalk distribution license?,  Next: Can Logtalk be used in commercial applications?,  Up: Licensing

4.10.1 What’s the Logtalk distribution license?
-----------------------------------------------

Logtalk follows the Apache License 2.0(1).

   ---------- Footnotes ----------

   (1) https://github.com/LogtalkDotOrg/logtalk3/blob/master/LICENSE.txt


File: TheLogtalkHandbook-3.100.1.info,  Node: Can Logtalk be used in commercial applications?,  Next: What’s the final license for a combination of Logtalk with a Prolog compiler?,  Prev: What’s the Logtalk distribution license?,  Up: Licensing

4.10.2 Can Logtalk be used in commercial applications?
------------------------------------------------------

Yes, the Apache License 2.0 allows commercial use.  See e.g.  the Apache
License and Distribution FAQ(1).

   ---------- Footnotes ----------

   (1) https://www.apache.org/foundation/license-faq.html


File: TheLogtalkHandbook-3.100.1.info,  Node: What’s the final license for a combination of Logtalk with a Prolog compiler?,  Prev: Can Logtalk be used in commercial applications?,  Up: Licensing

4.10.3 What’s the final license for a combination of Logtalk with a Prolog compiler?
------------------------------------------------------------------------------------

See the licensing guide(1) for details and relevant resources.

   ---------- Footnotes ----------

   (1) https://logtalk.org/licensing.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Support,  Prev: Licensing,  Up: FAQ

4.11 Support
============

   * *note Are there professional consulting, training and supporting
     services?: 8b4.

* Menu:

* Are there professional consulting, training and supporting services?: Are there professional consulting training and supporting services?.


File: TheLogtalkHandbook-3.100.1.info,  Node: Are there professional consulting training and supporting services?,  Up: Support

4.11.1 Are there professional consulting, training and supporting services?
---------------------------------------------------------------------------

Yes.  Please visit logtalk.pt(1) for professional consulting,
development, training, and other support services.

   ---------- Footnotes ----------

   (1) https://logtalk.org


File: TheLogtalkHandbook-3.100.1.info,  Node: Developer Tools,  Next: Libraries,  Prev: FAQ,  Up: Top

5 Developer Tools
*****************

The documentation of each developer tool can also be found in the tool
directory in the ‘NOTES.md’ file.

* Menu:

* Overview::
* asdf::
* assertions::
* code_metrics::
* dead_code_scanner::
* debug_messages::
* debugger::
* diagrams::
* doclet::
* help::
* issue_creator::
* lgtdoc::
* lgtunit::
* linter::
* linter_reporter::
* make::
* mutation_testing::
* packs::
* ports_profiler::
* profiler::
* sarif::
* sbom::
* tool_diagnostics::
* tutor::
* wrapper::


File: TheLogtalkHandbook-3.100.1.info,  Node: Overview,  Next: asdf,  Up: Developer Tools

5.1 Overview
============

The following developer tools are available, each one with its own
‘loader.lgt’ loader file (except for the built-in ‘linter’ and ‘make’
tools, which are integrated with the compiler/runtime) and ‘NOTES.md’
documentation files:

   - ‘asdf’

   - ‘assertions’

   - ‘code_metrics’

   - ‘dead_code_scanner’

   - ‘debug_messages’

   - ‘debugger’

   - ‘diagrams’

   - ‘doclet’

   - ‘help’

   - ‘issue_creator’

   - ‘lgtdoc’

   - ‘lgtunit’

   - ‘linter’

   - ‘linter_reporter’

   - ‘make’

   - ‘mutation_testing’

   - ‘packs’

   - ‘ports_profiler’

   - ‘profiler’

   - ‘sarif’

   - ‘sbom’

   - ‘tool_diagnostics’

   - ‘tutor’

   - ‘wrapper’

* Menu:

* Loading the developer tools::
* Tools documentation::
* Tools common flags::
* Tools requirements::


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading the developer tools,  Next: Tools documentation,  Up: Overview

5.1.1 Loading the developer tools
---------------------------------

To load the main developer tools, use the following goal:

     | ?- logtalk_load(tools(loader)).

The ‘linter_reporter’ and ‘sarif’ tools are not loaded by default as
they are mostly useful for CI/CD pipelines.

The ‘ports_profiler’ tool is not loaded by default; however, as it
conflicts with the ‘debugger’ tool as both provide a debug handler that
must be unique in a running session.

The ‘profiler’ tool is also not loaded by default, as it provides
integration with selected backend Prolog compiler profilers that are not
portable.

The ‘tutor’ tool is also not loaded by default, given its usefulness
mainly for new users that need help understanding compiler warning and
error messages.

The ‘wrapper’ tool is also not loaded by default, given its specialized
purpose and beta status.

The ‘sbom’ tool is also not loaded by default, given its specialized
purpose.

To load a specific tool, either change your Prolog working directory to
the tool folder and then compile and load the corresponding loader
utility file or simply use library notation as argument for the
compiling and loading predicates.  For example:

     | ?- logtalk_load(lgtunit(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Tools documentation,  Next: Tools common flags,  Prev: Loading the developer tools,  Up: Overview

5.1.2 Tools documentation
-------------------------

Specific notes about each tool can be found in the corresponding
‘NOTES.md’ files.  HTML documentation for each tool API can be found in
the ‘docs’ directory (open the ‘../docs/handbook/index.html’ file with
your web browser).


File: TheLogtalkHandbook-3.100.1.info,  Node: Tools common flags,  Next: Tools requirements,  Prev: Tools documentation,  Up: Overview

5.1.3 Tools common flags
------------------------

The ‘lgtdoc’, ‘lgtunit’, and ‘issue_creator’ tools share a
‘suppress_path_prefix’ flag that can be used to suppress a prefix when
printing file paths.  For example (after loading the tools):

     | ?- set_logtalk_flag(suppress_path_prefix, '/home/jdoe/').

This flag is mainly used to avoid user specific path prefixes appearing
in documentation, test logs, and bug reports.


File: TheLogtalkHandbook-3.100.1.info,  Node: Tools requirements,  Prev: Tools common flags,  Up: Overview

5.1.4 Tools requirements
------------------------

Some of the developer tools have third-party dependencies.  For example,
the ‘lgtdoc’ tool depends on XSLT processors to generate documentation
final formats and uses Sphinx for the preferred HTML final format.  Be
sure to consult the tools documentation details on those requirements
and possible alternatives.  For convenience, follows a global list of
the main tool requirements and suggestions for installing them per
operating-system.  If your operating-system or a dependency for it is
not listed, see the dependency websites for installation instructions.

* Menu:

* Tool dependencies for full functionality::
* Python dependencies (all operating-systems): Python dependencies all operating-systems.
* macOS - MacPorts::
* macOS - Homebrew::
* Ubuntu::
* RedHat::
* Windows - Chocolatey::
* Installers::
* Windows - PowerShell add-ons::


File: TheLogtalkHandbook-3.100.1.info,  Node: Tool dependencies for full functionality,  Next: Python dependencies all operating-systems,  Up: Tools requirements

5.1.4.1 Tool dependencies for full functionality
................................................

   - ‘code_metric’: ‘cloc’, ‘sed’

   - ‘diagrams’: d2, Graphviz

   - ‘help’: ‘lynx’ ‘info’

   - ‘issue_creator’: ‘gh’, ‘glab’

   - ‘lgtdoc’: Sphinx, ‘libxslt’, ‘fop’, ‘texlive’, ‘texinfo’, ‘pandoc’,
     ‘xsltproc’

   - ‘lgtunit’: Allure, ‘coreutils’, ‘gsed’

   - ‘packs’: ‘coreutils’, ‘libarchive’, ‘gnupg2’, ‘git’, ‘curl’,
     ‘wget’, ‘direnv’


File: TheLogtalkHandbook-3.100.1.info,  Node: Python dependencies all operating-systems,  Next: macOS - MacPorts,  Prev: Tool dependencies for full functionality,  Up: Tools requirements

5.1.4.2 Python dependencies (all operating-systems)
...................................................

     $ pip install --upgrade pygments
     $ pip install --upgrade sphinx
     $ pip install --upgrade sphinx_rtd_theme

In alternative, if your want to use the same versions used to build
release documentation:

     $ cd manuals/sources
     $ python3 -m pip install -r requirements.txt


File: TheLogtalkHandbook-3.100.1.info,  Node: macOS - MacPorts,  Next: macOS - Homebrew,  Prev: Python dependencies all operating-systems,  Up: Tools requirements

5.1.4.3 macOS - MacPorts
........................

     $ sudo port install cloc
     $ sudo port install d2 graphviz
     $ sudo port install lynx texinfo pandoc
     $ sudo port install libxslt fop texlive
     $ sudo port install gsed
     $ sudo port install coreutils gsed libarchive gnupg2 git curl wget direnv
     $ sudo port install gh glab


File: TheLogtalkHandbook-3.100.1.info,  Node: macOS - Homebrew,  Next: Ubuntu,  Prev: macOS - MacPorts,  Up: Tools requirements

5.1.4.4 macOS - Homebrew
........................

     $ brew install cloc
     $ brew install d2 graphviz
     $ brew install lynx texinfo pandoc
     $ brew install libxslt fop texlive
     $ brew install allure gsed
     $ brew install coreutils libarchive gnupg2 git curl wget direnv
     $ brew install gh glab


File: TheLogtalkHandbook-3.100.1.info,  Node: Ubuntu,  Next: RedHat,  Prev: macOS - Homebrew,  Up: Tools requirements

5.1.4.5 Ubuntu
..............

     $ sudo apt install cloc
     $ sudo apt install graphviz
     $ sudo apt install lynx texinfo pandoc
     $ sudo apt install xsltproc fop texlive-latex-extra tex-gyre latexmk
     $ sudo apt install coreutils libarchive-tools gnupg2 git curl wget direnv
     $ sudo apt install gh


File: TheLogtalkHandbook-3.100.1.info,  Node: RedHat,  Next: Windows - Chocolatey,  Prev: Ubuntu,  Up: Tools requirements

5.1.4.6 RedHat
..............

     $ sudo dnf install cloc
     $ sudo dnf install graphviz
     $ sudo dnf install lynx texinfo pandoc
     $ sudo dnf install libxslt fop
     $ sudo dnf install bsdtar gnupg2 git curl wget direnv


File: TheLogtalkHandbook-3.100.1.info,  Node: Windows - Chocolatey,  Next: Installers,  Prev: RedHat,  Up: Tools requirements

5.1.4.7 Windows - Chocolatey
............................

     > choco install cloc sed
     > choco install pandoc xsltproc
     > choco install d2 graphviz
     > choco install xsltproc apache-fop texlive
     > choco install gnupg git
     > choco install gh glab
     > choco install wget


File: TheLogtalkHandbook-3.100.1.info,  Node: Installers,  Next: Windows - PowerShell add-ons,  Prev: Windows - Chocolatey,  Up: Tools requirements

5.1.4.8 Installers
..................

   - ‘https://d2lang.com/tour/install’

   - ‘https://www.graphviz.org/download/’

   - ‘https://allurereport.org/docs/’

   - ‘https://www.gnupg.org/’

   - ‘https://gitforwindows.org’

   - ‘https://cli.github.com’

   - ‘https://glab.readthedocs.io’

   - ‘https://eternallybored.org/misc/wget/’


File: TheLogtalkHandbook-3.100.1.info,  Node: Windows - PowerShell add-ons,  Prev: Installers,  Up: Tools requirements

5.1.4.9 Windows - PowerShell add-ons
....................................

     PS> Install-Module -Name Set-PsEnv


File: TheLogtalkHandbook-3.100.1.info,  Node: asdf,  Next: assertions,  Prev: Overview,  Up: Developer Tools

5.2 ‘asdf’
==========

A Logtalk plugin for the asdf(1) extendable version manager is available
at:

‘https://github.com/LogtalkDotOrg/asdf-logtalk’

This plugin provides an alternative to the ‘logtalk_version_select’
script that can be useful to manage Logtalk versions when developing
solutions that use other languages and tools that can also be handled by
‘asdf’.

   ---------- Footnotes ----------

   (1) https://asdf-vm.com


File: TheLogtalkHandbook-3.100.1.info,  Node: assertions,  Next: code_metrics,  Prev: asdf,  Up: Developer Tools

5.3 ‘assertions’
================

The ‘assertions.lgt’ file contains definitions for two meta-predicates,
‘assertion/1-2’, which allows the use of assertions on your source code
to print warning and error messages (using the message printing
mechanism).  The ‘assertions_messages.lgt’ file defines the default
message translations generated when assertions succeed, fail, or throw
an exception.

* Menu:

* API documentation::
* Loading::
* Testing::
* Adding assertions to your source code::
* Automatically adding file and line context information to assertions::
* Suppressing assertion calls from source code::
* Redirecting assertion failure messages::
* Converting assertion failures into errors::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation,  Next: Loading,  Up: assertions

5.3.1 API documentation
-----------------------

This tool API documentation is available at:

‘../../apis/library_index.html#assertions’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading,  Next: Testing,  Prev: API documentation,  Up: assertions

5.3.2 Loading
-------------

This tool can be loaded using the query:

     | ?- logtalk_load(assertions(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing,  Next: Adding assertions to your source code,  Prev: Loading,  Up: assertions

5.3.3 Testing
-------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(assertions(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Adding assertions to your source code,  Next: Automatically adding file and line context information to assertions,  Prev: Testing,  Up: assertions

5.3.4 Adding assertions to your source code
-------------------------------------------

The ‘assertion/1’ predicate takes a goal as argument.  For example:

     foo(L) :-
         assertions::assertion(non_empty_list(L)),
         ...

The ‘assertion/2’ predicate takes as arguments a term for passing
context information and a goal.  Using again a unit test as an example:

     foo(L) :-
         assertions::assertion(foo_list_alerts, non_empty_list(L)),
         ...

When using a large number of assertions, you can use a lighter syntax by
adding a ‘uses/2’ directive.  For example:

     :- uses(assertions, [assertion/1, assertion/2]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Automatically adding file and line context information to assertions,  Next: Suppressing assertion calls from source code,  Prev: Adding assertions to your source code,  Up: assertions

5.3.5 Automatically adding file and line context information to assertions
--------------------------------------------------------------------------

The ‘assertions/1’ parametric object can be used as a hook object to
automatically add file and line context information, represented by the
term ‘file_lines(File, BeginLine-EndLine)’, to calls to the
‘assertion/1’ predicate by goal-expanding it to calls to the
‘assertion/2’ predicate (the expansion assumes that a ‘uses/2’ directive
is being used in the code that will be expanded to direct ‘assertion/1’
calls to the ‘assertions’ object).  For example, assuming the file using
assertions is named ‘source’, it would be compiled and loaded using the
call:

     logtalk_load(source, [hook(assertions(debug))])


File: TheLogtalkHandbook-3.100.1.info,  Node: Suppressing assertion calls from source code,  Next: Redirecting assertion failure messages,  Prev: Automatically adding file and line context information to assertions,  Up: assertions

5.3.6 Suppressing assertion calls from source code
--------------------------------------------------

The ‘assertions/1’ parametric object can be used as a hook object to
suppress calls to the ‘assertion/1-2’ predicates using goal-expansion
(the expansion assumes ‘assertions::assertion/1-2’ messages).  For
example, assuming the file using assertions is named ‘source’, it would
be compiled and loaded using the call:

     logtalk_load(source, [hook(assertions(production))])


File: TheLogtalkHandbook-3.100.1.info,  Node: Redirecting assertion failure messages,  Next: Converting assertion failures into errors,  Prev: Suppressing assertion calls from source code,  Up: assertions

5.3.7 Redirecting assertion failure messages
--------------------------------------------

By default, assertion failures and errors are printed to the standard
output stream.  These messages, however, can be intercepted by defining
the ‘logtalk::message_hook/4’ multifile predicate.  For example:

     :- category(redirect_assertions_messages).

         :- multifile(logtalk::message_hook/4).
         :- dynamic(logtalk::message_hook/4).

         logtalk::message_hook(Message, error, assertions, _) :-
             writeq(my_log_file, Message), write(my_log_file, '.\n').

     :- end_category.


File: TheLogtalkHandbook-3.100.1.info,  Node: Converting assertion failures into errors,  Prev: Redirecting assertion failure messages,  Up: assertions

5.3.8 Converting assertion failures into errors
-----------------------------------------------

If you want an assertion failure to result in a failure or a runtime
error, you can intercept the assertion failure messages, optionally
still printing them, and throw an error.  For example:

     :- category(assertions_failures_to_errors).

         :- multifile(logtalk::message_hook/4).
         :- dynamic(logtalk::message_hook/4).

         logtalk::message_hook(Message, error, assertions, Tokens) :-
             % uncomment the next two lines to also print the default message
             % logtalk::message_prefix_stream(error, assertions, Prefix, Stream),
             % logtalk::print_message_tokens(Stream, Prefix, Tokens),
             throw(error(Message, _)).

     :- end_category.

In alternative, if you want assertions to always trigger an exception,
use instead the ‘lgtunit’ tool ‘assertions/1-2’ public predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: code_metrics,  Next: dead_code_scanner,  Prev: assertions,  Up: Developer Tools

5.4 ‘code_metrics’
==================

The purpose of this tool is to assess qualities of source code that may
predict negative aspects such as entity coupling, cohesion, complexity,
error-proneness, and overall maintainability.  It is meant to be
extensible via the addition of objects implementing new metrics.

This tool provides predicates for computing metrics for source files,
entities, libraries, files, and directories.  The actual availability of
a particular predicate depends on the specific metric.  A set of
predicates prints, by default, the computed metric values to the
standard output.  A second set of predicates computes and returns a
score (usually a compound term with the computed metric values as
arguments).

* Menu:

* API documentation: API documentation<2>.
* Loading: Loading<2>.
* Testing: Testing<2>.
* Available metrics::
* Coupling metrics::
* Lack of cohesion metric::
* WMC metric::
* RFC metric::
* Cognitive complexity metric::
* Lines metric::
* Maintainability index metric::
* Halstead metric::
* UPN metric::
* Cyclomatic complexity metric::
* Usage::
* Excluding code from analysis::
* Defining new metrics::
* Third-party tools::
* Applying metrics to Prolog modules::
* Applying metrics to plain Prolog code::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<2>,  Next: Loading<2>,  Up: code_metrics

5.4.1 API documentation
-----------------------

This tool API documentation is available at:

‘../../apis/library_index.html#code-metrics’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<2>,  Next: Testing<2>,  Prev: API documentation<2>,  Up: code_metrics

5.4.2 Loading
-------------

This tool can be loaded using the query:

     | ?- logtalk_load(code_metrics(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<2>,  Next: Available metrics,  Prev: Loading<2>,  Up: code_metrics

5.4.3 Testing
-------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(code_metrics(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Available metrics,  Next: Coupling metrics,  Prev: Testing<2>,  Up: code_metrics

5.4.4 Available metrics
-----------------------

Currently, the following metrics are provided:

   - Number of Clauses (‘noc_metric’)

   - Number of Rules (‘nor_metric’)

   - Unique Predicate Nodes (‘upn_metric’)

   - Cyclomatic Complexity (‘cc_metric’)

   - Depth of Inheritance (‘dit_metric’)

   - Efferent coupling, afferent coupling, instability, and abstractness
     (‘coupling_metric’)

   - Lack of cohesion of methods (‘lcom_metric’)

   - Weighted Methods per Class (‘wmc_metric’)

   - Response For a Class (‘rfc_metric’)

   - Cognitive complexity (‘cogc_metric’)

   - Documentation (‘doc_metric’)

   - Lines of code, comments, and blanks (‘lines_metric’)

   - Source code size (‘size_metric’)

   - Maintainability index (‘mi_metric’ and ‘mi_metric(Stroud)’)

   - Halstead complexity (‘halstead_metric’ and
     ‘halstead_metric(Stroud)’)

A helper object, ‘code_metrics’, is also provided, allowing running all
loaded individual metrics.  For code coverage metrics, see the ‘lgtunit’
tool documentation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Coupling metrics,  Next: Lack of cohesion metric,  Prev: Available metrics,  Up: code_metrics

5.4.5 Coupling metrics
----------------------

   - Efferent coupling (‘Ce’): Number of entities that an entity depends
     on.  These include objects receiving messages from the entity, plus
     the implemented protocols, imported categories, and
     extended/instantiated/specialized objects.

   - Afferent coupling (‘Ca’): Number of entities that depend on an
     entity.  For a protocol, the number of protocols that extend it,
     plus the number of objects and categories that implement it.  For a
     category, the number of objects that import it.  For an object, the
     number of categories and objects that send messages to it plus the
     number of objects that extend/instantiate/specialize it.

   - Instability: Computed as ‘Ce / (Ce + Ca)’.  Measures an entity
     resilience to change.  Ranging from 0.0 to 1.0, with 0.0 indicating
     a maximally stable entity and 1.0 indicating a maximally unstable
     entity.  Ideally, an entity is either maximally stable or maximally
     unstable.

   - Abstractness: Computed as the ratio between the number of static
     predicates with scope directives without a local definition and the
     number of static predicates with scope directives.  Measures the
     rigidity of an entity.  Ranging from 0.0 to 1.0, with 0.0
     indicating a fully concrete entity and 1.0 indicating a fully
     abstract entity.

   - Distance from main sequence: Computed as ‘abs(A + I - 1)’.
     Measures how far an entity is from the idealized line ‘A + I = 1’
     (the “main sequence”).  Ranging from 0.0 to 1.0, with 0.0
     indicating the entity sits exactly on the main sequence and 1.0
     indicating maximum deviation.  Entities in the “zone of pain” (A =~
     0, I =~ 0: concrete and stable) are difficult to change; entities
     in the “zone of uselessness” (A =~ 1, I =~ 1: abstract and
     unstable) are not used.  Ideally, entities should have a distance
     close to 0.0.

The dependencies count includes direct entity relations plus predicate
calls or dynamic updates to predicates in external objects or
categories.

For more information on the interpretation of the coupling metric
scores, see, e.g., the original paper by Robert Martin:

     @inproceedings{citeulike:1579528,
         author = "Martin, Robert",
         booktitle = "Workshop Pragmatic and Theoretical Directions in Object-Oriented Software Metrics",
         citeulike-article-id = 1579528,
         citeulike-linkout-0 = "http://www.objectmentor.com/resources/articles/oodmetrc.pdf",
         keywords = "diplomarbeit",
         organization = "OOPSLA'94",
         posted-at = "2007-08-21 11:08:44",
         priority = 0,
         title = "OO Design Quality Metrics - An Analysis of Dependencies",
         url = "http://www.objectmentor.com/resources/articles/oodmetrc.pdf",
         year = 1994
     }

The coupling metric was also influenced by the metrics rating system in
Microsoft Visual Studio and aims to eventually emulate the functionality
of a maintainability index score.


File: TheLogtalkHandbook-3.100.1.info,  Node: Lack of cohesion metric,  Next: WMC metric,  Prev: Coupling metrics,  Up: code_metrics

5.4.6 Lack of cohesion metric
-----------------------------

The lack of cohesion of methods (LCOM4) metric is computed as the number
of connected components in the undirected graph whose nodes are the
locally defined (non-auxiliary) predicates of an object or category and
whose edges represent direct internal calls between those predicates.
The metric is reported as the compound term ‘lcom(Components,
Predicates)’ where ‘Components’ is the number of connected components
and ‘Predicates’ is the total number of locally defined predicates.

An ‘lcom(1, N)’ score indicates a fully cohesive entity: all predicates
are reachable from any other predicate via internal calls.  Higher
‘Components’ values suggest the entity may benefit from being split into
separate, more focused entities.  Entities with no predicates or a
single predicate always score ‘lcom(1, N)’.

Protocols are not scored by this metric (they never define predicate
clauses).  Only direct bare-predicate calls (as reported by the Logtalk
reflection API) are counted as internal edges; external message-sends
(‘Object::Predicate’) are excluded.

For more details on the LCOM4 variant, see:

     @inproceedings{Hitz:1995,
         author = "Hitz, M. and Montazeri, B.",
         title = "Measuring Coupling and Cohesion in Object-Oriented Systems",
         booktitle = "Proceedings of the International Symposium on Applied Corporate Computing",
         year = 1995
     }


File: TheLogtalkHandbook-3.100.1.info,  Node: WMC metric,  Next: RFC metric,  Prev: Lack of cohesion metric,  Up: code_metrics

5.4.7 WMC metric
----------------

The Weighted Methods per Class (WMC) metric counts the number of locally
defined (non-auxiliary) predicates in an object or category.  Unit
weights are used: each predicate contributes 1 to the score regardless
of its complexity.  Protocols are not scored as they cannot define
predicates.

A cyclomatic-complexity-weighted variant is not provided.  The Logtalk
reflection API exposes inter-predicate call edges but not intra-clause
branching structure (if-then-else, disjunction).  A CC-weighted WMC
would inherit the same approximation limitations already present in
‘cc_metric’ and would also be numerically equivalent to the number of
user clauses reported by ‘noc_metric’.

For more details on the WMC metric, see the original CK paper:

     @article{Chidamber:1994,
         author = "Chidamber, S. R. and Kemerer, C. F.",
         title = "A Metrics Suite for Object Oriented Design",
         journal = "IEEE Transactions on Software Engineering",
         volume = 20,
         number = 6,
         pages = "476--493",
         year = 1994
     }


File: TheLogtalkHandbook-3.100.1.info,  Node: RFC metric,  Next: Cognitive complexity metric,  Prev: WMC metric,  Up: code_metrics

5.4.8 RFC metric
----------------

The Response For a Class (RFC) metric is computed as the size of the
response set for an object or category.  The response set RS(E) for an
entity E is the union of its locally defined (non-auxiliary) predicates
and all distinct predicates directly called or updated by those
predicates.  RFC = |RS(E)|.

Internal calls (to predicates within the entity) are included in the
response set but are not double-counted: they are already part of the
locally defined predicates.  Only additional external callees increase
the score beyond the WMC score of the same entity.

When the receiver of a message is only bound at runtime (e.g.
‘Obj::foo/1’ where ‘Obj’ is a variable), all such calls for the same
predicate indicator are counted as one callee entry, regardless of how
many distinct call sites exist.

Calls to built-in predicates are never returned by the Logtalk
reflection API and therefore do not contribute to the score.

Protocols are not scored as they cannot define predicates.

Higher RFC scores indicate entities with larger potential execution
footprints, which increases testing effort.

For more details on the RFC metric, see the original CK paper:

     @article{Chidamber:1994,
         author = "Chidamber, S. R. and Kemerer, C. F.",
         title = "A Metrics Suite for Object Oriented Design",
         journal = "IEEE Transactions on Software Engineering",
         volume = 20,
         number = 6,
         pages = "476--493",
         year = 1994
     }


File: TheLogtalkHandbook-3.100.1.info,  Node: Cognitive complexity metric,  Next: Lines metric,  Prev: RFC metric,  Up: code_metrics

5.4.9 Cognitive complexity metric
---------------------------------

The cognitive complexity (‘cogc_metric’) metric is an approximation of
the Cognitive Complexity metric proposed by Campbell (2018).  For each
non-auxiliary predicate, the score contribution is the number of extra
clauses (number of clauses minus one, representing multi-clause
branching choices) plus one if the predicate is directly recursive (i.e.
calls itself within the same entity).  The entity score is the sum of
all predicate contributions.

A score of 0 means all predicates are single-clause and non-recursive.
Higher scores indicate entities with more branching and recursion, which
typically require more effort to understand and test.

'Approximation note': the Logtalk reflection API does not expose the use
of control constructs such as cuts, if-then-else, disjunction, or
‘catch/3’ in the predicate clause bodies.  Thus, these constructs cannot
contribute to the score, which should be interpreted as a lower bound
for the cognitive complexity of the entity.

Protocols are not scored as they cannot define predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Lines metric,  Next: Maintainability index metric,  Prev: Cognitive complexity metric,  Up: code_metrics

5.4.10 Lines metric
-------------------

The lines metric (‘lines_metric’) computes the number of code lines,
comment lines, and blank lines, represented as the compound term
‘lines(Code, Comments, Blanks)’.

The implementation calls the external ‘cloc’ tool and parses its CSV
report.  For entity scores, it first obtains the entity source line
range from the reflection API using the ‘lines(BeginLine, EndLine)’
property, writes only that range to a temporary file, and runs ‘cloc’ on
that temporary file.

For file, directory, and library scores, the metric computes and sums
per-file ‘lines/3’ scores.

This metric requires the ‘cloc’ and ‘sed’ commands to be available in
the operating system path.


File: TheLogtalkHandbook-3.100.1.info,  Node: Maintainability index metric,  Next: Halstead metric,  Prev: Lines metric,  Up: code_metrics

5.4.11 Maintainability index metric
-----------------------------------

The maintainability index metric (‘mi_metric’) computes the original
maintainability index formula:

‘MI = 171 - 5.2 * ln(V) - 0.23 * C - 16.2 * ln(L)’

where ‘V’ is the Halstead volume, ‘C’ is cyclomatic complexity, and ‘L’
is the number of code lines.  The score is represented as ‘mi(Index)’.

The metric is available as ‘mi_metric’ (default Stroud coefficient 18)
and as ‘mi_metric(Stroud)’ for a user-defined Stroud coefficient passed
to the Halstead metric.

Protocols are not scored as they cannot define predicates.

This metric requires the lines metric and thus the ‘cloc’ and ‘sed’
commands to be available in the operating system path.


File: TheLogtalkHandbook-3.100.1.info,  Node: Halstead metric,  Next: UPN metric,  Prev: Maintainability index metric,  Up: code_metrics

5.4.12 Halstead metric
----------------------

Predicates declared, user-defined, and called are interpreted as
'operators'.  Built-in predicates and built-in control constructs are
ignored.  Predicate arguments are abstracted, assumed distinct, and
interpreted as 'operands'.  Note that this definition of operands is a
significant deviation from the original definition, which used syntactic
literals.  A computation closer to the original definition of the metric
would require switching to use the parser to collect information on
syntactic literals, which would imply a much larger computation cost.
The number of predicate calls doesn’t include calls to built-in
predicates and can underestimate recursive calls.

The computation of this metric is parameterized by the 'Stroud'
coefficient for computing the time required to program (default is 18).
The following individual measures are computed:

   - Number of distinct predicates (declared, defined, called, or
     updated; ‘Pn’).

   - Number of predicate arguments (assumed distinct; ‘PAn’).

   - Number of predicate calls/updates + number of clauses (‘Cn’).

   - Number of predicate call/update arguments + number of clause head
     arguments (‘CAn’).

   - Entity vocabulary (‘EV’).  Computed as ‘EV = Pn + PAn’.

   - Entity length (‘EL’).  Computed as ‘EL = Cn + CAn’.

   - Volume (‘V’).  Computed as ‘V = EL * log2(EV)’.

   - Difficulty (‘D’).  Computed as ‘D = (Pn/2) * (CAn/An)’.

   - Effort (‘E’).  Computed as ‘E = D * V’.

   - Time required to program (‘T’).  Computed as ‘T = E/k’ seconds
     (where ‘k’ is the Stroud number; defaults to 18).

   - Number of delivered bugs (‘B’).  Computed as ‘B = V/3000’.


File: TheLogtalkHandbook-3.100.1.info,  Node: UPN metric,  Next: Cyclomatic complexity metric,  Prev: Halstead metric,  Up: code_metrics

5.4.13 UPN metric
-----------------

The Unique Predicate Nodes (UPN) metric is described in the following
paper:

     @article{MOORES199845,
         title = "Applying Complexity Measures to Rule-Based Prolog Programs",
         journal = "Journal of Systems and Software",
         volume = "44",
         number = "1",
         pages = "45 - 52",
         year = "1998",
         issn = "0164-1212",
         doi = "https://doi.org/10.1016/S0164-1212(98)10042-0",
         url = "http://www.sciencedirect.com/science/article/pii/S0164121298100420",
         author = "Trevor T Moores"
     }

The nodes include called and updated predicates independently of where
they are defined.  It also includes multifile predicates contributed to
other entities.


File: TheLogtalkHandbook-3.100.1.info,  Node: Cyclomatic complexity metric,  Next: Usage,  Prev: UPN metric,  Up: code_metrics

5.4.14 Cyclomatic complexity metric
-----------------------------------

The cyclomatic complexity metric evaluates an entity code complexity by
measuring the number of linearly independent paths through the code.  In
its current implementation, all defined predicates that are not called
or updated are counted as graph-connected components (the reasoning
being that these predicates can be considered entry points).  The
implementation uses the same predicate abstraction as the UPN metric.
The defined predicates include multifile predicate definitions
contributed by the entity to other entities.

For more details on this metric, see the original paper by Thomas J.
McCabe:

     @inproceedings{McCabe:1976:CM:800253.807712,
         author = "McCabe, Thomas J.",
         title = "A Complexity Measure",
         booktitle = "Proceedings of the 2Nd International Conference on Software Engineering",
         series = "ICSE '76",
         year = 1976,
         location = "San Francisco, California, USA",
         pages = "407--",
         url = "http://dl.acm.org/citation.cfm?id=800253.807712",
         acmid = 807712,
         publisher = "IEEE Computer Society Press",
         address = "Los Alamitos, CA, USA",
         keywords = "Basis, Complexity measure, Control flow, Decomposition, Graph theory, Independence, Linear, Modularization, Programming, Reduction, Software, Testing",
     }


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage,  Next: Excluding code from analysis,  Prev: Cyclomatic complexity metric,  Up: code_metrics

5.4.15 Usage
------------

All metrics require the source code to be analyzed to be loaded with the
‘source_data’ flag turned on.  For usage examples, see the ‘SCRIPT.txt’
file in the tool directory.

Be sure to fully understand the metrics individual meanings and any
implementation limitations before using them to support any evaluation
or decision process.


File: TheLogtalkHandbook-3.100.1.info,  Node: Excluding code from analysis,  Next: Defining new metrics,  Prev: Usage,  Up: code_metrics

5.4.16 Excluding code from analysis
-----------------------------------

A set of options is available to specify code that should be excluded
when applying code metrics:

   - 
          ‘exclude_directories(Directories)’
          list of directories to exclude (default is ‘[]’); all sub-directories of the excluded directories are also excluded; directories may be listed by full or relative path

   - 
          ‘exclude_files(Files)’
          list of source files to exclude (default is ‘[]’); files may be listed by full path or basename, with or without extension

   - 
          ‘exclude_libraries(Libraries)’
          list of libraries to exclude (default is ‘[startup, scratch_directory]’)

   - 
          ‘exclude_entities(Entities)’
          list of entities to exclude (default is ‘[]’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining new metrics,  Next: Third-party tools,  Prev: Excluding code from analysis,  Up: code_metrics

5.4.17 Defining new metrics
---------------------------

New metrics can be implemented by defining an object that imports the
‘code_metric’ category and implements its score predicates.  There is
also a ‘code_metrics_utilities’ category that defines useful predicates
for the definition of metrics.


File: TheLogtalkHandbook-3.100.1.info,  Node: Third-party tools,  Next: Applying metrics to Prolog modules,  Prev: Defining new metrics,  Up: code_metrics

5.4.18 Third-party tools
------------------------

The following open-source command-line programs can count blank lines,
comment lines, and lines of source code in many programming languages,
including Logtalk:

   - ‘cloc’ - ‘https://github.com/AlDanial/cloc’

   - ‘ohcount’ - ‘https://github.com/blackducksoftware/ohcount’

   - ‘tokei’ - ‘https://github.com/XAMPPRocky/tokei’


File: TheLogtalkHandbook-3.100.1.info,  Node: Applying metrics to Prolog modules,  Next: Applying metrics to plain Prolog code,  Prev: Third-party tools,  Up: code_metrics

5.4.19 Applying metrics to Prolog modules
-----------------------------------------

Some of the metrics can also be applied to Prolog modules that Logtalk
is able to compile as objects.  For example, if the Prolog module file
is named ‘module.pl’, try:

     | ?- logtalk_load(module, [source_data(on)]).

Due to the lack of standardization of module systems and the abundance
of proprietary extensions, this solution is not expected to work for all
cases.


File: TheLogtalkHandbook-3.100.1.info,  Node: Applying metrics to plain Prolog code,  Prev: Applying metrics to Prolog modules,  Up: code_metrics

5.4.20 Applying metrics to plain Prolog code
--------------------------------------------

Some of the metrics can also be applied to plain Prolog code.  For
example, if the Prolog file is named ‘code.pl’, simply define an object
including its code:

     :- object(code).
         :- include('code.pl').
     :- end_object.

Save the object to an e.g.  ‘code.lgt’ file in the same directory as the
Prolog file and then load it in debug mode:

     | ?- logtalk_load(code, [source_data(on)]).

In alternative, use the ‘object_wrapper_hook’ provided by the
‘hook_objects’ library:

     | ?- logtalk_load(hook_objects(loader)).
     ...

     | ?- logtalk_load(code, [hook(object_wrapper_hook), source_data(on)]).

With either wrapping solution, pay special attention to any compilation
warnings that may signal issues that could prevent the plain Prolog code
from working when wrapped by an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: dead_code_scanner,  Next: debug_messages,  Prev: code_metrics,  Up: Developer Tools

5.5 ‘dead_code_scanner’
=======================

This tool detects 'likely' dead code in Logtalk entities and in Prolog
modules compiled as objects.  Predicates (and non-terminals) are
classified as dead code when:

   - There is no scope directive for them, and they are not called,
     directly or indirectly, by any predicate with a (local or
     inherited) scope directive.

   - They are listed in ‘uses/2’ and ‘use_module/2’ directives but not
     called.

Besides dead code, this tool can also help detect other problems in the
code that often result in reporting false positives.  For example, typos
in ‘alias/2’ directives, missing scope directives, and missing
‘meta_non_terminal/1’ and ‘meta_predicate/1’ directives.

Given the possibility of false positives, care must be taken before
deleting reported dead code to ensure that it’s, in fact, code that is
not used.  A common cause of false positives is the use of conditional
compilation directives to provide implementations for predicates missing
in some systems or different predicate implementations per
operating-system.

The ‘dead_code_scanner.lgt’ source file implements the scanning
predicates for finding dead code in entities, libraries, and
directories.  The source file ‘dead_code_scanner_messages.lgt’ defines
the default translations for the messages printed when scanning for dead
code.  These messages can be intercepted to customize the output, e.g.,
to make it less verbose or for integration with, e.g., GUI IDEs and
continuous integration servers.

* Menu:

* API documentation: API documentation<3>.
* Loading: Loading<3>.
* Testing: Testing<3>.
* Usage: Usage<2>.
* Excluding code from analysis: Excluding code from analysis<2>.
* Machine-readable summaries::
* Machine-readable preflight warnings::
* Finding classes and confidence::
* SARIF reports::
* Integration with the make tool::
* Caveats::
* Scanning Prolog modules::
* Scanning plain Prolog files::
* Known issues::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<3>,  Next: Loading<3>,  Up: dead_code_scanner

5.5.1 API documentation
-----------------------

This tool API documentation is available at:

‘../../apis/library_index.html#dead-code-scanner’

For sample queries, please see the ‘SCRIPT.txt’ file in the tool
directory.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<3>,  Next: Testing<3>,  Prev: API documentation<3>,  Up: dead_code_scanner

5.5.2 Loading
-------------

This tool can be loaded using the query:

     | ?- logtalk_load(dead_code_scanner(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<3>,  Next: Usage<2>,  Prev: Loading<3>,  Up: dead_code_scanner

5.5.3 Testing
-------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(dead_code_scanner(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<2>,  Next: Excluding code from analysis<2>,  Prev: Testing<3>,  Up: dead_code_scanner

5.5.4 Usage
-----------

This tool provides a set of predicates that allows scanning entities,
libraries, files, and directories.  See the tool API documentation for
details.  The source code to be analyzed should be loaded with the
‘source_data’ and ‘optimize’ flags turned on (possibly set from a loader
file).

For machine-readable integrations, the ‘diagnostics/2-3’,
‘diagnostic/2-3’, ‘diagnostics_summary/2-3’, and
‘diagnostics_preflight/2-3’ predicates can be used to collect dead-code
results and post-filter counts without relying on printed messages.
Diagnostics are returned as terms of the form:

   - ‘diagnostic(RuleId, Severity, Confidence, Message, Context, File,
     Lines, Properties)’

where:

   - ‘RuleId’ distinguishes local dead code from unused ‘uses/2’ and
     ‘use_module/2’ resources

   - ‘Severity’ is the reported diagnostic severity (‘error’, ‘warning’,
     or ‘note’)

   - ‘Confidence’ is a triage-oriented rating (‘high’, ‘medium’, or
     ‘low’)

   - ‘Context’ identifies the entity kind and entity where the
     diagnostic was found

   - ‘Properties’ contains additional structured metadata, including the
     analysis settings seen for the source file and any class-specific
     details needed to explain the finding

For machine-readable export integrations, the ‘export/3-4’ predicates
serialize scan results in SARIF format using the ‘json’ library.

As an example, assume that we want to scan an application with a library
alias ‘my_app’.  The following goals could be used:

     | ?- set_logtalk_flag(source_data, on),
          set_logtalk_flag(optimize, on).
     yes

     | ?- logtalk_load(my_app(loader)).
     ...
     yes

     | ?- dead_code_scanner::library(my_app).
     ...

For complex applications that make use of sub-libraries, there are also
‘rlibrary/1-2’ predicates that perform a recursive scan of a library and
all its sub-libraries.  Conversely, we may be interested in scanning a
single entity:

     | ?- dead_code_scanner::entity(some_object).
     ...

For other usage examples, see the ‘SCRIPT.txt’ file in the tool
directory.


File: TheLogtalkHandbook-3.100.1.info,  Node: Excluding code from analysis<2>,  Next: Machine-readable summaries,  Prev: Usage<2>,  Up: dead_code_scanner

5.5.5 Excluding code from analysis
----------------------------------

A set of options is available to specify code that should be excluded
when looking for unused predicates (and non-terminals):

   - 
          ‘exclude_directories(Directories)’
          list of directories to exclude (default is ‘[]’); all sub-directories of the excluded directories are also excluded; directories may be listed by full or relative path

   - 
          ‘exclude_files(Files)’
          list of source files to exclude (default is ‘[]’); files may be listed by full path or basename, with or without extension

   - 
          ‘exclude_libraries(Libraries)’
          list of libraries to exclude (default is ‘[startup, scratch_directory]’)

   - 
          ‘exclude_entities(Entities)’
          list of entities to exclude (default is ‘[]’)

   - 
          ‘exclude_predicates(Predicates)’
          list of predicate and non-terminal indicators to exclude from findings (default is ‘[]’); supports local indicators such as ‘foo/1’ and ‘bar//2’ plus qualified indicators such as ‘object::baz/2’ and ‘module:qux/3’

   - 
          ‘waive_findings(Findings)’
          list of finding patterns to suppress from the results (default is ‘[]’); intended for reusable CI baselines and supports partially instantiated structured finding terms such as ‘dead_predicate(local_dead_code, medium, _, object, some_object, helper/2, _, _)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Machine-readable summaries,  Next: Machine-readable preflight warnings,  Prev: Excluding code from analysis<2>,  Up: dead_code_scanner

5.5.6 Machine-readable summaries
--------------------------------

The ‘diagnostics_summary/2-3’ predicates return a term of the form:

   - ‘diagnostics_summary(Target, TotalContexts, TotalDiagnostics,
     Breakdown, ContextSummaries)’

where ‘Breakdown’ is a term of the form:

   - ‘diagnostic_breakdown(RuleCounts, SeverityCounts,
     ConfidenceCounts)’

with ‘RuleCounts’ containing ‘rule_count(RuleId, Count)’ terms,
‘SeverityCounts’ containing ‘severity_count(Severity, Count)’ terms, and
‘ConfidenceCounts’ containing ‘confidence_count(Confidence, Count)’
terms.

‘ContextSummaries’ is a list of terms of the form:

   - ‘context_summary(Context, DiagnosticsCount, Breakdown)’

The summary is computed after applying all exclusions and finding
waivers, making it suitable for CI thresholds and regression tracking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Machine-readable preflight warnings,  Next: Finding classes and confidence,  Prev: Machine-readable summaries,  Up: dead_code_scanner

5.5.7 Machine-readable preflight warnings
-----------------------------------------

The ‘diagnostics_preflight/2-3’ predicates return an ordered set of
warnings describing analysis prerequisites that affect result quality
for a target.  Warning terms currently use the form:

   - ‘preflight_issue(missing_analysis_prerequisite, Severity, Message,
     Context, File, Lines, Properties)’

where ‘Prerequisite’ is currently one of:

   - ‘source_data’

   - ‘optimize’

This API is intended for CI and editor integrations that need to surface
analysis quality issues without scraping console messages.


File: TheLogtalkHandbook-3.100.1.info,  Node: Finding classes and confidence,  Next: SARIF reports,  Prev: Machine-readable preflight warnings,  Up: dead_code_scanner

5.5.8 Finding classes and confidence
------------------------------------

The current finding classes are:

   - ‘local_dead_code’

   - ‘unused_uses_resource’

   - ‘unused_use_module_resource’

Confidence is a triage-oriented rating attached to every finding.  The
JSON schema allows the values ‘high’, ‘medium’, and ‘low’, but the tool
currently emits only ‘high’ and ‘medium’:

   - ‘high’

     Used when the tool has stronger evidence that the reported code is
     really unused.

   - ‘medium’

     Used when the result is still useful, but can be affected by
     missing compilation information such as optimized call graph data.

   - ‘low’

     Reserved for future use.  It is accepted by the export schema but
     is not currently generated by the scanner.

For ‘local_dead_code’, the confidence depends on the effective
compilation mode of the analyzed file:

   - If the file was loaded in normal mode, or otherwise not loaded with
     ‘optimize(on)’, the confidence is ‘medium’.

   - If the file was loaded with ‘optimize(on)’, the confidence is
     upgraded to ‘high’ because the compiler can provide more complete
     call graph information, reducing the risk of false positives caused
     by missed meta-calls.

The effective mode is inferred from the loaded file itself, not from the
current scanner defaults.  Therefore, results reflect how the analyzed
code was actually compiled.

Unused ‘uses/2’ and ‘use_module/2’ resources are always reported with
‘high’ confidence because they are derived from the generated linking
clauses and the recorded call graph rather than from heuristic
reachability alone.

When scanning using the text-based predicates such as ‘entity/1-2’,
‘file/1-2’, and ‘all/0-1’, the tool now emits preflight warnings
whenever the analyzed files were not loaded with ‘source_data(on)’ or
‘optimize(on)’ so that potentially less reliable results can be triaged
more carefully.


File: TheLogtalkHandbook-3.100.1.info,  Node: SARIF reports,  Next: Integration with the make tool,  Prev: Finding classes and confidence,  Up: dead_code_scanner

5.5.9 SARIF reports
-------------------

This tool is a diagnostics producer.  To generate SARIF reports from its
diagnostics, load the standalone ‘sarif’ tool and call
‘sarif::generate(dead_code_scanner, Target, Sink, Options)’ where
‘Target’ and ‘Options’ are the same ones accepted by the diagnostics
predicates.

The generated report uses the SARIF ‘2.1.0’ JSON format and is suitable
for code scanning integrations that consume SARIF reports.  The shared
generator includes deterministic result fingerprints derived from the
canonical finding and preserves the rule descriptors and triage-oriented
severity mapping described below.

SARIF findings are exported using one rule descriptor per finding class:

   - ‘local_dead_code’

   - ‘unused_uses_resource’

   - ‘unused_use_module_resource’

Result severities are also triage-aware instead of using a single static
SARIF level for all findings:

   - ‘local_dead_code’ with ‘high’ confidence is exported as ‘warning’

   - ‘local_dead_code’ with ‘medium’ or ‘low’ confidence is exported as
     ‘note’

   - ‘unused_uses_resource’ with ‘high’ confidence is exported as
     ‘error’

   - ‘unused_use_module_resource’ with ‘high’ confidence is exported as
     ‘error’

This mapping allows CI consumers to distinguish advisory dead-code
findings from stronger unused-resource findings without reinterpreting
the custom ‘class’ and ‘confidence’ properties.

SARIF reports include the same preflight information as invocation-level
‘toolExecutionNotifications’, allowing consumers to distinguish
prerequisite warnings from dead code findings.  When the analyzed code
is inside a git repository, the shared generator also includes the
current branch and commit hash as optional run properties and a
‘versionControlProvenance’ entry when the repository URI can be derived.


File: TheLogtalkHandbook-3.100.1.info,  Node: Integration with the make tool,  Next: Caveats,  Prev: SARIF reports,  Up: dead_code_scanner

5.5.10 Integration with the ‘make’ tool
---------------------------------------

The ‘loader.lgt’ file sets a make target action that will call the
‘dead_code_scanner::all’ goal whenever the ‘logtalk_make(check)’ goal
(or its top-level abbreviation, ‘{?}’) is called.


File: TheLogtalkHandbook-3.100.1.info,  Node: Caveats,  Next: Scanning Prolog modules,  Prev: Integration with the make tool,  Up: dead_code_scanner

5.5.11 Caveats
--------------

Use of local meta-calls with goal arguments only known at runtime can
result in false positives.  When using library or user-defined
meta-predicates, compilation of the source files with the ‘optimize’
flag turned on may allow meta-calls to be resolved at compile-time and
thus allow calling information for the meta-arguments to be recorded,
avoiding false positives for predicates that are only meta-called.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scanning Prolog modules,  Next: Scanning plain Prolog files,  Prev: Caveats,  Up: dead_code_scanner

5.5.12 Scanning Prolog modules
------------------------------

This tool can also be applied to Prolog modules that Logtalk is able to
compile as objects.  For example, if the Prolog module file is named
‘module.pl’, try:

     | ?- logtalk_load(module, [source_data(on)]).

Due to the lack of standardization of module systems and the abundance
of proprietary extensions, this solution is not expected to work for all
cases.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scanning plain Prolog files,  Next: Known issues,  Prev: Scanning Prolog modules,  Up: dead_code_scanner

5.5.13 Scanning plain Prolog files
----------------------------------

This tool can also be applied to plain Prolog code.  For example, if the
Prolog file is named ‘code.pl’, simply define an object including its
code:

     :- object(code).
         :- include('code.pl').
     :- end_object.

Save the object to an e.g.  ‘code.lgt’ file in the same directory as the
Prolog file and then load it in debug mode:

     | ?- logtalk_load(code, [source_data(on), optimize(on)]).

In alternative, use the ‘object_wrapper_hook’ provided by the
‘hook_objects’ library:

     | ?- logtalk_load(hook_objects(loader)).
     ...

     | ?- logtalk_load(code, [hook(object_wrapper_hook), source_data(on), optimize(on)]).

With either wrapping solution, pay special attention to any compilation
warnings that may signal issues that could prevent the plain Prolog from
being fully analyzed when wrapped by an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues,  Prev: Scanning plain Prolog files,  Up: dead_code_scanner

5.5.14 Known issues
-------------------

Some tests fail when using the ECLIPSe and Trealla Prolog backends due
to their implementation of the ‘multifile/1’ directive, specifically
when the multifile predicates are also dynamic with clauses defined in a
source file: reconsulting the file adds the new clauses to the old ones
instead of replacing them.


File: TheLogtalkHandbook-3.100.1.info,  Node: debug_messages,  Next: debugger,  Prev: dead_code_scanner,  Up: Developer Tools

5.6 ‘debug_messages’
====================

By default, ‘debug’ and ‘debug(Group)’ messages are only printed when
the ‘debug’ flag is turned on.  These messages are also suppressed when
compiling code with the ‘optimize’ flag turned on.  This tool supports
selective enabling of ‘debug’ and ‘debug(Group)’ messages in normal and
debug modes.

* Menu:

* API documentation: API documentation<4>.
* Loading: Loading<4>.
* Testing: Testing<4>.
* Usage: Usage<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<4>,  Next: Loading<4>,  Up: debug_messages

5.6.1 API documentation
-----------------------

This tool API documentation is available at:

‘../../apis/library_index.html#debug-messages’

For general information on debugging, open in a web browser the
following link and consult the debugging section of the User Manual:

‘../../handbook/userman/debugging.html’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<4>,  Next: Testing<4>,  Prev: API documentation<4>,  Up: debug_messages

5.6.2 Loading
-------------

This tool can be loaded using the query:

     | ?- logtalk_load(debug_messages(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<4>,  Next: Usage<3>,  Prev: Loading<4>,  Up: debug_messages

5.6.3 Testing
-------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(debug_messages(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<3>,  Prev: Testing<4>,  Up: debug_messages

5.6.4 Usage
-----------

The tool provides two sets of predicates.  The first set allows enabling
and disabling of all ‘debug’ and ‘debug(Group)’ messages for a given
component.  The second set allows enabling and disabling of
‘debug(Group)’ messages for a given group and component for fine-grained
control.

Upon loading the tool, all debug messages are skipped.  The user is then
expected to use the tool API to selectively enable the messages that
will be printed.  As an example, consider the following object, part of
a ‘xyz’ component:

     :- object(foo).

         :- public([bar/0, baz/0]).
         :- uses(logtalk, [print_message/3]).

         bar :-
             print_message(debug(bar), xyz, @'bar/0 called').

         baz :-
             print_message(debug(baz), xyz, @'baz/0 called').

     :- end_object.

Assuming the object ‘foo’ is compiled and loaded in normal or debug
mode, after also loading this tool, ‘bar/0’ and ‘baz/0’ messages will
not print any debug messages:

     | ?- {debug_messages(loader), foo}.
     ...
     yes

     | ?- foo::(bar, baz).
     yes

We can then enable all debug messages for the ‘xyz’ component:

     | ?- debug_messages::enable(xyx).
     yes

     | ?- foo::(bar, baz).
     bar/0 called
     baz/0 called
     yes

Or we can selectively enable only debug messages for a specific group:

     | ?- debug_messages::disable(xyx).
     yes

     | ?- debug_messages::enable(xyx, bar).
     yes

     | ?- foo::(bar, baz).
     bar/0 called
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: debugger,  Next: diagrams,  Prev: debug_messages,  Up: Developer Tools

5.7 ‘debugger’
==============

This tool provides the default Logtalk command-line debugger.  Unlike
Prolog systems, the Logtalk debugger is a regular application, using a
public API. As a consequence, it must be explicitly loaded by the
programmer, either manually at the top-level interpreter or
automatically from a settings file.

* Menu:

* API documentation: API documentation<5>.
* Loading: Loading<5>.
* Testing: Testing<5>.
* Usage: Usage<4>.
* Alternative debugger tools::
* Known issues: Known issues<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<5>,  Next: Loading<5>,  Up: debugger

5.7.1 API documentation
-----------------------

This tool API documentation is available at:

‘../../apis/library_index.html#debugger’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<5>,  Next: Testing<5>,  Prev: API documentation<5>,  Up: debugger

5.7.2 Loading
-------------

This tool can be loaded using the query:

     | ?- logtalk_load(debugger(loader)).

When the code to be debugged runs computationally expensive
initializations, loading this tool after the code may have a noticeable
impact on loading times.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<5>,  Next: Usage<4>,  Prev: Loading<5>,  Up: debugger

5.7.3 Testing
-------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(debugger(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<4>,  Next: Alternative debugger tools,  Prev: Testing<5>,  Up: debugger

5.7.4 Usage
-----------

Debugging Logtalk source code (with this debugger) requires compiling
source files using the ‘debug(on)’ compiler flag.  For example:

     | ?- logtalk_load(my_buggy_code, [debug(on)]).

In alternative, you may also turn on the ‘debug’ flag globally by
typing:

     | ?- set_logtalk_flag(debug, on).

But note that loader files may override this flag setting (e.g., by
using ‘debug(off)’ or ‘optimize(on)’ options for loaded files).  If
that’s the case, you will need to either edit the loader files or write
customized loader files enabling debugging.  For detailed information on
using the debugger, consult the debugging section of the User Manual:

‘../../handbook/userman/debugging.html’

The ‘debugger_messages.lgt’ source file defines the default debugger
message translations.

The ‘dump_trace.lgt’ provides a simple solution for dumping a goal trace
to a file.  For example:

     | ?- dump_trace::start_redirect_to_file('trace.txt', some_goal),
          dump_trace::stop_redirect_to_file.

A full trace can also be obtained at the top-level by using the ‘S’
(Skip) command at the call port for the top-level goal when tracing it.


File: TheLogtalkHandbook-3.100.1.info,  Node: Alternative debugger tools,  Next: Known issues<2>,  Prev: Usage<4>,  Up: debugger

5.7.5 Alternative debugger tools
--------------------------------

Logtalk provides basic support for the SWI-Prolog graphical tracer.  The
'required' settings are described in the ‘samples/settings-sample.lgt’
file.  Logtalk queries can be traced using this tool by using the
‘gtrace/0-1’ predicates.  For example:

     | ?- gtrace(foo::bar).

Or alternatively:

     | ?- gtrace, foo::bar.

You can also use the ‘gspy/1’ predicate to spy on a Logtalk predicate
specified as ‘Entity::Functor/Arity’ when using the graphical tracer.
When using this tool, internal Logtalk compiler/runtime predicates and
compiled predicates that resulted from the term-expansion mechanism may
be exposed in some cases.  This issue is shared with Prolog code and
results from the non-availability of source code for the predicates
being traced.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<2>,  Prev: Alternative debugger tools,  Up: debugger

5.7.6 Known issues
------------------

Clause breakpoints require a Prolog backend compiler that supports
accessing read term starting line but only some backends (B-Prolog, GNU
Prolog, JIProlog, SICStus Prolog, SWI-Prolog, Trealla Prolog, XVM, and
YAP) provide accurate line numbers.  As a workaround, you can check the
start line number for an entity predicate definition using a query such
as:

     | ?- object_property(Entity, defines(Functor/Arity, Properties)).

Check the returned ‘line_count/1’ property to find if there’s any offset
to the source file number of the predicate clause that you want to
trace.  This issue, if present, usually only affects the first predicate
clause.

Clause breakpoints are currently not available when using XSB as this
backend doesn’t provide line information.

Using the port command ‘p’ (print) requires a backend supporting the
user-defined ‘portray/1’ hook predicate called via the ‘format/2-3’
predicates ‘~p’ control sequence.


File: TheLogtalkHandbook-3.100.1.info,  Node: diagrams,  Next: doclet,  Prev: debugger,  Up: Developer Tools

5.8 ‘diagrams’
==============

This tool generates 'library', 'directory', 'file', 'entity', and
'predicate' diagrams for source files and for libraries of source files
using the Logtalk reflection API to collect the relevant information and
a graph language for representing the diagrams.  Limited support is also
available for generating diagrams for Prolog module applications.  It’s
also possible in general to generate predicate cross-referencing
diagrams for plain Prolog files.

Linking 'library diagrams' to 'entity diagrams' to 'predicate
cross-referencing diagrams' and linking 'directory diagrams' to 'file
diagrams' is also supported when using SVG output.  This feature allows
using diagrams for understanding the architecture of applications by
navigating complex code and zooming into details.  SVG output can also
easily link to both source code repositories and API documentation.
This allows diagrams to be used for source code navigation.

Diagrams can also be used to uncover code issues.  For example,
comparing 'loading diagrams' with 'dependency diagrams' can reveal
implicit dependencies.  Loading diagrams can reveal circular
dependencies that may warrant code refactoring.  Entity diagrams can
provide a good overview of code coupling.  Predicate cross-referencing
diagrams can be used to visually access entity code complexity,
complementing the ‘code_metrics’ tool.

All diagrams support a comprehensive set of options, discussed below, to
customize the final contents and appearance.

Diagram generation can be easily automated using the ‘doclet’ tool and
the ‘logtalk_doclet’ scripts.  See the ‘doclet’ tool examples and
documentation for details.  See also the ‘diagrams’ tool own ‘lgt2svg’
Bash and PowerShell scripts.

* Menu:

* Requirements::
* API documentation: API documentation<6>.
* Loading: Loading<6>.
* Testing: Testing<6>.
* Supported diagrams::
* Graph elements::
* Supported graph languages::
* Customization::
* Linking diagrams::
* Creating diagrams for Prolog module applications::
* Creating diagrams for plain Prolog files::
* Other notes::


File: TheLogtalkHandbook-3.100.1.info,  Node: Requirements,  Next: API documentation<6>,  Up: diagrams

5.8.1 Requirements
------------------

Recent versions of d2 (0.6.9 or later) or Graphviz are required for
generating diagrams in the final formats:

   - ‘https://d2lang.com’

   - ‘https://www.graphviz.org/’

These can be installed using their own installers or using
operating-system package managers:

* Menu:

* macOS - MacPorts: macOS - MacPorts<2>.
* macOS - Homebrew: macOS - Homebrew<2>.
* Windows - Chocolatey: Windows - Chocolatey<2>.
* Installers: Installers<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: macOS - MacPorts<2>,  Next: macOS - Homebrew<2>,  Up: Requirements

5.8.1.1 macOS - MacPorts
........................

     $ sudo port install d2 graphviz


File: TheLogtalkHandbook-3.100.1.info,  Node: macOS - Homebrew<2>,  Next: Windows - Chocolatey<2>,  Prev: macOS - MacPorts<2>,  Up: Requirements

5.8.1.2 macOS - Homebrew
........................

     $ brew install d2 graphviz


File: TheLogtalkHandbook-3.100.1.info,  Node: Windows - Chocolatey<2>,  Next: Installers<2>,  Prev: macOS - Homebrew<2>,  Up: Requirements

5.8.1.3 Windows - Chocolatey
............................

     > choco install d2 graphviz


File: TheLogtalkHandbook-3.100.1.info,  Node: Installers<2>,  Prev: Windows - Chocolatey<2>,  Up: Requirements

5.8.1.4 Installers
..................

   - ‘https://d2lang.com/tour/install’

   - ‘https://www.graphviz.org/download/’


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<6>,  Next: Loading<6>,  Prev: Requirements,  Up: diagrams

5.8.2 API documentation
-----------------------

This tool API documentation is available at:

‘../../apis/library_index.html#diagrams’

For sample queries, please see the ‘SCRIPT.txt’ file in the tool
directory.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<6>,  Next: Testing<6>,  Prev: API documentation<6>,  Up: diagrams

5.8.3 Loading
-------------

This tool can be loaded using the query:

     | ?- logtalk_load(diagrams(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<6>,  Next: Supported diagrams,  Prev: Loading<6>,  Up: diagrams

5.8.4 Testing
-------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(diagrams(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported diagrams,  Next: Graph elements,  Prev: Testing<6>,  Up: diagrams

5.8.5 Supported diagrams
------------------------

The following entity diagrams are supported:

   - 'entity diagrams' showing entity public interfaces, entity
     inheritance relations, and entity predicate (or non-terminal)
     cross-reference relations

   - 'predicate/non-terminal cross-reference diagrams' (between entities
     or within an entity)

   - 'caller diagrams' showing direct and indirect callers of a given
     predicate (or non-terminal)

   - 'inheritance diagrams' showing entity inheritance relations

   - 'uses diagrams' showing which entities use resources from other
     entities

Entity nodes can optionally show a coupling metrics overlay.

The following library diagrams are supported:

   - 'library loading diagrams' showing which libraries load other
     libraries

   - 'library dependency diagrams' showing which libraries contain
     entities with references to entities defined in other libraries

The following file diagrams are supported:

   - 'file loading diagrams' showing which files load or include other
     files

   - 'file dependency diagrams' showing which files contain entities
     with references to entities defined in other files

File dependency diagrams are specially useful in revealing dependencies
that are not represented in file loading diagrams due to files being
loaded indirectly by files external to the libraries being documented.

The following directory diagrams are supported:

   - 'directory loading diagrams' showing which directories contain
     files that load files from other directories

   - 'directory dependency diagrams' showing which directories contain
     entities with references to entities defined in other directories

Comparing directory (or file) loading diagrams with directory (or file)
dependency diagrams allows comparing what is explicitly loaded with the
actual directory (or file) dependencies, which are inferred from the
source code.

Library and directory dependency diagrams are specially useful for large
applications where file diagrams would be too large and complex to be
useful, notably when combined with the 'zoom' option to link to,
respectively, entity and file diagrams.

A utility object, ‘diagrams’, is provided for generating all supported
diagrams in one step.  This object provides an interface common to all
diagrams, but note that some predicates that generate diagrams only make
sense for some types of diagrams.  For best results and fine-grained
customization of each diagram, the individual diagram objects should be
used with the intended set of options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Graph elements,  Next: Supported graph languages,  Prev: Supported diagrams,  Up: diagrams

5.8.6 Graph elements
--------------------

Limitations in both the graph languages and UML force the invention of a
modeling language that can represent all kinds of Logtalk entities and
entity relations.  Currently we use the following Graphviz node shapes
(libraries, entities, predicates, and files) and arrowheads (entity,
predicate, and file relations):

   - 
          libraries
          ‘tab’ (lightsalmon)

   - 
          library loading and dependency relations
          ‘normal’ (arrow ending with a black triangle)

   - 
          objects (classes, instances, and prototypes)
          ‘box’ (rectangle, yellow for instances/classes and beige for prototypes)

   - 
          protocols
          ‘note’ (aqua marine rectangle with folded right-upper corners)

   - 
          categories
          ‘component’ (light cyan rectangle with two small rectangles intercepting the left side)

   - 
          modules
          ‘box’ (plum rectangle with small tab at top)

   - 
          public predicates
          ‘box’ (springgreen)

   - 
          public, multifile, predicates
          ‘box’ (skyblue)

   - 
          protected predicates
          ‘box’ (yellow)

   - 
          private predicates
          ‘box’ (indianred)

   - 
          external predicates
          ‘box’ (beige)

   - 
          exported module predicates
          ‘box’ (springgreen)

   - 
          directories
          ‘tab’ (lightsalmon)

   - 
          directory loading and dependency relations
          ‘normal’ (arrow ending with a black triangle)

   - 
          files
          ‘box’ (pale turquoise rectangle)

   - 
          file loading and dependency relations
          ‘normal’ (arrow ending with a black triangle)

   - 
          specialization relation
          ‘onormal’ (arrow ending with a white triangle)

   - 
          instantiation relation
          ‘normal’ (arrow ending with a black triangle)

   - 
          extends relation
          ‘vee’ (arrow ending with a “v”)

   - 
          implements relation
          ‘dot’ (arrow ending with a black circle)

   - 
          imports relation
          ‘box’ (arrow ending with a black square)

   - 
          complements relation
          ‘obox’ (arrow ending with a white square)

   - 
          uses and use module relations
          ‘rdiamond’ (arrow ending with a black half diamond)

   - 
          predicate calls
          ‘normal’ (arrow ending with a black triangle)

   - 
          dynamic predicate updates
          ‘diamond’ (arrow ending with a black diamond)

When using the d2 graph language, we use similar node shapes and
arrowheads when available.  As d2 evolves, we hope that these graph
elements will converge further.

The library, directory, file, entity, and predicate nodes that are not
part of the predicates, entities, files, or libraries for which we are
generating a diagram use a dashed border, a darker color, and are
described as external.

Note that all the elements above can have captions.  See below the
diagrams ‘node_type_captions/1’ and ‘relation_labels/1’ output options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported graph languages,  Next: Customization,  Prev: Graph elements,  Up: diagrams

5.8.7 Supported graph languages
-------------------------------

Currently, both DOT and d2 graph languages support all the features of
the ‘diagrams’ tool.  There’s also preliminary support for Mermaid (its
current version lacks several required features for parity with d2 and
Graphviz, notably support for links on edges).

JSON output format is also supported for use with Cytoscape.  The
Cytoscape backend generates ‘.cx2’ files using the Cytoscape Exchange
Format version 2 (CX2), including core aspects such as
‘attributeDeclarations’, ‘networkAttributes’, ‘nodes’, ‘edges’,
‘visualProperties’, and ‘status’.  Node and edge styling is exported
using CX2 visual property mappings based on node and edge attributes.
The JSON backend includes optional metadata such as title, description,
generation timestamp, and Logtalk/Prolog version information.  A default
HTML viewer, ‘cytoscapejs_viewer.html’, is provided for convenience.
This viewer currently requires starting a local web server in the
generated diagrams directory and manually entering the server address.

PlantUML output is also supported.  The PlantUML backend generates
‘.puml’ files using custom stereotypes with spotted characters to
distinguish Logtalk entity kinds (O/blue for objects, P/green for
protocols, T/orange for categories).  All five Logtalk relationships
(implements, imports, extends, instantiates, specializes, complements)
are mapped to distinct labeled arrow styles.  A shared ‘logtalk.iuml’
include file defines all skinparam blocks, stereotype colors, and CSS
styles for consistent rendering.  PlantUML version 1.2024.0 or later is
recommended.  See ‘https://plantuml.com’ for installation instructions.

The diagrams ‘.d2’ and ‘.dot’ files are created by default in the
‘'./dot_dias'’ sub-directory of the current directory.  These files can
be easily converted into a printable format such as SVG, PDF, or
Postscript.  Sample helper scripts are provided for converting a
directory of ‘.d2’ or ‘.dot’ files to ‘.svg’ files:

   - ‘lgt2svg.sh’ for POSIX systems

   - ‘lgt2svg.ps1’ for Windows systems

The scripts assume that the d2 and Graphviz command-line executables are
available from the system path.  For Graphviz, the default is the ‘dot’
executable, but the scripts accept a command-line option to select in
alternative the ‘circo’, ‘fdp’, or ‘neato’ executables).  For d2, the
default layout engine is ‘elk’, but the scripts accept a command-line
option to select in alternative the ‘dagre’ or ‘tala’ layout engines.

The recommended output format is SVG, as it supports tooltips and URL
links, which can be used for showing, e.g., entity types, relation
types, file paths, and for navigating to files and directories of files
(libraries) or to API documentation.  See the relevant diagram options
below in order to take advantage of these features (see the discussion
below on “linking diagrams”).

To convert to formats other than SVG, you will need to use the d2 and
Graphviz executables directly.  For example, using the Graphviz ‘dot’
executable, we can generate a PDF with the command:

     dot -Tpdf diagram.dot > diagram.pdf

This usually works fine for entity and predicate call cross-referencing
diagrams.  For directory and file diagrams, the ‘fdp’ and ‘circo’
command-line executables may produce better results.  For example:

     fdp -Tsvg diagram.dot > diagram.svg
     circo -Tsvg diagram.dot > diagram.svg

It’s also worth experimenting with different layouts to find the one
that produces the best results (see the ‘layout/1’ option described
below).

When generating diagrams for multiple libraries or directories, it’s
possible to split a diagram with several disconnected library or
directory graphs using the ‘ccomps’ command-line executable.  For
example:

     ccomps -x -o subdiagram.dot diagram.dot

For more information on the DOT language and related tools, see:

     http://www.graphviz.org/

When using Windows, there are known issues with some Prolog compilers
due to the internal representation of paths.  If you encounter problems
with a specific backend Prolog compiler, try, if possible, to use
another supported backend Prolog compiler when generating diagrams.

For printing large diagrams, you will need to either use a tool to slice
the diagram into page-sized pieces or, preferably, use software capable
of tiled printing (e.g., Adobe Reader).  You can also hand-edit the
generated ‘.dot’ files and play with settings such as aspect ratio for
fine-tuning the diagrams layout.


File: TheLogtalkHandbook-3.100.1.info,  Node: Customization,  Next: Linking diagrams,  Prev: Supported graph languages,  Up: diagrams

5.8.8 Customization
-------------------

This tool provides parametric objects implementing the different types
of diagrams where the parameter is the export format: ‘dot’, ‘d2’,
‘cx2’, and ‘puml’.  The non-parametric versions of the diagram objects
default to ‘dot’.

A set of options is available to specify the details to include in the
generated diagrams.  For entity diagrams, the options are:

   - 
          ‘layout(Layout)’
          diagram layout (one of the atoms ‘{top_to_bottom,bottom_to_top,left_to_right,right_to_left}’; default is ‘bottom_to_top’)

   - 
          ‘title(Title)’
          diagram title (an atom; default is ‘''’)

   - 
          ‘date(Boolean)’
          print current date and time (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘versions(Boolean)’
          print Logtalk and backend version data (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘interface(Boolean)’
          print public predicates (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘file_labels(Boolean)’
          print file labels (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘file_extensions(Boolean)’
          print file name extensions (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘relation_labels(Boolean)’
          print entity relation labels (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘externals(Boolean)’
          print external nodes (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘node_type_captions(Boolean)’
          print node type captions (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘metrics_overlay(Boolean)’
          print coupling metrics overlay in entity nodes showing afferent coupling (Ca), efferent coupling (Ce), instability (I), abstractness (A), and distance from main sequence (D) values (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘cycle_detection(Boolean)’
          highlight cyclic relations by coloring the edges red (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘inheritance_relations(Boolean)’
          print inheritance relations (‘true’ or ‘false’; default is ‘true’ for entity inheritance diagrams and ‘false’ for other entity diagrams)

   - 
          ‘provide_relations(Boolean)’
          print provide relations (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘xref_relations(Boolean)’
          print predicate call cross-reference relations (‘true’ or ‘false’; default depends on the specific diagram)

   - 
          ‘xref_calls(Boolean)’
          print predicate cross-reference calls (‘true’ or ‘false’; default depends on the specific diagram)

   - 
          ‘output_directory(Directory)’
          directory for the ‘.d2’ and ‘.dot’ files (an atom; default is ‘'./dot_dias'’)

   - 
          ‘exclude_directories(Directories)’
          list of directories to exclude except as external nodes (default is ‘[]’); all sub-directories of the excluded directories are also excluded; directories may be listed by full or relative path

   - 
          ‘exclude_files(Files)’
          list of source files to exclude except as external nodes (default is ‘[]’); files may be listed by full path or basename, with or without extension

   - 
          ‘exclude_libraries(Libraries)’
          list of libraries to exclude except as external nodes (default is ‘[startup, scratch_directory]’)

   - 
          ‘exclude_entities(Entities)’
          list of entities to exclude except as external nodes (default is ‘[]’)

   - 
          ‘path_url_prefixes(PathPrefix, CodeURLPrefix, DocURLPrefix)’
          code and documenting URL prefixes for a path prefix used when generating cluster, library, directory, file, and entity links (atoms; no default; can be specified multiple times)

   - 
          ‘url_prefixes(CodeURLPrefix, DocURLPrefix)’
          default URL code and documenting URL prefixes used when generating cluster, library, file, and entity links (atoms; no default)

   - 
          ‘entity_url_suffix_target(Suffix, Target)’
          extension for entity documenting URLs (an atom; default is ‘'.html'’) and target separating symbols (an atom; default is ‘'#'’)

   - 
          ‘omit_path_prefixes(Prefixes)’
          omit common path prefixes when printing directory paths and when constructing URLs (a list of atoms; default is a list with the user home directory)

   - 
          ‘zoom(Boolean)’
          generate sub-diagrams and add links and zoom icons to library and entity nodes (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘zoom_url_suffix(Suffix)’
          extension for linked diagrams (an atom; default is ‘'.svg'’)

In the particular case of cross-referencing diagrams, there are also the
options:

   - 
          ‘recursive_relations(Boolean)’
          print recursive predicate relations (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘url_line_references(Host)’
          syntax for the URL source file line part (an atom; possible values are ‘{github,gitlab,bitbucket}’; default is ‘github’); when using this option, the ‘CodeURLPrefix’ should be a permanent link (i.e., it should include the commit SHA1)

   - 
          ‘predicate_url_target_format(Generator)’
          documentation final format generator (an atom; possible values are ‘{sphinx,other}’; default is ‘sphinx’)

For directory and file diagrams, the options are:

   - 
          ‘layout(Layout)’
          diagram layout (one of the atoms ‘{top_to_bottom,bottom_to_top,left_to_right,right_to_left}’; default is ‘top_to_bottom’)

   - 
          ‘title(Title)’
          diagram title (an atom; default is ‘''’)

   - 
          ‘date(Boolean)’
          print current date and time (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘versions(Boolean)’
          print Logtalk and backend version data (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘directory_paths(Boolean)’
          print file directory paths (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘file_extensions(Boolean)’
          print file name extensions (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘path_url_prefixes(PathPrefix, CodeURLPrefix, DocURLPrefix)’
          code and documenting URL prefixes for a path prefix used when generating cluster, directory, file, and entity links (atoms; no default; can be specified multiple times)

   - 
          ‘url_prefixes(CodeURLPrefix, DocURLPrefix)’
          default URL code and documenting URL prefixes used when generating cluster, library, file, and entity links (atoms; no default)

   - 
          ‘omit_path_prefixes(Prefixes)’
          omit common path prefixes when printing directory paths and when constructing URLs (a list of atoms; default is a list with the user home directory)

   - 
          ‘relation_labels(Boolean)’
          print entity relation labels (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘externals(Boolean)’
          print external nodes (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘node_type_captions(Boolean)’
          print node type captions (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘output_directory(Directory)’
          directory for the ‘.d2’ and ‘.dot’ files (an atom; default is ‘'./dot_dias'’)

   - 
          ‘exclude_directories(Directories)’
          list of directories to exclude except as external nodes (default is ‘[]’)

   - 
          ‘exclude_files(Files)’
          list of source files to exclude except as external nodes (default is ‘[]’)

   - 
          ‘zoom(Boolean)’
          generate sub-diagrams and add links and zoom icons to library and entity nodes (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘zoom_url_suffix(Suffix)’
          extension for linked diagrams (an atom; default is ‘'.svg'’)

For directory dependency diagrams, there is also the option:

   - ‘cycle_detection(Boolean)’ highlight cyclic relations by coloring
     the edges red (‘true’ or ‘false’; default is ‘false’)

For library diagrams, the options are:

   - 
          ‘layout(Layout)’
          diagram layout (one of the atoms ‘{top_to_bottom,bottom_to_top,left_to_right,right_to_left}’; default is ‘top_to_bottom’)

   - 
          ‘title(Title)’
          diagram title (an atom; default is ‘''’)

   - 
          ‘date(Boolean)’
          print current date and time (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘versions(Boolean)’
          print Logtalk and backend version data (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘directory_paths(Boolean)’
          print file directory paths (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘path_url_prefixes(PathPrefix, CodeURLPrefix, DocURLPrefix)’
          code and documenting URL prefixes for a path prefix used when generating cluster, library, file, and entity links (atoms; no default; can be specified multiple times)

   - 
          ‘url_prefixes(CodeURLPrefix, DocURLPrefix)’
          default URL code and documenting URL prefixes used when generating cluster, library, file, and entity links (atoms; no default)

   - 
          ‘omit_path_prefixes(Prefixes)’
          omit common path prefixes when printing directory paths and when constructing URLs (a list of atoms; default is a list with the user home directory)

   - 
          ‘relation_labels(Boolean)’
          print entity relation labels (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘externals(Boolean)’
          print external nodes (‘true’ or ‘false’; default is ‘true’)

   - 
          ‘node_type_captions(Boolean)’
          print node type captions (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘output_directory(Directory)’
          directory for the ‘.d2’ and ‘.dot’ files (an atom; default is ‘'./dot_dias'’)

   - 
          ‘exclude_directories(Directories)’
          list of directories to exclude except as external nodes (default is ‘[]’)

   - 
          ‘exclude_files(Files)’
          list of source files to exclude except as external nodes (default is ‘[]’)

   - 
          ‘exclude_libraries(Libraries)’
          list of libraries to exclude except as external nodes (default is ‘[startup, scratch_directory]’)

   - 
          ‘zoom(Boolean)’
          generate sub-diagrams and add links and zoom icons to library and entity nodes (‘true’ or ‘false’; default is ‘false’)

   - 
          ‘zoom_url_suffix(Suffix)’
          extension for linked diagrams (an atom; default is ‘'.svg'’)

For library dependency diagrams, there is also the option:

   - ‘cycle_detection(Boolean)’ highlight cyclic relations by coloring
     the edges red (‘true’ or ‘false’; default is ‘false’)

When using the ‘zoom(true)’ option, the ‘layout(Layout)’ option applies
only to the top diagram; sub-diagrams will use their own layout default.

The option ‘omit_path_prefixes(Prefixes)’ with a non-empty list of
prefixes should preferably be used together with the option
‘directory_paths(true)’ when generating library or file diagrams that
reference external libraries or files.  To confirm the exact default
options used by each type of diagram, send the ‘default_options/1’
message to the diagram object.

Be sure to set the ‘source_data’ flag ‘on’ before compiling the
libraries or files for which you want to generate diagrams.

Support for displaying Prolog modules and Prolog module files in
diagrams of Logtalk applications:

   - 
          ECLiPSe
          file diagrams don’t display module files

   - 
          SICStus Prolog
          file diagrams don’t display module files

   - 
          SWI-Prolog
          full support (uses the SWI-Prolog ‘prolog_xref’ library)

   - 
          YAP
          full support (uses the YAP ‘prolog_xref’ library)


File: TheLogtalkHandbook-3.100.1.info,  Node: Linking diagrams,  Next: Creating diagrams for Prolog module applications,  Prev: Customization,  Up: diagrams

5.8.9 Linking diagrams
----------------------

When using SVG output, it’s possible to generate diagrams that link to
other diagrams, to API documentation, to local files and directories,
and to source code repositories.

For generating links between diagrams, use the ‘zoom(true)’ option.
This option allows (1) linking library diagrams to entity diagrams to
predicate cross-referencing diagrams and (2) linking directory diagrams
to file diagrams to entity diagrams to predicate cross-referencing
diagrams.  The sub-diagrams are automatically generated.  For example,
using the predicates that generate library diagrams will also
automatically generate the entity and predicate cross-referencing
diagrams.

To generate local links for opening directories, files, and file
locations in selected text editors, set the URL code prefix:

   - VSCode: ‘url_prefixes('vscode://file/', DocPrefix)’

   - VSCodium: ‘url_prefixes('vscodium://file/', DocPrefix)’

   - Cursor: ‘url_prefixes('cursor://file/', DocPrefix)’

   - PearAI: ‘url_prefixes('pearai://file/', DocPrefix)’

   - Windsurf: ‘url_prefixes('windsurf://file/', DocPrefix)’

   - Zed: ‘url_prefixes('zed://file/', DocPrefix)’

   - BBEdit: ‘url_prefixes('x-bbedit://open?url=file://', DocPrefix)’

   - MacVim: ‘url_prefixes('mvim://open?url=file://', DocPrefix)’

   - TextMate: ‘url_prefixes('txmt://open?url=file://', DocPrefix)’

   - IDEA: ‘url_prefixes('idea://open?file=', DocPrefix)’

   - PyCharm: ‘url_prefixes('pycharm://open?file=', DocPrefix)’

In this case, the ‘DocPrefix’ argument should be the path to the
directory containing the HTML version of the application APIs.

As most of the text editor URL scheme handlers require local links to
use absolute paths, the ‘omit_path_prefixes/1’ option is ignored.  Note
that local links require text editor support for URL schemes that can
handle both file and directory links.

To generate links to API documentation and source code repositories, use
the options ‘path_url_prefixes/3’ (or ‘url_prefixes/2’ for simpler
cases) and ‘omit_path_prefixes/1’.  The idea is that the
‘omit_path_prefixes/1’ option specifies local file prefixes that will be
cut and replaced by the URL prefixes (which can be path prefix specific
when addressing multiple code repositories).  To generate local file
system URLs, define the empty atom, ‘''’, as a prefix.  As an example,
consider the Logtalk library.  Its source code is available from a
GitHub repository, and its documentation is published on the Logtalk
website.  The relevant URLs in this case are:

   - ‘https://github.com/LogtalkDotOrg/logtalk3/’ (source code)

   - ‘https://logtalk.org/library/’ (API documentation)

Git source code URLs should include the commit SHA1 to ensure that
entity and predicate file line information in the URLs remain valid if
the code changes in later commits.  Assuming a ‘GitHub’ variable bound
to the SHA1 commit URL we want to reference, an inheritance diagram can
be generated using the goal:

     | ?- GitHub  = 'https://github.com/LogtalkDotOrg/logtalk3/commit/eb156d46e135ac47ef23adcc5d20d49dd8b66abb',
          APIDocs = 'https://logtalk.org/library/',
          logtalk_load(diagrams(loader)),
          set_logtalk_flag(source_data, on),
          logtalk_load(library(all_loader)),
          inheritance_diagram::rlibrary(library, [
              title('Logtalk library'),
              node_type_captions(true),
              zoom(true),
              path_url_prefixes('$LOGTALKUSER/', GitHub, APIDocs),
              path_url_prefixes('$LOGTALKHOME/', GitHub, APIDocs),
              omit_path_prefixes(['$LOGTALKUSER/', '$LOGTALKHOME/', '$HOME/'])
          ]).

The two ‘path_url_prefixes/3’ options take care of source code and API
documentation for entities loaded either from the Logtalk installation
directory (whose location is given by the ‘LOGTALKHOME’ environment
variable) or from the Logtalk user directory (whose location is given by
the ‘LOGTALKUSER’ environment variable).  As we also don’t want any
local operating-system paths to be exposed in the diagram, we use the
‘omit_path_prefixes/1’ option to suppress those path prefixes.  Note
that all the paths and URLs must end with a slash for proper handling.
The ‘git’ library may be useful to retrieve the commit SHA1 from a local
repo directory.

For both ‘path_url_prefixes/3’ and ‘omit_path_prefixes/1’ options, when
a path prefix is itself a prefix of another path, the shorter path must
come last to ensure correct links.

See the ‘SCRIPT.txt’ file in the tool directory for additional examples.
To avoid retyping such complex goals when updating diagrams, use the
‘doclet’ tool to save and reapply them easily (e.g., by using the ‘make’
tool with the ‘documentation’ target).


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating diagrams for Prolog module applications,  Next: Creating diagrams for plain Prolog files,  Prev: Linking diagrams,  Up: diagrams

5.8.10 Creating diagrams for Prolog module applications
-------------------------------------------------------

Currently limited to SWI-Prolog and YAP Prolog module applications due
to the lack of a comprehensive reflection API in other Prolog systems.

Simply load your Prolog module application and its dependencies and then
use diagram entity, directory, or file predicates.  Library diagram
predicates are not supported.  See the ‘SCRIPT.txt’ file in the tool
directory for some usage examples.  Note that support for diagrams with
links to API documentation is quite limited, however, due to the lack of
Prolog standards.


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating diagrams for plain Prolog files,  Next: Other notes,  Prev: Creating diagrams for Prolog module applications,  Up: diagrams

5.8.11 Creating diagrams for plain Prolog files
-----------------------------------------------

This tool can also be used to create predicate cross-referencing
diagrams for plain Prolog files.  For example, if the Prolog file is
named ‘code.pl’, simply define an object including its code:

     :- object(code).
         :- include('code.pl').
     :- end_object.

Save the object to an e.g.  ‘code.lgt’ file in the same directory as the
Prolog file and then load it and create the diagram:

     | ?- logtalk_load(code),
          xref_diagram::entity(code).

An alternative is to use the ‘object_wrapper_hook’ provided by the
‘hook_objects’ library:

     | ?- logtalk_load(hook_objects(loader)).
     ...

     | ?- logtalk_load(code, [hook(object_wrapper_hook)]),
          xref_diagram::entity(code).


File: TheLogtalkHandbook-3.100.1.info,  Node: Other notes,  Prev: Creating diagrams for plain Prolog files,  Up: diagrams

5.8.12 Other notes
------------------

Caller graph diagrams can be generated for a specific predicate using
the ‘caller_diagram’ object.  For example, to generate a caller graph
for the ‘list::member/2’ predicate:

     | ?- caller_diagram::predicate(list::member/2).

Non-terminal indicators can also be used.  For example:

     | ?- caller_diagram::predicate(number_grammars(chars)::digit//1).

Generating complete diagrams requires that all referenced entities are
loaded.  When that is not the case, notably when generating
cross-referencing diagrams, missing entities can result in incomplete
diagrams.

For complex applications, diagrams can often be made simpler and more
readable by omitting external nodes (see the ‘externals/1’ option)
and/or using one of the alternatives to ‘dot’ provided by Graphviz
depending on the type of the diagram (see the section above on supported
graph languages for more details).

When generating entity predicate call cross-reference diagrams, caller
nodes are not created for auxiliary predicates.  For example, if the
‘meta_compiler’ library is used to optimize meta-predicate calls, the
diagrams may show predicates that are not apparently called by any other
predicate when the callers are from the optimized meta-predicate goals
(which are called via library generated auxiliary predicates).  A
workaround in this case would be creating a dedicated loader file that
doesn’t load (and apply) the ‘meta_compiler’ library when generating the
diagrams.

When generating diagrams in SVG format, a copy of the ‘diagrams.css’
file must exist in any directory used for publishing diagrams using it.
The ‘lgt2svg’ scripts also take care of copying this file.

The Graphviz command-line utilities, e.g., ‘dot’, are notorious for
random crashes (segmentation faults usually), often requiring retrying
conversions from ‘.dot’ files to other formats.  A possible workaround
is to repeat the command until it completes without error.  See, for
example, the ‘lgt2svg.sh’ script.

The conversion by the ‘d2’ command-line executable of ‘.d2’ files to
‘.svg’ files can be quite slow (as of its 0.6.8 version) with the
default ‘elk’ layout engine.  The ‘dagre’ layout engine is much faster
but doesn’t support a node referencing itself (notably, a node
representing a metaclass that instantiates itself).

Using the default d2 layout engine (‘elk’) works fine with graphs with a
relatively small number of nodes and edges.  When that’s not the case,
it’s a good idea to experiment with other layout engines.


File: TheLogtalkHandbook-3.100.1.info,  Node: doclet,  Next: help,  Prev: diagrams,  Up: Developer Tools

5.9 ‘doclet’
============

This folder provides a simple tool for (re)generating documentation for
a project.  The tool defines a ‘doclet’ object that is expected to be
extended by the user to specify a sequence of goals and a sequence of
shell commands that load the application and (re)generate its
documentation.

Doclet source files are preferably named ‘doclet.lgt’ (or
‘doclet.logtalk’) and the doclet objects are usually named after the
application or library to be documented with a ‘_doclet’ suffix.  By
using an ‘initialization/1’ directive to automatically send the
‘update/0’ message that generates the documentation upon doclet loading,
we can abstract the name of the doclet object.  The usual query to load
and run a doclet is therefore:

     | ?- logtalk_load([doclet(loader), doclet]).

For usage examples, see the ‘sample_doclet.lgt’, ‘doclet1.lgt’,
‘zoom_doclet.lgt’, and ‘tools_doclet.lgt’ source files.

* Menu:

* API documentation: API documentation<7>.
* Loading: Loading<7>.
* Automating running doclets::
* Integration with the make tool: Integration with the make tool<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<7>,  Next: Loading<7>,  Up: doclet

5.9.1 API documentation
-----------------------

This tool API documentation is available at:

‘../../apis/library_index.html#doclet’

For sample queries, please see the ‘SCRIPT.txt’ file in the tool
directory.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<7>,  Next: Automating running doclets,  Prev: API documentation<7>,  Up: doclet

5.9.2 Loading
-------------

This tool can be loaded using the query:

     | ?- logtalk_load(doclet(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Automating running doclets,  Next: Integration with the make tool<2>,  Prev: Loading<7>,  Up: doclet

5.9.3 Automating running doclets
--------------------------------

You can use the ‘scripts/logtalk_doclet.sh’ Bash shell script for
automating running doclets.  The script expects the doclet source files
to be named either ‘doclet.lgt’ or ‘doclet.logtalk’.  See the
‘scripts/NOTES.md’ file or the script man page for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Integration with the make tool<2>,  Prev: Automating running doclets,  Up: doclet

5.9.4 Integration with the make tool
------------------------------------

Loading this tool adds a definition for the
‘logtalk_make_target_action/1’ hook predicate for the target
‘documentation’.  The hook definition sends an ‘update/0’ message to
each loaded doclet.


File: TheLogtalkHandbook-3.100.1.info,  Node: help,  Next: issue_creator,  Prev: doclet,  Up: Developer Tools

5.10 ‘help’
===========

This tool provides help for Logtalk features and libraries when running
in most operating-systems.  For help on the Logtalk compiler error and
warning messages, see the ‘tutor’ tool.

* Menu:

* Requirements: Requirements<2>.
* Customization: Customization<2>.
* API documentation: API documentation<8>.
* Loading: Loading<8>.
* Testing: Testing<7>.
* Supported operating-systems::
* Usage: Usage<5>.
* Known issues: Known issues<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Requirements<2>,  Next: Customization<2>,  Up: help

5.10.1 Requirements
-------------------

On Windows, the ‘start’ command must be available.  On Linux, the
‘xdg-open’ command must be available.  On macOS, the command ‘open’ is
used.  On POSIX systems ‘bsdtar’ is also required.

Browsing the Handbook and APIs documentation at the top-level requires a
POSIX system and one of the following terminal-based browsers installed:

   - ‘https://invisible-island.net/lynx/’

   - ‘https://w3m.sourceforge.net/’

   - ‘http://links.twibright.com/’

   - ‘https://sr.ht/~bptato/chawan/’

On macOS, these browsers and ‘bsdtar’ can be installed with either
MacPorts:

     $ sudo port install lynx
     $ sudo port install w3m
     $ sudo port install links
     $ sudo port install libarchive

Or using Homebrew:

     $ brew install lynx
     $ brew install w3m
     $ brew install links
     $ brew install chawan
     $ brew install libarchive

On Linux systems, use the distribution’s own package manager to install
the browsers and ‘bsdtar’.  For example, in Ubuntu systems:

     $ sudo apt install lynx
     $ sudo apt install w3m
     $ sudo apt install links2
     $ sudo apt install libarchive-tools

For RedHat systems:

     $ sudo dnf install lynx
     $ sudo dnf install w3m
     $ sudo dnf install links2
     $ sudo dnf install bsdtar

If you’re running Logtalk from a git clone of its repo, you will need to
run the ‘docs/apis/sources/build.sh’ or ‘docs/apis/sources/build.ps1’
scripts to generate APIs documentation HTML files and also run the
‘docs/handbook/sources/build.sh’ or ‘docs/handbook/sources/build.ps1’
scripts to generate the Handbook HTML files.  Alternatively, you can
download the documentation for the latest stable release from the
Logtalk website and save them to the ‘docs’ directories.


File: TheLogtalkHandbook-3.100.1.info,  Node: Customization<2>,  Next: API documentation<8>,  Prev: Requirements<2>,  Up: help

5.10.2 Customization
--------------------

The preferred browser can be set in a ‘settings.lgt’ file by defining
the ‘help_default_browser’ user-defined flag as follows:

     :- initialization(
         create_logtalk_flag(help_default_browser, Browser, [type(atom), keep(true)])
     ).

The valid values for ‘Browser’ are: ‘lynx’ (default value), ‘w3m’,
‘links’, ‘cha’, and ‘default’ (‘default’ means use the operating-system
default browser instead of one of the terminal-based browsers).

We can also select between browsing the HTML files generated by Sphinx
for web browsing or the XHTML files generated by Sphinx for the ePub
version of the documentation by defining the ‘help_default_files’
user-defined flag as follows:

     :- initialization(
         create_logtalk_flag(help_default_files, Format, [type(atom), keep(true)])
     ).

The valid values for ‘Format’ are ‘html’ (default value) or ‘xhtml’.

The ‘samples/settings-sample.lgt’ file contains commented out code for
defining these flags.

On POSIX systems, one of the supported terminal-based browsers must be
installed unless you prefer using the default browser.  By default, the
tool checks first for ‘lynx’, second for ‘w3m’, third for ‘links’, and
finally for ‘chawan’.  When none of these terminal-based browsers is
available in their default installation paths, the documentation is open
in the operating-system default browser.

On Windows systems, the documentation is open in the operating-system
default browser.

When using the terminal-based browsers, after finishing consulting the
documentation and quitting the process, you will be back to the
top-level prompt (if you find that the top-level have scrolled from its
last position, try to set your terminal terminfo to ‘xterm-256colour’).


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<8>,  Next: Loading<8>,  Prev: Customization<2>,  Up: help

5.10.3 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#help’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<8>,  Next: Testing<7>,  Prev: API documentation<8>,  Up: help

5.10.4 Loading
--------------

     | ?- logtalk_load(help(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<7>,  Next: Supported operating-systems,  Prev: Loading<8>,  Up: help

5.10.5 Testing
--------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(help(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported operating-systems,  Next: Usage<5>,  Prev: Testing<7>,  Up: help

5.10.6 Supported operating-systems
----------------------------------

Currently, support is limited to Linux, macOS, and Windows.

This tool relies on the library portable operating-system access
abstraction.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<5>,  Next: Known issues<3>,  Prev: Supported operating-systems,  Up: help

5.10.7 Usage
------------

After loading the tool, use the query ‘help::help’ to get started:

     | ?- logtalk_load(help(loader)).
     ...

     | ?- help::help.
     ...

When using ECLiPSe, you will need to write the object name, ‘help’,
between parentheses to avoid a clash with the ‘help’ built-in operator:

     | ?- (help)::help.
     ...

Same sample help queries:

     % get et on-line help for the `logtalk_load/2` built-in predicate:

     | ?- help::logtalk_load/2.
     ...

     % get on-line help for the `eos//0` built-in non-terminal:

     | ?- help::eos//0.
     ...

     % consult the Handbook:

     | ?- help::handbook.
     ...

     % consult the APIs documentation:

     | ?- help::apis.
     ...

     % consult the APIs documentation about a library predicate:

     | ?- help::apis(member/2).
     ...

     % consult the APIs documentation about a library non-terminal:

     | ?- help::apis(one_or_more//0).
     ...

     % consult the documentation of a library:

     | ?- help::library(random).
     ...

     % consult the documentation of an entity:

     | ?- help::entity(logtalk).
     ...

     % consult the developer tools documentation:

     | ?- help::tools.
     ...

     % consult the documentation of the lgtunit tool:

     | ?- help::tool(lgtunit).
     ...

     % consult the documentation of the logtalk_tester script:

     | ?- help::man(logtalk_tester).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<3>,  Prev: Usage<5>,  Up: help

5.10.8 Known issues
-------------------

When using the ‘lynx’ terminal-based browser, the ‘help_default_files’
flag setting is ignored as this browser doesn’t support XHTML.

When using the terminal-based browsers, the Handbook and APIs search
boxes are not usable as they require JavaScript support.  Use instead
the indexes.

Some CSS support is only provided by the Chawan terminal-based browser.
This results in formatting issues when browsing the Logtalk
documentation.  Some of these issues can be avoided by setting the
‘help_default_files’ flag to ‘xhtml’.

The open commands used to open documentation URLs in the default browser
drop the fragment part, thus preventing navigation to the specified
position on the documentation page.

ECLiPSe defines a ‘help’ prefix operator that forces wrapping this atom
between parentheses when sending messages to the tool.  E.g.  use
‘(help)::help’ instead of ‘help::help’.


File: TheLogtalkHandbook-3.100.1.info,  Node: issue_creator,  Next: lgtdoc,  Prev: help,  Up: Developer Tools

5.11 ‘issue_creator’
====================

This is a complementary tool for the ‘lgtunit’ tool for automatically
creating bug report issues for failed tests in GitHub or GitLab servers.

* Menu:

* Requirements: Requirements<3>.
* Loading: Loading<9>.
* Usage: Usage<6>.
* Known issues: Known issues<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Requirements<3>,  Next: Loading<9>,  Up: issue_creator

5.11.1 Requirements
-------------------

This tool requires that the GitHub ‘gh’ and GitLab ‘glab’ CLIs be
installed.  For the installation instructions see:

   - GitHub: ‘https://cli.github.com’

   - GitLab: ‘https://glab.readthedocs.io’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<9>,  Next: Usage<6>,  Prev: Requirements<3>,  Up: issue_creator

5.11.2 Loading
--------------

This tool can be loaded using the query:

     | ?- logtalk_load(issue_creator(loader)).

But, in the most common usage scenario, this tool is automatically
loaded by the ‘logtalk_tester’ automation script.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<6>,  Next: Known issues<4>,  Prev: Loading<9>,  Up: issue_creator

5.11.3 Usage
------------

The ‘logtalk_tester’ automation script accepts a ‘-b’ option for
automatically using this tool (see the script man page for details).  In
the most simple case, this option possible values are ‘github’ and
‘gitlab’.  For example:

     $ logtalk_tester \
         -p gnu \
         -b github \
         -s "/home/jdoe/foo/" \
         -u https://github.com/jdoe/foo/tree/55aa900775befa135e0d5b48ea63098df8b97f5c/

The ‘logtalk_tester’ script 'must' be called from a git repo directory
or one of its sub-directories, which is a common setup in CI/CD
pipelines.  Moreover, prior to running the tests, the CLI must be used,
if required, to authenticate and login to the server where the bug
report issues will be created:

   - GitHub: ‘gh auth login --hostname <string> --with-token <
     token.txt’

   - GitLab: ‘glab auth login --hostname <string> --token <string>’

The access token must have the necessary scopes that allow bug reports
to be created.  See the CLIs documentation for details.  Typically, the
‘auth’ command is called from the CI/CD pipeline definition scripts.
However, depending on the CI/CD workflow, the authentication may be done
implicitly.

The bug reports are created using by default the label ‘bug’ and
assigned to the author of the latest commit of the git repo.  The ‘-b’
option can also be used to override the label with a comma separated set
of labels.  For example, to use both ‘bug’ and ‘auto’ labels:

     $ logtalk_tester \
         -p gnu \
         -b github:bug,auto \
         -s "/home/jdoe/foo/" \
         -u https://github.com/jdoe/foo/tree/55aa900775befa135e0d5b48ea63098df8b97f5c/

Note that the labels 'must' be predefined in the issue tracker server
for the bug report to be successfully created.  The ‘auto’ label can be
used to simplify filtering of auto-generated bug reports when browsing
the issue tracker.

The bug reports use Markdown formatting, which is the default in GitHub
and GitLab issue trackers.

But reports are only created for non-flaky tests.  The bug report title
and labels are used to prevent creating duplicated bug reports.
Therefore, the title should not be manually edited and the same labels
should be used for multiple runs of the same tests and preserved when
editing the bug reports.

There are cases where we may want to postpone or temporarily disable the
automatic creation of bug reports.  E.g.  a WIP branch that’s known to
break multiple tests.  A solution is to define a pull/merge request
label, e.g.  ‘NO_AUTO_BUG_REPORTS’, that can then be checked by the
CI/CD workflow.  For example, we can test the presence of that label to
set a ‘AUTO_BUG_REPORTS’ environment variable to either an empty string
or a ‘-b’ option and use:

     logtalk_tester.sh $AUTO_BUG_REPORTS -p ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<4>,  Prev: Usage<6>,  Up: issue_creator

5.11.4 Known issues
-------------------

GitLab creates CI/CD pipelines in a detached HEAD state by default.  As
a consequence, the git branch would be reported as HEAD. To workaround
this issue, this tool uses the value of the GitLab CI/CD pipeline
variable ‘CI_COMMIT_REF_NAME’ when defined as the branch name.

This tool is in a beta stage of development.  Your feedback is most
appreciated.


File: TheLogtalkHandbook-3.100.1.info,  Node: lgtdoc,  Next: lgtunit,  Prev: issue_creator,  Up: Developer Tools

5.12 ‘lgtdoc’
=============

This is the default Logtalk documenting tool for generating API
documentation for libraries and applications.  It uses the structural
reflection API to extract and output in XML format relevant
documentation about a source file, a library or directory of source
files, or all loaded source files.  The tool predicates accept several
options for generating the XML files, including the output directory.

The ‘lgtdoc/xml’ directory contains several ready-to-use Bash and
PowerShell scripts for converting the XML documenting files into final
formats, including XHTML 1.1, HTML 4.01, HTML 5, PDF, Markdown, and
reStructuredText (for use with Sphinx), and plain text files.  The
scripts are described in their ‘man’ pages and made available in the
system path by default.

* Menu:

* Requirements: Requirements<4>.
* API documentation: API documentation<9>.
* Loading: Loading<10>.
* Testing: Testing<8>.
* Documenting source code::
* Generating documentation::
* Documentation linter checks::


File: TheLogtalkHandbook-3.100.1.info,  Node: Requirements<4>,  Next: API documentation<9>,  Up: lgtdoc

5.12.1 Requirements
-------------------

This tool requirements for converting the XML files it generates to a
final format are as follows:

  1. Converting XML files to (X)HTML, reStructuredText, Markdown, or
     plain text files requires a XSLT processor.  The supported XSLT
     processors for Bash conversion scripts are:

   - xsltproc: ‘https://gitlab.gnome.org/GNOME/libxslt/-/wikis/home’

   - Xalan: ‘https://xml.apache.org/xalan-c/index.html’

   - Saxon: ‘https://www.saxonica.com’

On Windows, the PowerShell scripts use the .Net XSLT classes.

The reStructuredText files output is usually used as an intermediate
step to generate Sphinx HTML, PDF, ePub, and Texinfo files.  The
additional requirements are:

   - Sphinx: ‘https://www.sphinx-doc.org/’

   - Pygments: ‘https://pygments.org/’

   - Read the Docs theme:
     ‘https://github.com/readthedocs/sphinx_rtd_theme’

  2. Converting XML files to PDF files require a XSL-FO processor.  The
     supported XSL-FO processors for Bash and PowerShell conversion
     scripts are:

   - Apache FOP processor: ‘https://xmlgraphics.apache.org/fop/’

   - RenderX XEP processor: ‘https://www.renderx.com/’

For additional details, including compatible dependency versions and
available conversion scripts, see the ‘xml/NOTES.md’ file.  See the
‘tools/NOTES.md’ file for per operating-system installation instructions
for the above dependencies.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<9>,  Next: Loading<10>,  Prev: Requirements<4>,  Up: lgtdoc

5.12.2 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#lgtdoc’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<10>,  Next: Testing<8>,  Prev: API documentation<9>,  Up: lgtdoc

5.12.3 Loading
--------------

This tool can be loaded using the query:

     | ?- logtalk_load(lgtdoc(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<8>,  Next: Documenting source code,  Prev: Loading<10>,  Up: lgtdoc

5.12.4 Testing
--------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(lgtdoc(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Documenting source code,  Next: Generating documentation,  Prev: Testing<8>,  Up: lgtdoc

5.12.5 Documenting source code
------------------------------

For information on documenting your source code, notably on documenting
directives, consult the documenting section of the User Manual:

‘../../handbook/userman/documenting.html’

Extracting documenting information from your source code using this tool
requires compiling the source files using the ‘source_data(on)’ compiler
flag.  For example:

     | ?- logtalk_load(source_file, [source_data(on)]).

Usually, this flag is set for all application source files in the
corresponding loader file.  In alternative, you may also turn on the
‘source_data’ flag globally by typing:

     | ?- set_logtalk_flag(source_data, on).

The tool API allows generating documentation for libraries, directories,
and files, complemented with library, directory, entity, and predicate
indexes.  Note that the source files to be documented 'must' be loaded
prior to using this tool predicates to generate the documentation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating documentation,  Next: Documentation linter checks,  Prev: Documenting source code,  Up: lgtdoc

5.12.6 Generating documentation
-------------------------------

For a simple application, assuming a library alias is defined for it
(e.g.  ‘my_app’), and at the top-level interpreter, we can generate the
application documentation by typing:

     | ?- {my_app(loader)}.
     ...

     | ?- {lgtdoc(loader)}.
     ...

     | ?- lgtdoc::library(my_app).
     ...

By default, the documenting XML files are created in a ‘xml_docs’
directory in the current working directory.  But usually all documenting
files are collected for both the application and the libraries it uses
in a common directory so that all documentation links resolved properly.
The ‘lgtdoc’ predicates can take a list of options to customize the
generated XML documenting files.  See the remarks section in the
lgtdocp(1) protocol documentation for details on the available options.

After generating the XML documenting files, these can be easily
converted into final formats using the provided scripts.  For example,
assuming that we want to generate HTML documentation:

     $ cd xml_docs
     $ lgt2html -t "My app"

To generate the documentation in Sphinx format instead (as used by
Logtalk itself for its APIs):

     $ cd xml_docs
     $ lgt2rst -s -- -q -p "Application name" -a "Author name" -v "Version X.YZ.P"
     $ make html

In this case, the generated documentation will be in the
‘xml_docs/_build/html/’ directory.  See the scripts man pages or call
them using the ‘-h’ option to learn more about their supported options.

For more complex applications, you can use the ‘doclet’ tool to define a
'doclet' to automate all the steps required to generate documentation.
The 'doclet' message that triggers the process can also be sent
automatically when the ‘make’ tool is used with the ‘documentation’
target.

   ---------- Footnotes ----------

   (1) ../../docs/apis/library_index.html#lgtdoc


File: TheLogtalkHandbook-3.100.1.info,  Node: Documentation linter checks,  Prev: Generating documentation,  Up: lgtdoc

5.12.7 Documentation linter checks
----------------------------------

When the ‘lgtdoc_missing_directives’ flag is set to ‘warning’ (its usual
default value), the ‘lgtdoc’ tool prints warnings on missing entity
‘info/1’ directives and missing predicate ‘info/2’ and ‘mode/2’
directives.

When the ‘lgtdoc_missing_info_key’ flag is set to ‘warning’ (its usual
default value), the ‘lgtdoc’ tool prints warnings on entity ‘info/1’
directive and predicate ‘info/2’ directive missing de facto required
keys (e.g., ‘comment’, ‘parameters’ or ‘parnames’ for parametric
entities, ‘arguments’ or ‘argnames’ for predicates/non-terminals with
arguments).

When the ‘lgtdoc_invalid_dates’ flag is set to ‘warning’ (its usual
default value), the ‘lgtdoc’ tool prints warnings on invalid dates
(including dates in the future) in ‘info/1’ directives.

When the ‘lgtdoc_non_standard_exceptions’ flag is set to ‘warning’ (its
usual default value), the ‘lgtdoc’ tool prints warnings on non-standard
exceptions.  This linter check is particularly effective in detecting
typos when specifying standard exceptions.

When the ‘lgtdoc_missing_punctuation’ flag is set to ‘warning’ (its
usual default value), the ‘lgtdoc’ tool prints warnings on missing
ending periods (full stops), exclamation marks, or question marks in
‘info/1-2’ directives (in comments, remarks, parameter descriptions, and
argument descriptions).

Set a flag value to ‘silent’ to turn off the corresponding linter
warnings.


File: TheLogtalkHandbook-3.100.1.info,  Node: lgtunit,  Next: linter,  Prev: lgtdoc,  Up: Developer Tools

5.13 ‘lgtunit’
==============

The ‘lgtunit’ tool provides testing support for Logtalk.  It can also be
used for testing plain Prolog code and Prolog module code.

This tool is inspired by the xUnit frameworks architecture and by the
works of Joachim Schimpf (ECLiPSe library ‘test_util’) and Jan
Wielemaker (SWI-Prolog ‘plunit’ package).

Tests are defined in objects, which represent a 'test set' or 'test
suite'.  In simple cases, we usually define a single object containing
the tests.  But it is also possible to use parametric test objects or
multiple objects defining parametrizable tests or test subsets for
testing more complex units and facilitating tests maintenance.
Parametric test objects are specially useful to test multiple
implementations of the same protocol using a single set of tests by
passing the implementation object as a parameter value.

* Menu:

* Main files::
* API documentation: API documentation<10>.
* Loading: Loading<11>.
* Testing: Testing<9>.
* Writing and running tests::
* Automating running tests::
* Parametric test objects::
* Test dialects::
* User-defined test dialects::
* QuickCheck::
* Skipping tests::
* Selecting tests::
* Checking test goal results::
* Testing local predicates::
* Testing non-deterministic predicates::
* Testing generators::
* Testing input/output predicates::
* Suppressing tested predicates output::
* Tests with timeout limits::
* Setup and cleanup goals::
* Test annotations::
* Test execution times and memory usage::
* Working with test data files::
* Flaky tests::
* Mocking::
* Debugging messages in tests::
* Debugging failed tests::
* Code coverage::
* Utility predicates::
* Exporting test results::
* Generating Allure reports::
* Exporting code coverage results::
* Automatically creating bug reports at issue trackers::
* Minimizing test results output::
* Help with warnings::
* Known issues: Known issues<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Main files,  Next: API documentation<10>,  Up: lgtunit

5.13.1 Main files
-----------------

The ‘lgtunit.lgt’ source file implements a framework for defining and
running unit tests in Logtalk.  The ‘lgtunit_messages.lgt’ source file
defines the default translations for the messages printed when running
unit tests.  These messages can be intercepted to customize the output,
e.g.  to make it less verbose or for integration with e.g.  GUI IDEs and
continuous integration servers.

Other files that are part of this tool provide support for alternative
output formats of test results and are discussed below.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<10>,  Next: Loading<11>,  Prev: Main files,  Up: lgtunit

5.13.2 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#lgtunit’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<11>,  Next: Testing<9>,  Prev: API documentation<10>,  Up: lgtunit

5.13.3 Loading
--------------

This tool can be loaded using the query:

     | ?- logtalk_load(lgtunit(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<9>,  Next: Writing and running tests,  Prev: Loading<11>,  Up: lgtunit

5.13.4 Testing
--------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(lgtunit(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Writing and running tests,  Next: Automating running tests,  Prev: Testing<9>,  Up: lgtunit

5.13.5 Writing and running tests
--------------------------------

In order to write your own unit tests, define objects extending the
‘lgtunit’ object.  You may start by copying the
‘samples/tests-sample.lgt’ file (at the root of the Logtalk
distribution) to a ‘tests.lgt’ file in your project directory and
editing it to add your tests:

     :- object(tests,
         extends(lgtunit)).

         % test definitions
         ...

     :- end_object.

The section on *note test dialects: 944. below describes in detail how
to write tests.  See the ‘tests’ top directory for examples of actual
unit tests.  Other sources of examples are the ‘library’ and ‘examples’
directories.

The tests must be term-expanded by the ‘lgtunit’ object by compiling the
source files defining the test objects using the option ‘hook(lgtunit)’.
For example:

     | ?- logtalk_load(lgtunit(loader)),
          logtalk_load(tests, [hook(lgtunit)]).

As the term-expansion mechanism applies to all the contents of a source
file, the source files defining the test objects should preferably not
contain entities other than the test objects.  Additional code necessary
for the tests should go to separate files.  In general, the tests
themselves can be compiled in 'optimized' mode.  Assuming that’s the
case, also use the ‘optimize(on)’ compiler option for faster execution.

The term-expansion performed by the ‘lgtunit’ object sets the test
object ‘source_data’ flag to ‘on’ and the ‘context_switching_calls’ flag
to ‘allow’ for code coverage and debugging support.  But these settings
can always be overridden in the test objects.

The ‘samples/tester-sample.lgt’ file (at the root of the Logtalk
distribution) exemplifies how to compile and load ‘lgtunit’ tool, the
source code under testing, the unit tests, and how to automatically run
all the tests after loading:

     :- initialization((
         % minimize compilation reports to the essential ones (errors and warnings)
         set_logtalk_flag(report, warnings),
         % load any necessary library files for your application; for example
         logtalk_load(basic_types(loader)),
         % load the unit test tool
         logtalk_load(lgtunit(loader)),
         % load your application files (e.g., "source.lgt") enabling support for
         % code coverage, which requires compilation in debug mode and collecting
         % source data information; if code coverage is not required, remove the
         % "debug(on)" option for faster execution
         logtalk_load(source, [source_data(on), debug(on)]),
         % compile the unit tests file expanding it using "lgtunit" as the hook
         % object to preprocess the tests; if you have failing tests, add the
         % option debug(on) to debug them (see "tools/lgtunit/NOTES.md" for
         % debugging advice); tests should be loaded after the code being tested
         % is loaded to avoid warnings such as references to unknown entities
         logtalk_load(tests, [hook(lgtunit)]),
         % run all the unit tests; assuming your tests object is named "tests"
         tests::run
     )).

You may copy this sample file to a ‘tester.lgt’ file in your project
directory and edit it to load your project and test files.  The
‘logtalk_tester’ testing automation script defaults to looking for test
driver files named ‘tester.lgt’ or ‘tester.logtalk’ (if you have
work-in-progress test sets that you don’t want to run by default, simply
use a different file name such as ‘tester_wip.lgt’; you can still run
them automated by using ‘logtalk_tester -n tester_wip’).

Debugged test sets should preferably be compiled in optimal mode,
specially when containing deterministic tests and when using the utility
benchmarking predicates.

Assuming a ‘tester.lgt’ driver file as exemplified above, the tests can
be run by simply loading this file:

     | ?- logtalk_load(tester).

Assuming your test object is named ‘tests’, you can re-run the tests by
typing:

     | ?- tests::run.

You can also re-run a single test (or a list of tests) using the ‘run/1’
predicate:

     | ?- tests::run(test_identifier).

When testing complex 'units', it is often desirable to split the tests
between several test objects or use parametric test objects to be able
to run the same tests using different parameters (e.g., different data
sets or alternative implementations of the same protocol).  In this
case, you can run all test subsets using the goal:

     | ?- lgtunit::run_test_sets([test_set_1, test_set_2, ...]).

where the ‘run_test_sets/1’ predicate argument is a list of two or more
test object identifiers.  This predicate makes it possible to get a
single code coverage report that takes into account all the tests.

It’s also possible to automatically run loaded tests when using the
‘make’ tool by calling the goal that runs the tests from a definition of
the hook predicate ‘logtalk_make_target_action/1’.  For example, by
adding to the tests ‘tester.lgt’ driver file the following code:

     % integrate the tests with logtalk_make/1
     :- multifile(logtalk_make_target_action/1).
     :- dynamic(logtalk_make_target_action/1).

     logtalk_make_target_action(check) :-
         tests::run.

Alternatively, you can define the predicate ‘make/1’ inside the test set
object.  For example:

     :- object(tests, extends(lgtunit)).

         make(check).
         ...

     :- end_object.

This clause will cause all tests to be run when calling the
‘logtalk_make/1’ predicate with the target ‘check’ (or its top-level
shortcut, ‘{?}’).  The other possible target is ‘all’ (with top-level
shortcut ‘{*}’).

Note that you can have multiple test driver files.  For example, one
driver file that runs the tests collecting code coverage data and a
quicker driver file that skips code coverage and compiles the code to be
tested in optimized mode.


File: TheLogtalkHandbook-3.100.1.info,  Node: Automating running tests,  Next: Parametric test objects,  Prev: Writing and running tests,  Up: lgtunit

5.13.6 Automating running tests
-------------------------------

You can use the ‘scripts/logtalk_tester.sh’ Bash shell script or the
‘scripts/logtalk_tester.ps1’ PowerShell script for automating running
unit tests (e.g., from a CI/CD pipeline).  When using one of the Logtalk
installers, the ‘.sh’ extension can usually be omitted.  For example,
assuming your current directory (or sub-directories) contains one or
more ‘tester.lgt’ files:

     $ logtalk_tester -p gnu

The only required argument is the identifier of the backend Prolog
system.  For other options, see the ‘scripts/NOTES.md’ file or type:

     $ logtalk_tester -h

On POSIX systems, you can also access extended documentation by
consulting the script man page:

     $ man logtalk_tester

The scripts support the same set of options.  But the option for passing
additional arguments to the tests uses different syntax.  For example:

     $ logtalk_tester -p gnu -- foo bar baz

     PS> logtalk_tester -p gnu -a foo,bar,baz

On POSIX systems, assuming Logtalk was installed using one of the
provided installers or installation scripts, there is also a ‘man’ page
for the script:

     $ man logtalk_tester

Alternatively, an HTML version of this man page can be found at:

‘https://logtalk.org/man/logtalk_tester.html’

On POSIX systems, the ‘logtalk_tester.sh’ Bash script timeout option
requires either a ‘timeout’ or a ‘gtimeout’ command (provided by the GNU
coreutils package).  The ‘logtalk_tester.ps1’ PowerShell script timeout
option requires that Git for Windows is also installed, as it requires
the GNU timeout command bundled with it.

In addition to using the ‘logtalk_tester.ps1’ PowerShell script, the
Bash shell version of the automation script can also be used in Windows
operating-systems with selected backends by using the Bash shell
included in the Git for Windows installer.  That requires defining a
‘.profile’ file setting the paths to the Logtalk scripts and the Prolog
backend executables.  For example:

     $ cat ~/.profile
     # YAP
     export PATH="/C/Program Files/Yap64/bin":$PATH
     # GNU Prolog
     export PATH="/C/GNU-Prolog/bin":$PATH
     # SWI/Prolog
     export PATH="/C/Program Files/swipl/bin":$PATH
     # ECLiPSe
     export PATH="/C/Program Files/ECLiPSe 7.0/lib/x86_64_nt":$PATH
     # SICStus Prolog
     export PATH="/C/Program Files/SICStus Prolog VC16 4.6.0/bin":$PATH
     # Logtalk
     export PATH="$LOGTALKHOME/scripts":"$LOGTALKHOME/integration":$PATH

The Git for Windows installer also includes GNU ‘coreutils’ and its
‘timeout’ command, which is used by the ‘logtalk_tester’ script ‘-t’
option.

Note that some tests may give different results when run from within the
Bash shell compared with running the tests manually using a Windows GUI
version of the Prolog backend.  Some backends may also not be usable for
automated testing due to the way they are made available as Windows
applications.

Additional advice on testing and on automating testing using continuous
integration servers can be found at:

‘https://logtalk.org/testing.html’


File: TheLogtalkHandbook-3.100.1.info,  Node: Parametric test objects,  Next: Test dialects,  Prev: Automating running tests,  Up: lgtunit

5.13.7 Parametric test objects
------------------------------

Parameterized unit tests can be easily defined by using parametric test
objects.  A typical example is testing multiple implementations of the
same protocol.  In this case, we can use a parameter to pass the
specific implementation being tested.  For example, assume that we want
to run the same set of tests for the library ‘random_protocol’ protocol.
We can write:

     :- object(tests(_RandomObject_),
         extends(lgtunit)).

         :- uses(_RandomObject_, [
             random/1, between/3, member/2,
             ...
         ]).

         test(between_3_in_interval) :-
             between(1, 10, Random),
             1 =< Random, Random =< 10.

         ...

     :- end_object.

We can then test a specific implementation by instantiating the
parameter.  For example:

     | ?- tests(fast_random)::run.

Or use the ‘lgtunit::run_test_sets/1’ predicate to test all the
implementations:

     | ?- lgtunit::run_test_sets([
             tests(backend_random),
             tests(fast_random),
             tests(random)
          ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test dialects,  Next: User-defined test dialects,  Prev: Parametric test objects,  Up: lgtunit

5.13.8 Test dialects
--------------------

Multiple test 'dialects' are supported by default.  See the next section
on how to define your own test dialects.  In all dialects, a 'ground
callable term', usually an atom, is used to uniquely identify a test.
This simplifies reporting failed tests and running tests selectively.
An error message is printed if invalid or duplicated test identifiers
are found.  These errors must be corrected; otherwise the reported test
results can be misleading.  Ideally, tests should have descriptive names
that clearly state the purpose of the test and what is being tested.

Unit tests can be written using any of the following predefined
dialects:

     test(Test) :- Goal.

This is the most simple dialect, allowing the specification of tests
that are expected to succeed.  The argument of the ‘test/1’ predicate is
the test identifier, which must be unique.  A more versatile dialect is:

     succeeds(Test) :- Goal.
     deterministic(Test) :- Goal.
     fails(Test) :- Goal.
     throws(Test, Ball) :- Goal.
     throws(Test, Balls) :- Goal.

This is a straightforward dialect.  For ‘succeeds/1’ tests, ‘Goal’ is
expected to succeed.  For ‘deterministic/1’ tests, ‘Goal’ is expected to
succeed once without leaving a choice-point.  For ‘fails/1’ tests,
‘Goal’ is expected to fail.  For ‘throws/2’ tests, ‘Goal’ is expected to
throw the exception term ‘Ball’ or one of the exception terms in the
list ‘Balls’.  The specified exception must subsume the actual exception
for the test to succeed.

An alternative test dialect that can be used with more expressive power
is:

     test(Test, Outcome) :- Goal.

The possible values of the outcome argument are:

   - 
          ‘true’
          The test is expected to succeed.

   - 
          ‘true(Assertion)’
          The test is expected to succeed and satisfy the ‘Assertion’ goal.

   - 
          ‘deterministic’
          The test is expected to succeed once without leaving a choice-point.

   - 
          ‘deterministic(Assertion)’
          The test is expected to succeed once without leaving a choice-point and satisfy the ‘Assertion’ goal.

   - 
          ‘subsumes(Expected, Result)’
          The test is expected to succeed by binding ‘Result’ to a term that is subsumed by the ‘Expected’ term.

   - 
          ‘variant(Term1, Term2)’
          The test is expected to succeed by binding ‘Term1’ to a term that is a variant of the ‘Term2’ term.

   - 
          ‘exists(Assertion)’
          A solution exists for the test goal that satisfies the ‘Assertion’ goal.

   - 
          ‘all(Assertion)’
          All test goal solutions satisfy the ‘Assertion’ goal.

   - 
          ‘fail’
          The test is expected to fail.

   - 
          ‘false’
          The test is expected to fail.

   - 
          ‘error(Error)’
          The test is expected to throw the exception term ‘error(ActualError, _)’ where ‘ActualError’ is subsumed ‘Error’.

   - 
          ‘errors(Errors)’
          The test is expected to throw an exception term ‘error(ActualError, _)’ where ‘ActualError’ is subsumed by an element of the list ‘Errors’.

   - 
          ‘ball(Ball)’
          The test is expected to throw the exception term ‘ActualBall’ where ‘ActualBall’ is subsumed ‘Ball’.

   - 
          ‘balls(Balls)’
          The test is expected to throw an exception term ‘ActualBall’ where ‘ActualBall’ is subsumed by an element of the list ‘Balls’.

In the case of the ‘true(Assertion)’, ‘deterministic(Assertion)’, and
‘all(Assertion)’ outcomes, a message that includes the assertion goal is
printed for assertion failures and errors to help to debug failed unit
tests.  Same for the ‘subsumes(Expected, Result)’ and ‘variant(Term1,
Term2)’ assertions.  Note that this message is only printed when the
test goal succeeds, as its failure will prevent the assertion goal from
being called.  This allows distinguishing between test goal failure and
assertion failure.

Note that the ‘all(Assertion)’ outcome simplifies pinpointing which test
goal solution failed the assertion.  See also the section below on
testing non-deterministic predicates.

The ‘fail’ and ‘false’ outcomes are better reserved for cases where
there is a single test goal.  With multiple test goals, the test will
succeed when 'any' of those goals fail.

Some tests may require individual condition, setup, or cleanup goals.
In this case, the following alternative test dialect can be used:

     test(Test, Outcome, Options) :- Goal.

The currently supported options are (non-recognized options are
ignored):

   - 
          ‘condition(Goal)’
          Condition for deciding if the test should be run or skipped (default goal is ‘true’).

   - 
          ‘setup(Goal)’
          Setup goal for the test (default goal is ‘true’).

   - 
          ‘cleanup(Goal)’
          Cleanup goal for the test (default goal is ‘true’).

   - 
          ‘flaky’
          Declare the test as a flaky test.

   - 
          ‘note(Term)’
          Annotation to print (between parentheses by default) after the test result (default is ‘''’); the annotation term can share variables with the test goal, which can be used to pass additional information about the test result.

Also supported is QuickCheck testing, where random tests are
automatically generated and run given a predicate mode template with
type information for each argument (see the section below for more
details):

     quick_check(Test, Template, Options).
     quick_check(Test, Template).

The valid options are the same as for the ‘test/3’ dialect plus all the
supported QuickCheck specific options (see the QuickCheck section below
for details).

For examples of how to write unit tests, check the ‘tests’ folder or the
‘testing’ example in the ‘examples’ folder in the Logtalk distribution.
Most of the provided examples also include unit tests, some of them with
code coverage.


File: TheLogtalkHandbook-3.100.1.info,  Node: User-defined test dialects,  Next: QuickCheck,  Prev: Test dialects,  Up: lgtunit

5.13.9 User-defined test dialects
---------------------------------

Additional test dialects can be easily defined by extending the
‘lgtunit’ object and by term-expanding the new dialect into one of the
default dialects.  As an example, suppose that you want a dialect where
you can simply write a file with tests defined by clauses using the
format:

     test_identifier :-
         test_goal.

First, we define an expansion for this file into a test object:

     :- object(simple_dialect,
         implements(expanding)).

         term_expansion(begin_of_file, [(:- object(tests,extends(lgtunit)))]).
         term_expansion((Head :- Body), [test(Head) :- Body]).
         term_expansion(end_of_file, [(:- end_object)]).

     :- end_object.

Then we can use this hook object to expand and run tests written in this
dialect by using a ‘tester.lgt’ driver file with contents such as:

     :- initialization((
         set_logtalk_flag(report, warnings),
         logtalk_load(lgtunit(loader)),
         logtalk_load(hook_flows(loader)),
         logtalk_load(simple_dialect),
         logtalk_load(tests, [hook(hook_pipeline([simple_dialect,lgtunit]))]),
         tests::run
     )).

The hook pipeline first applies our ‘simple_dialect’ expansion, followed
by the default ‘lgtunit’ expansion.  This solution allows other hook
objects (e.g., required by the code being tested) to also be used by
updating the pipeline.


File: TheLogtalkHandbook-3.100.1.info,  Node: QuickCheck,  Next: Skipping tests,  Prev: User-defined test dialects,  Up: lgtunit

5.13.10 QuickCheck
------------------

QuickCheck was originally developed for Haskell.  Implementations for
several other programming languages soon followed.  QuickCheck provides
support for 'property-based testing'.  The idea is to express properties
that predicates must comply with and automatically generate tests for
those properties.  The ‘lgtunit’ tool supports both ‘quick_check/2-3’
test dialects, as described above, and ‘quick_check/1-3’ public
predicates for interactive use:

     quick_check(Template, Result, Options).
     quick_check(Template, Options).
     quick_check(Template).

The following options are supported:

   - ‘n/1’: number of random tests that will be generated and run
     (default is 100).

   - ‘s/1’: maximum number of shrink operations when a counter-example
     is found (default is 64).

   - ‘ec/1’: boolean option deciding if type edge cases are tested
     before generating random tests (default is ‘true’).

   - ‘rs/1’: starting seed to be used when generating the random tests
     (no default).

   - ‘pc/1’: pre-condition closure for generated tests (extended with
     the test arguments; no default).

   - ‘l/1’: label closure for classifying the generated tests (extended
     with the test arguments plus the label argument; no default).

   - ‘v/1’: boolean option for verbose reporting of generated random
     tests (default is ‘false’).

   - ‘pb/2’: progress bar option for executed random tests when the
     verbose option is false (first argument is a boolean, default is
     ‘false’; second argument is the tick number, a positive integer).

The ‘quick_check/1’ predicate uses the default option values.  The
‘quick_check/1-2’ predicates print the test results and are thus better
reserved for testing at the top-level interpreter.  The ‘quick_check/3’
predicate returns results in reified form:

   - ‘passed(SequenceSeed, Discarded, Labels)’

   - ‘failed(Goal, SequenceSeed, TestSeed)’

   - ‘error(Error, Goal, SequenceSeed, TestSeed)’

   - ‘broken(Why, Culprit)’

The ‘broken(Why, Culprit)’ result only occurs when the user-defined
testing setup is broken.  For example, a non-callable template (e.g., a
non-existing predicate), an invalid option, a problem with the
pre-condition closure or with the label closure (e.g., a pre-condition
that always fails or a label that fails to classify a generated test),
or errors/failures when generating tests (e.g., due to an unknown type
being used in the template or a broken custom type arbitrary value
generator).

The ‘Goal’ argument is the random test that failed.

The ‘SequenceSeed’ argument is the starting seed used to generate the
sequence of random tests.  The ‘TestSeed’ is the seed used to generate
the test that failed.  Both seeds should be regarded as opaque terms.
When the test seed is equal to the sequence seed, this means that the
failure or error occurred while using only type edge cases.  See below
how to use the seeds when testing bug fixes.

The ‘Discarded’ argument returns the number of generated tests that were
discarded for failing to comply with a pre-condition specified using the
‘pc/1’ option.  This option is specially useful when constraining or
enforcing a relation between the generated arguments and is often used
as an alternative to define a custom type.  For example, if we define
the following predicate:

     condition(I) :-
         between(0, 127, I).

We can then use it to filter the generated tests:

     | ?- lgtunit::quick_check(integer(+byte), [pc(condition)]).
     % 100 random tests passed, 94 discarded
     % starting seed: seed(416,18610,17023)
     yes

The ‘Labels’ argument returns a list of pairs ‘Label-N’ where ‘N’ is the
number of generated tests that are classified as ‘Label’ by a closure
specified using the ‘l/1’ option.  For example, assuming the following
predicate definition:

     label(I, Label) :-
         (   I mod 2 =:= 0 ->
             Label = even
         ;   Label = odd
         ).

We can try:

     | ?- lgtunit::quick_check(integer(+byte), [l(label), n(10000)]).
     % 10000 random tests passed, 0 discarded
     % starting seed: seed(25513,20881,16407)
     % even: 5037/10000 (50.370000%)
     % odd: 4963/10000 (49.630000%)
     yes

The label statistics are key to verifying that the generated tests
provide the necessary coverage.  The labeling predicates can return a
single test label or a list of test labels.  Labels should be ground and
are typically atoms.  To examine the generated tests themselves, you can
use the verbose option, ‘v/1’.  For example:

     | ?- lgtunit::quick_check(integer(+integer), [v(true), n(7), pc([I]>>(I>5))]).
     % Discarded: integer(0)
     % Passed:    integer(786)
     % Passed:    integer(590)
     % Passed:    integer(165)
     % Discarded: integer(-412)
     % Passed:    integer(440)
     % Discarded: integer(-199)
     % Passed:    integer(588)
     % Discarded: integer(-852)
     % Discarded: integer(-214)
     % Passed:    integer(196)
     % Passed:    integer(353)
     % 7 random tests passed, 5 discarded
     % starting seed: seed(23671,3853,29824)
     yes

When a counter-example is found, the verbose option also prints the
shrink steps.  For example:

     | ?- lgtunit::quick_check(atom(+atomic), [v(true), ec(false)]).
     % Passed:    atom('dyO=Xv_MX-3b/U4KH U')
     *     Failure:   atom(-198)
     *     Shrinked:  atom(-99)
     *     Shrinked:  atom(-49)
     *     Shrinked:  atom(-24)
     *     Shrinked:  atom(-12)
     *     Shrinked:  atom(-6)
     *     Shrinked:  atom(-3)
     *     Shrinked:  atom(-1)
     *     Shrinked:  atom(0)
     *     quick check test failure (at test 2 after 8 shrinks):
     *       atom(0)
     *     starting seed: seed(3172,9814,20125)
     *     test seed:     seed(7035,19506,18186)
     no

The template can be a ‘(::)/2’, ‘(<<)/2’, or ‘(:)/2’ qualified callable
term.  When the template is an unqualified callable term, it will be
used to construct a goal to be called in the context of the 'sender'
using the ‘(<<)/2’ debugging control construct.  Another simple example
is passing a template that will trigger a failed test (as the
‘random::random/1’ predicate always returns non-negative floats):

     | ?- lgtunit::quick_check(random::random(-negative_float)).
     *     quick check test failure (at test 1 after 0 shrinks):
     *       random::random(0.09230089279334841)
     *     starting seed: seed(3172,9814,20125)
     *     test seed:     seed(3172,9814,20125)
     no

When QuickCheck exposes a bug in the tested code, we can use the
reported counter-example to help diagnose it and fix it.  As tests are
randomly generated, we can use the starting seed reported with the
counter-example to confirm the bug fix by calling the ‘quick_check/2-3’
predicates with the ‘rs(Seed)’ option.  For example, assume the
following broken predicate definition:

     every_other([], []).
     every_other([_, X| L], [X | R]) :-
         every_other(L, R).

The predicate is supposed to construct a list by taking every other
element of an input list.  Cursory testing may fail to notice the bug:

     | ?- every_other([1,2,3,4,5,6], List).
     List = [2, 4, 6]
     yes

But QuickCheck will report a bug with lists with an odd number of
elements with a simple property that verifies that the predicate always
succeeds and returns a list of integers:

     | ?- lgtunit::quick_check(every_other(+list(integer), -list(integer))).
     *     quick check test failure (at test 2 after 0 shrinks):
     *       every_other([0],A)
     *     starting seed: seed(3172,9814,20125)
     *     test seed:     seed(3172,9814,20125)
     no

We could fix this particular bug by rewriting the predicate:

     every_other([], []).
     every_other([H| T], L) :-
         every_other(T, H, L).

     every_other([], X, [X]).
     every_other([_| T], X, [X| L]) :-
         every_other(T, L).

By retesting with the same test seed that uncovered the bug, the same
random test that found the bug will be generated and run again:

     | ?- lgtunit::quick_check(
             every_other(+list(integer), -list(integer)),
             [rs(seed(3172,9814,20125))]
          ).
     % 100 random tests passed, 0 discarded
     % starting seed: seed(3172,9814,20125)
     yes

Still, after verifying the bug fix, is also a good idea to re-run the
tests using the sequence seed instead, as bug fixes sometimes cause
regressions elsewhere.

When retesting using the ‘logtalk_tester’ automation script, the
starting seed can be set using the ‘-r’ option.  For example:

     $ logtalk_tester -r "seed(3172,9814,20125)"

We could now move to other properties that the predicate should comply
with (e.g., all elements in the output list being present in the input
list).  Often, both traditional unit tests and QuickCheck tests are
used, complementing each other to ensure the required code coverage.

Another example using a Prolog module predicate:

     | ?- lgtunit::quick_check(
             pairs:pairs_keys_values(
                 +list(pair(atom,integer)),
                 -list(atom),
                 -list(integer)
             )
          ).
     % 100 random tests passed, 0 discarded
     % starting seed: seed(3172,9814,20125)
     yes

As illustrated by the examples above, properties are expressed using
predicates.  In the most simple cases, that can be the predicate that we
are testing itself.  But, in general, it will be an auxiliary predicate
calling the predicate or predicates being tested and checking properties
that the results must comply with.

The QuickCheck test dialects and predicates take as argument the mode
template for a property, generate random values for each input argument
based on the type information, and check each output argument.  For
common types, the implementation tries first (by default) common edge
cases (e.g., empty atom, empty list, or zero) before generating
arbitrary values.  When the output arguments check fails, the QuickCheck
implementation tries (by default) up to 64 shrink operations of the
counter-example to report a simpler case to help debugging the failed
test.  Edge cases, generating arbitrary terms, and shrinking terms make
use of the library ‘arbitrary’ category via the ‘type’ object (both
entities can be extended by the user by defining clauses for multifile
predicates).

The mode template syntax is the same as that used in the ‘info/2’
predicate directives with an additional notation, ‘{}/1’, for passing
argument values as-is instead of generating random values for these
arguments.  For example, assume that we want to verify the
‘type::valid/2’ predicate, which takes as its first argument a type.
Randomly generating random types would be cumbersome at best but the
main problem is that we need to generate random values for the second
argument according to the first argument.  Using the ‘{}/1’ notation, we
can solve this problem for any specific type, e.g.  integer, by writing:

     | ?- lgtunit::quick_check(type::valid({integer}, +integer)).

We can also test all (ground, i.e.  non-parametric) types with arbitrary
value generators by writing:

     | ?- forall(
             (type::type(Type), ground(Type), type::arbitrary(Type)),
             lgtunit::quick_check(type::valid({Type}, +Type))
          ).

You can find the list of the basic supported types for use in the
template in the API documentation for the library entities ‘type’ and
‘arbitrary’.  Note that other library entities, including third-party or
your own, can contribute with additional type definitions, as both
‘type’ and ‘arbitrary’ entities are user-extensible by defining clauses
for their multifile predicates.

The user can define new types to use in the property mode templates to
use with its QuickCheck tests by defining clauses for the ‘type’ library
object and the ‘arbitrary’ library category multifile predicates.
QuickCheck will use the later to generate arbitrary input arguments and
the former to verify output arguments.  As a toy example, assume that
the property mode template has an argument of type ‘bit’ with possible
values ‘0’ and ‘1’.  We would then need to define:

     :- multifile(type::type/1).
     type::type(bit).

     :- multifile(type::check/2).
     type::check(bit, Term) :-
         once((Term == 0; Term == 1)).

     :- multifile(arbitrary::arbitrary/1).
     arbitrary::arbitrary(bit).

     :- multifile(arbitrary::arbitrary/2).
     arbitrary::arbitrary(bit, Arbitrary) :-
         random::member(Arbitrary, [0, 1]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Skipping tests,  Next: Selecting tests,  Prev: QuickCheck,  Up: lgtunit

5.13.11 Skipping tests
----------------------

A test object can define the ‘condition/0’ predicate (which defaults to
‘true’) to test if some necessary condition for running the tests holds.
The tests are skipped if the call to this predicate fails or generates
an error.

Individual tests that for some reason should be unconditionally skipped
can have the test clause head prefixed with the ‘(-)/1’ operator.  For
example:

     - test(not_yet_ready) :-
         ...

In this case, it’s a good idea to use the ‘test/3’ dialect with a
‘note/1’ option that briefly explains why the test is being skipped.
For example:

     - test(xyz_reset, true, [note('Feature xyz reset not yet implemented')]) :-
         ...

The number of skipped tests is reported together with the numbers of
passed and failed tests.  To skip a test depending on some condition,
use the ‘test/3’ dialect and the ‘condition/1’ option.  For example:

     test(test_id, true, [condition(current_prolog_flag(bounded,true))) :-
         ...

The test is skipped if the condition goal fails or generates an error.
The conditional compilation directives can also be used in alternative,
but note that in this case there will be no report on the number of
skipped tests.


File: TheLogtalkHandbook-3.100.1.info,  Node: Selecting tests,  Next: Checking test goal results,  Prev: Skipping tests,  Up: lgtunit

5.13.12 Selecting tests
-----------------------

While debugging an application, we often want to temporarily run just a
selection of relevant tests.  This is specially useful when running all
the tests slows down and distracts from testing fixes for a specific
issue.  This can be accomplished by prefixing the clause heads of the
selected tests with the ‘(+)/1’ operator.  For example:

     :- object(tests,
         extends(lgtunit)).

         cover(ack).

         test(ack_1, true(Result == 11)) :-
             ack::ack(2, 4, Result).

         + test(ack_2, true(Result == 61)) :-
             ack::ack(3, 3, Result).

         test(ack_3, true(Result == 125)) :-
             ack::ack(3, 4, Result).

     :- end_object.

In this case, only the ‘ack_2’ would run.  Just be careful to remove all
‘(+)/1’ test prefixes when done debugging the issue that prompted you to
run just the selected tests.  After, be sure to run all the tests to
ensure there are no regressions introduced by your fixes.


File: TheLogtalkHandbook-3.100.1.info,  Node: Checking test goal results,  Next: Testing local predicates,  Prev: Selecting tests,  Up: lgtunit

5.13.13 Checking test goal results
----------------------------------

Checking test goal results can be performed using the ‘test/2-3’
supported outcomes such as ‘true(Assertion)’ and
‘deterministic(Assertion)’.  For example:

     test(compare_3_order_less, deterministic(Order == (<))) :-
         compare(Order, 1, 2).

For the other test dialects, checking test goal results can be performed
by calling the ‘assertion/1-2’ utility predicates or by writing the
checking goals directly in the test body.  For example:

     test(compare_3_order_less) :-
         compare(Order, 1, 2),
         ^^assertion(Order == (<)).

or:

     succeeds(compare_3_order_less) :-
         compare(Order, 1, 2),
         Order == (<).

Using assertions is, however, preferable to directly checking test
results in the test body as it facilitates debugging by printing the
unexpected results when the assertions fail.

The ‘assertion/1-2’ utility predicates are also useful for the
‘test/2-3’ dialects when we want to check multiple assertions in the
same test.  For example:

     test(dictionary_clone_4_01, true) :-
         as_dictionary([], Dictionary),
         clone(Dictionary, DictionaryPairs, Clone, ClonePairs),
         empty(Clone),
         ^^assertion(original_pairs, DictionaryPairs == []),
         ^^assertion(clone_pairs, ClonePairs == []).

Ground results can be compared using the standard ‘==/2’ term equality
built-in predicate.  Non-ground results can be compared using the
‘variant/2’ predicate provided by ‘lgtunit’.  The standard
‘subsumes_term/2’ built-in predicate can be used when testing a compound
term structure while abstracting some of its arguments.  Floating-point
numbers can be compared using the ‘=~=/2’, ‘approximately_equal/3’,
‘essentially_equal/3’, and ‘tolerance_equal/4’ predicates provided by
‘lgtunit’.  Using the ‘=/2’ term unification built-in predicate is
almost always an error, as it would mask test goals failing to bind
output arguments.  The ‘lgtunit’ tool implements a linter check for the
use of unification goals in test outcome assertions.  In the rare cases
that a unification goal is intended, wrapping the ‘(=)/2’ goal using the
‘{}/1’ control construct avoids the linter warning.

When the meta-argument of the ‘assertion/1-2’ predicates is call to a
local predicate (in the tests object), you need to call them using the
‘(::)/2’ message-sending control construct instead of the ‘(^^)/2’
'super' call control construct.  This is necessary as 'super' calls
preserve the 'sender', and the tests are implicitly run by the ‘lgtunit’
object sending a message to the tests object.  For example:

     :- uses(lgtunit, [
         assertion/1
     ]).

     test(my_test_id, true) :-
         foo(X, Y),
         assertion(consistent(X, Y)).

     consistent(X, Y) :-
         ...

In this case, the 'sender' is the tests object, and the ‘assertion/1’
meta-predicate will call the local ‘consistent/2’ predicate in the
expected context.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing local predicates,  Next: Testing non-deterministic predicates,  Prev: Checking test goal results,  Up: lgtunit

5.13.14 Testing local predicates
--------------------------------

The ‘(<<)/2’ debugging control construct can be used to access and test
object local predicates (i.e., predicates without a scope directive).
In this case, make sure that the ‘context_switching_calls’ compiler flag
is set to ‘allow’ for those objects.  This is seldom required, however,
as local predicates are usually auxiliary predicates called by public
predicates and thus tested when testing those public predicates.  The
code coverage support can pinpoint any local predicate clause that is
not being exercised by the tests.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing non-deterministic predicates,  Next: Testing generators,  Prev: Testing local predicates,  Up: lgtunit

5.13.15 Testing non-deterministic predicates
--------------------------------------------

For testing non-deterministic predicates (with a finite and manageable
number of solutions), you can wrap the test goal using the standard
‘findall/3’ predicate to collect all solutions and check against the
list of expected solutions.  When the expected solutions are a set, use
in alternative the standard ‘setof/3’ predicate.

If you want to check that all solutions of a non-deterministic predicate
satisfy an assertion, use the ‘test/2’ or ‘test/3’ test dialect with the
‘all(Assertion)’ outcome.  For example:

     test(atom_list, all(atom(Item))) :-
         member(Item, [a, b, c]).

See also the next section on testing 'generators'.

If you want to check that a solution exists for a non-deterministic
predicate that satisfies an assertion, use the ‘test/2’ or ‘test/3’ test
dialect with the ‘exists(Assertion)’ outcome.  For example:

     test(at_least_one_atom, exists(atom(Item))) :-
         member(Item, [1, foo(2), 3.14, abc, 42]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing generators,  Next: Testing input/output predicates,  Prev: Testing non-deterministic predicates,  Up: lgtunit

5.13.16 Testing generators
--------------------------

To test all solutions of a predicate that acts as a 'generator', we can
use either the ‘all/1’ outcome or the ‘forall/2’ predicate as the test
goal with the ‘assertion/2’ predicate called to report details on any
solution that fails the test.  For example:

     test(test_solution_generator, all(test(X,Y,Z))) :-
         generator(X, Y, Z).

or:

     :- uses(lgtunit, [assertion/2]).
     ...

     test(test_solution_generator_2) :-
         forall(
             generator(X, Y, Z),
             assertion(generator(X), test(X,Y,Z))
         ).

While using the ‘all/1’ outcome results in a more compact test
definition, using the ‘forall/2’ predicate allows customizing the
assertion description.  In the example above, we use the ‘generator(X)’
description instead of the ‘test(X,Y,Z)’ description implicit when we
use the ‘all/1’ outcome.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing input/output predicates,  Next: Suppressing tested predicates output,  Prev: Testing generators,  Up: lgtunit

5.13.17 Testing input/output predicates
---------------------------------------

Extensive support for testing input/output predicates is provided, based
on similar support found on the Prolog conformance testing framework
written by Péter Szabó and Péter Szeredi.

Two sets of predicates are provided, one for testing text input/output
and one for testing binary input/output.  In both cases, temporary files
(possibly referenced by a user-defined alias) are used.  The predicates
allow setting, checking, and cleaning text/binary input/output.  These
predicates are declared as protected and thus called using the ‘(^^/1)’
control construct.

As an example of testing an input predicate, consider the standard
‘get_char/1’ predicate.  This predicate reads a single character (atom)
from the current input stream.  Some test for basic functionality could
be:

     test(get_char_1_01, true(Char == 'q')) :-
         ^^set_text_input('qwerty'),
         get_char(Char).

     test(get_char_1_02, true(Assertion)) :-
         ^^set_text_input('qwerty'),
         get_char(_Char),
         ^^text_input_assertion('werty', Assertion).

As you can see in the above example, the testing pattern consists on
setting the input for the predicate being tested, calling it, and then
checking the results.  It is also possible to work with streams other
than the current input/output streams by using the ‘lgtunit’ predicate
variants that take a stream alias as argument.  For example, when
testing the standard ‘get_char/2’ predicate, we could write:

     test(get_char_2_01, true(Char == 'q')) :-
         ^^set_text_input(in, 'qwerty'),
         get_char(in, Char).

     test(get_char_2_02, true(Assertion)) :-
         ^^set_text_input(in, 'qwerty'),
         get_char(in, _Char),
         ^^text_input_assertion(in, 'werty', Assertion).

Testing output predicates follows a similar pattern by using instead the
‘set_text_output/1-2’ and ‘text_output_assertion/2-3’ predicates.  For
example:

     test(put_char_2_02, true(Assertion)) :-
         ^^set_text_output(out, 'qwert'),
         put_char(out, y),
         ^^text_output_assertion(out, 'qwerty', Assertion).

The ‘set_text_output/1’ predicate diverts only the standard output
stream (to a temporary file) using the standard ‘set_output/1’
predicate.  Most backend Prolog systems also support writing to the de
facto standard error stream.  But there’s no standard solution to divert
this stream.  However, several systems provide a ‘set_stream/2’ or
similar predicate that can be used for stream redirection.  For example,
assume that you wanted to test a backend Prolog system warning when an
‘initialization/1’ directive fails that is written to ‘user_error’.  An
hypothetical test could be:

     test(singletons_warning, true(Assertion)) :-
         ^^set_text_output(''),
         current_output(Stream),
         set_stream(Stream, alias(user_error)),
         consult(broken_file),
         ^^text_output_assertion('WARNING: initialization/1 directive failed', Assertion).

For testing binary input/output predicates, equivalent testing
predicates are provided.  There is also a small set of helper predicates
for dealing with stream handles and stream positions.  For testing with
files instead of streams, testing predicates are provided that allow
creating text and binary files with given contents and check text and
binary files for expected contents.

For more practical examples, check the included tests for Prolog
standard conformance of built-in input/output predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Suppressing tested predicates output,  Next: Tests with timeout limits,  Prev: Testing input/output predicates,  Up: lgtunit

5.13.18 Suppressing tested predicates output
--------------------------------------------

Sometimes predicates being tested output text or binary data that, at
best, clutters testing logs and, at worst, can interfere with parsing of
test logs.  If that output itself is not under testing, you can suppress
it by using the goals ‘^^suppress_text_output’ or
‘^^suppress_binary_output’ at the beginning of the tests.  For example:

     test(proxies_04, true(Color == yellow)) :-
         ^^suppress_text_output,
         {circle('#2', Color)}::print.

The ‘suppress_text_output/0’ and ‘suppress_binary_output/0’ predicates
work by redirecting standard output to the operating-system null device.
But the application may also output to e.g.  ‘user_error’ and other
streams.  If this output must also be suppressed, several alternatives
are described next.

Output of expected warnings can be suppressed by turning off the
corresponding linter flags.  In this case, it is advisable to restrict
the scope of the flag value changes as much as possible.

Output of expected compiler errors can be suppressed by defining
suitable clauses for the ‘logtalk::message_hook/4’ hook predicate.  For
example:

     :- multifile(logtalk::message_hook/4).
     :- dynamic(logtalk::message_hook/4).

     % ignore expected domain error
     logtalk::message_hook(compiler_error(_,_,error(domain_error(foo,bar),_)), error, core, _).

In this case, it is advisable to restrict the scope of the clauses as
much as possible to exact exception terms.  For the exact message terms,
see the ‘core_messages’ category source file.  Defining this hook
predicate can also be used to suppress all messages from a given
component.  For example:

     :- multifile(logtalk::message_hook/4).
     :- dynamic(logtalk::message_hook/4).

     logtalk::message_hook(_Message, _Kind, code_metrics, _Tokens).

Note that there’s no portable solution to suppress 'all' output.
However, several systems provide a ‘set_stream/2’ or similar predicate
that can be used for stream redirection.  Check the documentation of the
backend Prolog systems you’re using for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Tests with timeout limits,  Next: Setup and cleanup goals,  Prev: Suppressing tested predicates output,  Up: lgtunit

5.13.19 Tests with timeout limits
---------------------------------

There’s no portable way to call a goal with a timeout limit.  However,
some backend Prolog compilers provide this functionality:

   - B-Prolog: ‘time_out/3’ built-in predicate

   - ECLiPSe: ‘timeout/3’ and ‘timeout/7’ library predicates

   - XVM: ‘call_with_timeout/2-3’ built-in predicates

   - SICStus Prolog: ‘time_out/3’ library predicate

   - SWI-Prolog: ‘call_with_time_limit/2’ library predicate

   - Trealla Prolog: ‘call_with_time_limit/2’ and ‘time_out/3’ library
     predicates

   - XSB: ‘timed_call/2’ built-in predicate

   - YAP: ‘time_out/3’ library predicate

Logtalk provides a ‘timeout’ portability library implementing a simple
abstraction for those backend Prolog compilers.

The ‘logtalk_tester’ automation script accepts a timeout option that can
be used to set a limit per-test set.


File: TheLogtalkHandbook-3.100.1.info,  Node: Setup and cleanup goals,  Next: Test annotations,  Prev: Tests with timeout limits,  Up: lgtunit

5.13.20 Setup and cleanup goals
-------------------------------

A test object can define ‘setup/0’ and ‘cleanup/0’ goals.  The ‘setup/0’
predicate is called, when defined, before running the object unit tests.
The ‘cleanup/0’ predicate is called, when defined, after running all the
object unit tests.  The tests are skipped when the setup goal fails or
throws an error.  For example:

     cleanup :-
         this(This),
         object_property(This, file(_,Directory)),
         atom_concat(Directory, serialized_objects, File),
         catch(ignore(os::delete_file(File)), _, true).

Per test setup and cleanup goals can be defined using the ‘test/3’
dialect and the ‘setup/1’ and ‘cleanup/1’ options.  The test is skipped
when the setup goal fails or throws an error.  Note that a broken test
cleanup goal doesn’t affect the test but may adversely affect any
following tests.  Variables in the setup and cleanup goals are shared
with the test body.


File: TheLogtalkHandbook-3.100.1.info,  Node: Test annotations,  Next: Test execution times and memory usage,  Prev: Setup and cleanup goals,  Up: lgtunit

5.13.21 Test annotations
------------------------

It’s possible to define per-unit and per-test annotations to be printed
after the test results or when tests are skipped.  This is particularly
useful when some units or some unit tests may be run while still being
developed.  Annotations can be used to pass additional information to a
user reviewing test results.  By intercepting the unit test framework
message printing calls (using the ‘message_hook/4’ hook predicate), test
automation scripts and integrating tools can also access these
annotations.

Units can define a global annotation using the predicate ‘note/1’.  To
define per-test annotations, use the ‘test/3’ dialect and the ‘note/1’
option.  For example, you can inform why a test is being skipped by
writing:

     - test(foo_1, true, [note('Waiting for Deep Thought answer')]) :-
         ...

Another common use is to return the execution time of one of the test
sub-goals.  For example:

     test(foobar, true, [note(bar(seconds-Time))]) :-
         foo(...),
         benchmark(bar(...), Time).

Annotations are written, by default, between parentheses after and in
the same line as the test results.


File: TheLogtalkHandbook-3.100.1.info,  Node: Test execution times and memory usage,  Next: Working with test data files,  Prev: Test annotations,  Up: lgtunit

5.13.22 Test execution times and memory usage
---------------------------------------------

Individual test CPU and wall execution times (in seconds) are reported
by default when running the tests.  Total CPU and wall execution times
for passed and failed tests are reported after the tests complete.
Starting and ending date and time when running a set of tests is also
reported by default.  The ‘lgtunit’ object also provides several public
benchmarking predicates that can be useful for e.g.  reporting test
sub-goals execution times using either CPU or wall clocks.  When running
multi-threaded code, the CPU time may or may not include all threads CPU
time depending on the backend.

Be aware that the accuracy of CPU and wall time depends of the backend.
Accuracy can also be different between CPU and wall time (e.g.  CPU time
can have nanosecond accuracy with wall time only having millisecond
accuracy).

Test memory usage is not reported by default due to the lack of a
portable solution to access memory data.  However, several backend
Prolog systems provide a ‘statistics/2’ or similar predicate that can be
used for a custom solution.  Depending on the system, individual keys
may be provided for each memory area (heap, trail, atom table, …).
Aggregating keys may also be provided.  As a hypothetical example,
assume you’re running Logtalk with a backend providing a ‘statistics/2’
predicate with a ‘memory_used’ key:

     test(ack_3, true(Result == 125), [note(memory-Memory)]) :-
         statistics(memory_used, Memory0),
         ack::ack(3, 4, Result),
         statistics(memory_used, Memory1),
         Memory is Memory1 - Memory0.

Consult the documentation of the backend Prolog systems for actual
details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Working with test data files,  Next: Flaky tests,  Prev: Test execution times and memory usage,  Up: lgtunit

5.13.23 Working with test data files
------------------------------------

Frequently, tests make use of test data files that are usually stored in
the test set directory or in sub-directories.  These data files are
referenced using their relative paths.  But to allow the tests to run
independently of the Logtalk process current directory, the relative
paths often must be expanded into an absolute path before being passed
to the predicates being tested.  The ‘file_path/2’ protected predicate
can be used in the test definitions to expand the relative paths.  For
example:

     % check that the encoding/1 option is accepted
     test(lgt_unicode_open_4_01, true) :-
         ^^file_path(sample_utf_8, Path),
         open(Path, write, Stream, [encoding('UTF-8')]),
         close(Stream).

The absolute path is computed relative to the path of 'self', i.e.
relative to the path of the test object that received the message that
runs the tests.

It’s also common for tests to create temporary files and directories
that should be deleted after the tests completion.  The ‘clean_file/1’
and ‘clean_directory/1’ protected predicates can be used for this
purpose.  For example, assuming that the tests create a ‘foo.txt’ text
file and a ‘tmp’ directory in the same directory as the tests object:

     cleanup :-
         ^^clean_file('foo.txt'),
         ^^clean_directory('tmp').

Similar to the ‘file_path/2’ predicate, relative paths are interpreted
as relative to the path of the test object.  This predicate also closes
any open stream connected to the file before deleting it.


File: TheLogtalkHandbook-3.100.1.info,  Node: Flaky tests,  Next: Mocking,  Prev: Working with test data files,  Up: lgtunit

5.13.24 Flaky tests
-------------------

Flaky tests are tests that pass or fail non-deterministically, usually
due to external conditions (e.g., computer or network load).  Thus,
flaky tests often don’t result from bugs in the code being tested itself
but from test execution conditions that are not predictable.  The
‘flaky/0’ test option declares a test to be flaky.  For example:

     test(foo, true, [flaky]) :-
         ...

For backwards compatibility, the ‘note/1’ annotation can also be used to
alert that a test failure is for a flaky test when its argument is an
atom containing the sub-atom ‘flaky’.

The testing automation support outputs the text ‘[flaky]’ when reporting
failed flaky tests.  Moreover, the ‘logtalk_tester’ automation script
will ignore failed flaky tests when setting its exit status.


File: TheLogtalkHandbook-3.100.1.info,  Node: Mocking,  Next: Debugging messages in tests,  Prev: Flaky tests,  Up: lgtunit

5.13.25 Mocking
---------------

Sometimes the code being tested performs complex tasks that are not
feasible or desirable when running tests.  For example, the code may
perform a login operation requiring the user to provide a username and a
password using some GUI widget.  In this case, the tests may require the
login operation to still be performed but using canned data (also
simplifying testing automation).  I.e.  we want to 'mock' (as in
'imitate') the login procedure.  Ideally, this should be accomplished
without requiring any changes to the code being tested.  Logtalk
provides two solutions that can be used for mocking: 'term-expansion'
and 'hot patching'.  A third solution is possible if the code we want to
mock uses the 'message printing mechanism'.

Using the term-expansion mechanism, we would define a 'hook object' that
expands the login predicate into a fact:

     :- object(mock_login,
         implements(expanding)).

         term_expansion((login(_, _) :- _), login(jdoe, test123)).

     :- end_object.

The tests driver file would then load the application object responsible
for user management using this hook object:

     :- initialization((
         ...,
         logtalk_load(mock_login),
         logtalk_load(user_management, [hook(mock_login)]),
         ...
     )).

Using hot patching, we would define a 'complementing category' patching
the object that defines the login predicate:

     :- category(mock_login,
         complements(user_management)).

         login(jdoe, test123).

     :- end_category.

The tests driver file would then set the ‘complements’ flag to ‘allow’
and load the patch after loading application code:

     :- initialization((
         ...,
         set_logtalk_flag(complements, allow),
         logtalk_load(application),
         logtalk_load(mock_login),
         ...
     )).

There are pros and cons for each solution.  Term-expansion works by
defining hook objects that are used at compile-time, while hot patching
happens at runtime.  Complementing categories can also be dynamically
created, stacked, and abolished.  Hot patching disables static binding
optimizations, but that’s usually not a problem as the code being tested
is often compiled in debug mode to collect code coverage data.  Two
advantages of the term-expansion solution are that it allows defining
conditions for expanding terms and goals and can replace both predicate
definitions and predicate calls.  Limitations in the current Prolog
standards prevent patching callers to local predicates being patched.
But often both solutions can be used, with the choice depending on code
clarity and user preference.  See the Handbook sections on
term-expansion and hot patching for more details on these mechanisms.

In those cases where the code we want to mock uses the message printing
mechanism, the solution is to intercept and rewrite the messages being
printed and/or the questions being asked using the
‘logtalk::message_hook/4’ and ‘logtalk::question_hook/6’ hook
predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Debugging messages in tests,  Next: Debugging failed tests,  Prev: Mocking,  Up: lgtunit

5.13.26 Debugging messages in tests
-----------------------------------

Sometimes it is useful to write debugging or logging messages from tests
when running them manually.  But those messages are better suppressed
when running the tests automated.  A common solution is to use debug
'meta-messages'.  For example:

     :- uses(logtalk, [
         print_message(debug, my_app, Message) as dbg(Message)
     ]).

     test(some_test_id, ...) :-
         ...,
         dbg('Some intermediate value'-Value),
         ...,
         dbg([Stream]>>custom_print_goal(Stream, ...)),
         ...

The messages are only printed (and the user-defined printing goals are
only called) when the ‘debug’ flag is turned on.  Note that this doesn’t
require compiling the tests in debug mode: you simply toggle the flag to
toggle the debug messages.  Also note that the ‘print_message/3’ goals
are suppressed by the compiler when compiling with the ‘optimize’ flag
turned on.


File: TheLogtalkHandbook-3.100.1.info,  Node: Debugging failed tests,  Next: Code coverage,  Prev: Debugging messages in tests,  Up: lgtunit

5.13.27 Debugging failed tests
------------------------------

Debugging of failed unit tests is simplified by using test assertions as
the reason for the assertion failures is printed out.  Thus, use
preferably the ‘test/2-3’ dialects with ‘true(Assertion)’,
‘deterministic(Assertion)’, ‘subsumes(Expected, Result)’, or
‘variant(Term1, Term2)’ outcomes.  If a test checks multiple assertions,
you can use the predicate ‘assertion/2’ in the test body.  In the case
of QuickCheck tests, the ‘v(true)’ verbose option can be used to print
the generated test case that failed if necessary.

If the assertion failures don’t provide enough information, you can use
the ‘debugger’ tool to debug failed unit tests.  Start by compiling the
unit test objects and the code being tested in debug mode.  Load the
debugger and trace the test that you want to debug.  For example,
assuming your tests are defined in a ‘tests’ object and that the
identifier of the test to be debugged is ‘test_foo’:

     | ?- logtalk_load(debugger(loader)).
     ...

     | ?- debugger::trace.
     ...

     | ?- tests::run(test_foo).
     ...

You can also compile the code and the tests in debug mode but without
using the ‘hook/1’ compiler option for the tests compilation.  Assuming
that the ‘context_switching_calls’ flag is set to ‘allow’, you can then
use the ‘(<<)/2’ debugging control construct to debug the tests.  For
example, assuming that the identifier of the test to be debugged is
‘test_foo’ and that you used the ‘test/1’ dialect:

     | ?- logtalk_load(debugger(loader)).
     ...

     | ?- debugger::trace.
     ...

     | ?- tests<<test(test_foo).
     ...

In the more complicated cases, it may be worth defining
‘loader_debug.lgt’ and ‘tester_debug.lgt’ driver files that load code
and tests in debug mode and also load the debugger.

When using the ‘logtalk_tester’ automation script, some test sets can be
reported as broken or crashed.  The script creates a logs directory, by
default named ‘logtalk_tester_logs’, in the same directory where the
script was called.  The log files, notably the ‘*.errors’ files, often
contain valuable information for debugging broken and crashed test sets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Code coverage,  Next: Utility predicates,  Prev: Debugging failed tests,  Up: lgtunit

5.13.28 Code coverage
---------------------

If you want entity predicate clause coverage information to be collected
and printed, you will need to compile the entities that you’re testing
using the flags ‘debug(on)’ and ‘source_data(on)’.  Be aware, however,
that compiling in debug mode results in a performance penalty.

A single test object may include tests for one or more entities
(objects, protocols, and categories).  The entities being tested by a
unit test object for which code coverage information should be collected
must be declared using the ‘cover/1’ predicate.  For example, to collect
code coverage data for the objects ‘foo’ and ‘bar’ include in the tests
object the two clauses:

     cover(foo).
     cover(bar).

Code coverage is listed using the predicates clause indexes (counting
from one).  For example, using the ‘points’ example in the Logtalk
distribution:

     % point: default_init_option/1 - 2/2 - (all)
     % point: instance_base_name/1 - 1/1 - (all)
     % point: move/2 - 1/1 - (all)
     % point: position/2 - 1/1 - (all)
     % point: print/0 - 1/1 - (all)
     % point: process_init_option/1 - 1/2 - [1]
     % point: position_/2 - 0/0 - (all)
     % point: 7 out of 8 clauses covered, 87.500000% coverage

The numbers after the predicate indicators represent the clauses covered
and the total number of clauses.  E.g.  for the ‘process_init_option/1’
predicate, the tests cover 1 out of 2 clauses.  After these numbers, we
either get ‘(all)’ telling us that all clauses are covered or a list of
indexes for the covered clauses.  E.g.  only the first clause for the
‘process_init_option/1’ predicate, ‘[1]’.  Summary clause coverage
numbers are also printed for entities and for clauses across all
entities.

In the printed predicate clause coverage information, you may get a
total number of clauses smaller than the covered clauses.  This results
from the use of dynamic predicates with clauses asserted at runtime.
You may easily identify dynamic predicates in the results as their
clauses often have an initial count equal to zero.

The list of indexes of the covered predicate clauses can be quite long.
Some backend Prolog compilers provide a flag or a predicate to control
the depth of printed terms that can be useful:

   - CxProlog: ‘write_depth/2’ predicate

   - ECLiPSe: ‘print_depth’ flag

   - SICStus Prolog: ‘toplevel_print_options’ flag

   - SWI-Prolog 7.1.10 or earlier: ‘toplevel_print_options’ flag

   - SWI-Prolog 7.1.11 or later: ‘answer_write_options’ flag

   - Trealla Prolog: ‘answer_write_options’ flag

   - XSB: ‘set_file_write_depth/1’ predicate

   - XVM 3.2.0 or later: ‘answer_write_options’ flag

   - YAP: ‘write_depth/2-3’ predicates

Code coverage is only available when testing Logtalk code.  But Prolog
modules can often be compiled as Logtalk objects and plain Prolog code
may be wrapped in a Logtalk object.  For example, assuming a ‘module.pl’
module file, we can compile and load the module as an object by simply
calling:

     | ?- logtalk_load(module).
     ...

The module exported predicates become object public predicates.  For a
plain Prolog file, say ‘plain.pl’, we can define a Logtalk object that
wraps the code using an ‘include/1’ directive:

     :- object(plain).

         :- include('plain.pl').

     :- end_object.

The object can also declare as public the top Prolog predicates to
simplify writing the tests.  In alternative, we can use the
‘object_wrapper_hook’ provided by the ‘hook_objects’ library:

     | ?- logtalk_load(hook_objects(loader)).
     ...

     | ?- logtalk_load(plain, [hook(object_wrapper_hook)]).
     ...

These workarounds may thus allow generating code coverage data also for
Prolog code by defining tests that use the ‘(<<)/2’ debugging control
construct to call the Prolog predicates.

See also the section below on exporting code coverage results to XML
files, which can be easily converted and published as e.g.  HTML
reports.


File: TheLogtalkHandbook-3.100.1.info,  Node: Utility predicates,  Next: Exporting test results,  Prev: Code coverage,  Up: lgtunit

5.13.29 Utility predicates
--------------------------

The ‘lgtunit’ tool provides several public utility predicates to
simplify writing unit tests and for general use:

   - 
          ‘variant(Term1, Term2)’
          To check when two terms are a variant of each other (e.g., to check expected test results against actual results when they contain variables).

   - 
          ‘assertion(Goal)’
          To generate an exception in case the goal argument fails or throws an error.

   - 
          ‘assertion(Description, Goal)’
          To generate an exception in case the goal argument fails or throws an error (the first argument allows assertion failures to be distinguished when using multiple assertions).

   - 
          ‘approximately_equal(Number1, Number2)’
          For number approximate equality using the ‘epsilon’ arithmetic constant value.

   - 
          ‘approximately_equal(Number1, Number2, Epsilon)’
          For number approximate equality. Weaker equality than essential equality.

   - 
          ‘essentially_equal(Number1, Number2, Epsilon)’
          For number essential equality. Stronger equality than approximate equality.

   - 
          ‘tolerance_equal(Number1, Number2, RelativeTolerance, AbsoluteTolerance)’
          For number equality within tolerances.

   - 
          ‘Number1 =~= Number2’
          For number (or list of numbers) close equality (usually floating-point numbers).

   - 
          ‘benchmark(Goal, Time)’
          For timing a goal.

   - 
          ‘benchmark_reified(Goal, Time, Result)’
          Reified version of ‘benchmark/2’.

   - 
          ‘benchmark(Goal, Repetitions, Time)’
          For finding the average time to prove a goal.

   - 
          ‘benchmark(Goal, Repetitions, Clock, Time)’
          For finding the average time to prove a goal using a ‘cpu’ or a ‘wall’ clock.

   - 
          ‘deterministic(Goal)’
          For checking that a predicate succeeds without leaving a choice-point.

   - 
          ‘deterministic(Goal, Deterministic)’
          Reified version of the ‘deterministic/1’ predicate.

The ‘assertion/1-2’ predicates can be used in the body of tests where
using two or more assertions is convenient or in the body of tests
written using the ‘test/1’, ‘succeeds/1’, and ‘deterministic/1’ dialects
to help differentiate between the test goal and checking the test goal
results and to provide more informative test failure messages.

When the assertion, benchmarking, and deterministic meta-predicates call
a local predicate of the tests object, you must call them using an
implicit or explicit message instead of using a 'super' call.  For
example, to use an implicit message to call the ‘assertion/1-2’
meta-predicates, add the following directive to the tests object:

     :- uses(lgtunit, [assertion/1, assertion/2]).

The reason this is required is that meta-predicates goals arguments are
always called in the context of the 'sender', which would be the
‘lgtunit’ object in the case of a ‘(^^)/2’ call (as it preserves both
'self' and 'sender' and the tests are internally run by a message sent
from the ‘lgtunit’ object to the tests object).

As the ‘benchmark/2-4’ predicates are meta-predicates, turning on the
‘optimize’ compiler flag is advised to avoid runtime compilation of the
meta-argument, which would add an overhead to the timing results.  But
this advice conflicts with collecting code coverage data, which requires
compilation in debug mode.  The solution is to use separate test objects
for benchmarking and for code coverage.  Note that the CPU and wall
execution times (in seconds) for each individual test are reported by
default when running the tests.

The ‘(=~=)/2’ predicate is typically used by adding the following
directive to the object (or category) calling it:

     :- uses(lgtunit, [
         op(700, xfx, =~=), (=~=)/2
     ]).

Consult the ‘lgtunit’ object API documentation for more details on these
predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting test results,  Next: Generating Allure reports,  Prev: Utility predicates,  Up: lgtunit

5.13.30 Exporting test results
------------------------------

* Menu:

* xUnit XML format::
* TAP output format::
* CTRF JSON format::
* Subunit formats::


File: TheLogtalkHandbook-3.100.1.info,  Node: xUnit XML format,  Next: TAP output format,  Up: Exporting test results

5.13.30.1 xUnit XML format
..........................

To output test results in the xUnit XML format (from JUnit; see e.g.
‘https://github.com/windyroad/JUnit-Schema’ or
‘https://llg.cubic.org/docs/junit/’), simply load the ‘xunit_output.lgt’
file before running the tests.  This file defines an object,
‘xunit_output’, that intercepts and rewrites unit test execution
messages, converting them to the xUnit XML format.

To export the test results to a file using the xUnit XML format, simply
load the ‘xunit_report.lgt’ file before running the tests.  A file named
‘xunit_report.xml’ will be created in the same directory as the object
defining the tests.  When running a set of test suites as a single
unified suite (using the ‘run_test_sets/1’ predicate), the single xUnit
report is created in the directory of the first test suite object in the
set.

To use the xUnit.net v2 XML format
(‘https://xunit.net/docs/format-xml-v2’), load either the
‘xunit_net_v2_output.lgt’ file or the ‘xunit_net_v2_report.lgt’ file.

When using the ‘logtalk_tester’ automation script, use either the ‘-f
xunit’ option or the ‘-f xunit_net_v2’ option to generate the
‘xunit_report.xml’ files in the test set directories.

There are several third-party xUnit report converters that can generate
HTML files for easy browsing.  For example:

   - ‘https://allurereport.org/docs/’ (supports multiple reports)

   - ‘https://github.com/Zir0-93/xunit-to-html’ (supports multiple test
     sets in a single report)

   - ‘https://www.npmjs.com/package/xunit-viewer’

   - ‘https://github.com/JatechUK/NUnit-HTML-Report-Generator’

   - ‘https://plugins.jenkins.io/xunit’


File: TheLogtalkHandbook-3.100.1.info,  Node: TAP output format,  Next: CTRF JSON format,  Prev: xUnit XML format,  Up: Exporting test results

5.13.30.2 TAP output format
...........................

To output test results in the TAP (Test Anything Protocol) format,
simply load the ‘tap_output.lgt’ file before running the tests.  This
file defines an object, ‘tap_output’, that intercepts and rewrites unit
test execution messages, converting them to the TAP output format.

To export the test results to a file using the TAP (Test Anything
Protocol) output format, load instead the ‘tap_report.lgt’ file before
running the tests.  A file named ‘tap_report.txt’ will be created in the
same directory as the object defining the tests.

When using the ‘logtalk_tester’ automation script, use the ‘-f tap’
option to generate the ‘tap_report.xml’ files in the test set
directories.

When using the ‘test/3’ dialect with the TAP format, a ‘note/1’ option
whose argument is an atom starting with a ‘TODO’ or ‘todo’ word results
in a test report with a TAP TODO directive.

When running a set of test suites as a single unified suite, the single
TAP report is created in the directory of the first test suite object in
the set.

There are several third-party TAP report converters that can generate
HTML files for easy browsing.  For example:

   - ‘https://github.com/Quobject/tap-to-html’

   - ‘https://plugins.jenkins.io/tap/’


File: TheLogtalkHandbook-3.100.1.info,  Node: CTRF JSON format,  Next: Subunit formats,  Prev: TAP output format,  Up: Exporting test results

5.13.30.3 CTRF JSON format
..........................

To output test results in the CTRF (Common Test Report Format) JSON
format, simply load the ‘ctrf_output.lgt’ file before running the tests.
This file defines an object, ‘ctrf_output’, that intercepts and rewrites
unit test execution messages, converting them to the CTRF JSON format.

To export the test results to a file using the CTRF JSON format, load
instead the ‘ctrf_report.lgt’ file before running the tests.  A file
named ‘ctrf_report.json’ will be created in the same directory as the
object defining the tests.

When using the ‘logtalk_tester’ automation script, use the ‘-f ctrf’
option to generate the ‘ctrf_report.json’ files in the test set
directories.

When running a set of test suites as a single unified suite, the single
CTRF report is created in the directory of the first test suite object
in the set.


File: TheLogtalkHandbook-3.100.1.info,  Node: Subunit formats,  Prev: CTRF JSON format,  Up: Exporting test results

5.13.30.4 Subunit formats
.........................

To output test results in the Subunit v1 text streaming format, simply
load the ‘subunit_v1_output.lgt’ file before running the tests.  This
file defines an object, ‘subunit_v1_output’, that intercepts and
rewrites unit test execution messages, converting them to a Subunit text
stream.

To output test results in the Subunit v2 binary streaming format, load
the ‘subunit_v2_output.lgt’ file before running the tests.  This file
defines an object, ‘subunit_v2_output’, that intercepts and rewrites
unit test execution messages, converting them to Subunit v2 binary
packets.

These adapters write directly to the current output stream and are
intended for piping test execution output to tools that parse Subunit
streams.

To export test results to files using Subunit streaming formats, load
instead the ‘subunit_v1_report.lgt’ file (Subunit text stream) or the
‘subunit_v2_report.lgt’ file (Subunit v2 binary stream) before running
the tests.  Files named ‘subunit_v1_report.txt’ and
‘subunit_v2_report.bin’ are created in the same directory as the object
defining the tests.


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating Allure reports,  Next: Exporting code coverage results,  Prev: Exporting test results,  Up: lgtunit

5.13.31 Generating Allure reports
---------------------------------

A ‘logtalk_allure_report.pl’ Bash shell script and a
‘logtalk_allure_report.ps1’ PowerShell script are provided for
generating Allure reports(1) (version 2.26.0 or later required).  This
requires exporting test results in xUnit XML format.  A simple usage
example (assuming a current directory containing tests):

     $ logtalk_tester -p gnu -f xunit
     $ logtalk_allure_report
     $ allure open

The ‘allure open’ command accepts ‘--host’ and ‘--port’ arguments in
case their default values are not suitable (e.g., when running Logtalk
in a remote host over a SSH connection).

The ‘logtalk_allure_report’ script supports command-line options to pass
the tests directory (i.e., the directory where the ‘logtalk_tester’
script was run), the directory where to collect all the xUnit report
files for generating the report, the directory where the report is to be
saved, and the report title (see the script man page or type
‘logtalk_allure_report -h’).  The script also supports saving the
history of past test runs.  In this case, a persistent location for both
the results and report directories must be used.

It’s also possible to use the script just to collect the xUnit report
files generated by ‘lgtunit’ and delegate the actual generation of the
report to e.g.  an Allure Docker container or to a Jenkins plug-in.  Two
examples are:

   - ‘https://github.com/fescobar/allure-docker-service’

   - ‘https://plugins.jenkins.io/allure-jenkins-plugin/’

In this case, we would use the ‘logtalk_allure_report’ script option to
only perform the preprocessing step:

     $ logtalk_allure_report -p

The script also supports passing 'environment pairs', which are
displayed in the generated Allure reports in the environment pane.  This
feature can be used to pass e.g.  the backend name and the backend
version or git commit hash.  The option syntax differs, however, between
the two scripts.  For example, using the Bash script:

     $ logtalk_allure_report -- Backend='GNU Prolog' Version=1.5.0

Or:

     $ logtalk_allure_report -- Project='Deep Thought' Commit=`git rev-parse --short HEAD`

In the case of the PowerShell script, the pairs are passed comma
separated inside a string:

     PS> logtalk_allure_report -e "Backend='GNU Prolog',Version=1.5.0"

Or:

     PS> logtalk_allure_report -e "Project='Deep Thought',Commit=bf166b6"

To show test run trends in the report (e.g., when running the tests for
each application source code commit), save the processed test results
and the report data to permanent directories.  For example:

     $ logtalk_allure_report \
       -i "$HOME/my_project/allure-results" \
       -o "$HOME/my_project/allure-report"
     $ allure open "$HOME/my_project/allure-report"

Note that (in Allure 2.x) the single file option is not compatible with
run trends.

The generated reports can include links to the tests source code.  This
requires using the ‘logtalk_tester’ shell script option that allows
passing the base URL for those links.  This option needs to be used
together with the option to suppress the tests directory prefix so that
the links can be constructed by appending the tests file relative path
to the base URL. For example, assuming that you want to generate a
report for the tests included in the Logtalk distribution when using the
GNU Prolog backend:

     $ cd $LOGTALKUSER
     $ logtalk_tester \
       -p gnu \
       -f xunit \
       -s "$LOGTALKUSER" \
       -u "https://github.com/LogtalkDotOrg/logtalk3/tree/3e4ea295986fb09d0d4aade1f3b4968e29ef594e"

The use of a git hash in the base URL ensures that the generated links
will always show the exact versions of the tests that were run.  The
links include the line number for the tests in the test files (assuming
that the git repo is stored in a BitBucket, GitHub, or GitLab server).
But note that not all supported backends provide accurate line numbers.

It’s also possible to generate single-file reports.  For example:

     $ logtalk_allure_report -s -t "My Amazing Tests Report"

There are some caveats when generating Allure reports that users must be
aware of.  First, Allure expects test names to be unique across
different tests sets.  If there are two tests with the same name in two
different test sets, only one of them will be reported.  Second, when
using the ‘xunit’ format, dates are reported as MM/DD/YYYY. Finally,
when using the ‘xunit_net_v2’ format, tests are reported in a random
order instead of their run order, and dates are displayed as “unknown”
in the overview page.

   ---------- Footnotes ----------

   (1) https://allurereport.org/docs/


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting code coverage results,  Next: Automatically creating bug reports at issue trackers,  Prev: Generating Allure reports,  Up: lgtunit

5.13.32 Exporting code coverage results
---------------------------------------

The ‘lgtunit’ tool can export code coverage stats in three formats by
loading the corresponding report object before running tests:

   - ‘coverage_report.lgt’ for a simple XML report
     (‘coverage_report.xml’)

   - ‘cobertura_report.lgt’ for a Cobertura XML report (‘cobertura.xml’)

   - ‘lcov_report.lgt’ for an LCOV report (‘lcov.info’)

When using the ‘logtalk_tester’ automation scripts, select the report
format using the ‘-c’ option with one of the values ‘xml’, ‘cobertura’,
or ‘lcov’ (or ‘none’ to disable code coverage reports).

* Menu:

* Simple XML format::
* Cobertura XML format::
* LCOV format::


File: TheLogtalkHandbook-3.100.1.info,  Node: Simple XML format,  Next: Cobertura XML format,  Up: Exporting code coverage results

5.13.32.1 Simple XML format
...........................

To export code coverage results in simple XML format, load the
‘coverage_report.lgt’ file before running the tests.  A file named
‘coverage_report.xml’ will be created in the same directory as the
object defining the tests.

The XML file can be opened in most web browsers (with the notorious
exception of Google Chrome) by copying to the same directory the
‘coverage_report.dtd’ and ‘coverage_report.xsl’ files found in the
‘tools/lgtunit’ directory (when using the ‘logtalk_tester’ script, these
two files are copied automatically).  In alternative, an XSLT processor
can be used to generate an XHTML file instead of relying on a web
browser for the transformation.  For example, using the popular
‘xsltproc’ processor:

     $ xsltproc -o coverage_report.html coverage_report.xml

On Windows operating-systems, this processor can be installed using e.g.
Chocolatey.  On a POSIX operating-systems (e.g., Linux, macOS, …) use
the system package manager to install it if necessary.

The coverage report can include links to the source code when hosted on
Bitbucket, GitHub, or GitLab.  This requires passing the base URL as the
value for the ‘url’ XSLT parameter.  The exact syntax depends on the
XSLT processor, however.  For example:

     $ xsltproc \
       --stringparam url https://github.com/LogtalkDotOrg/logtalk3/blob/master \
       -o coverage_report.html coverage_report.xml

Note that the base URL should preferably be a permanent link (i.e., it
should include the commit SHA1) so that the links to source code files
and lines remain valid if the source code is later updated.  It’s also
necessary to suppress the local path prefix in the generated
‘coverage_report.xml’ file.  For example:

     $ logtalk_tester -c xml -s $HOME/logtalk/

Alternatively, you can pass the local path prefix to be suppressed to
the XSLT processor (note that the ‘logtalk_tester’ script suppresses the
‘$HOME’ prefix by default):

     $ xsltproc \
       --stringparam prefix logtalk/ \
       --stringparam url https://github.com/LogtalkDotOrg/logtalk3/blob/master \
       -o coverage_report.html coverage_report.xml

If you are using Bitbucket, GitHub, or GitLab hosted on your own
servers, the ‘url’ parameter may not contain a ‘bitbucket’, ‘github’, or
‘gitlab’ string.  In this case, you can use the XSLT parameter ‘host’ to
indicate which service you are running.


File: TheLogtalkHandbook-3.100.1.info,  Node: Cobertura XML format,  Next: LCOV format,  Prev: Simple XML format,  Up: Exporting code coverage results

5.13.32.2 Cobertura XML format
..............................

To export code coverage results in Cobertura XML format, load the
‘cobertura_report.lgt’ file before running the tests.  A file named
‘cobertura.xml’ will be created in the same directory as the object
defining the tests.

When using the ‘logtalk_tester’ automation scripts, use the option:

     $ logtalk_tester -c cobertura


File: TheLogtalkHandbook-3.100.1.info,  Node: LCOV format,  Prev: Cobertura XML format,  Up: Exporting code coverage results

5.13.32.3 LCOV format
.....................

To export code coverage results in LCOV format, load the
‘lcov_report.lgt’ file before running the tests.  A file named
‘lcov.info’ will be created in the same directory as the object defining
the tests.

When using the ‘logtalk_tester’ automation scripts, use the option:

     $ logtalk_tester -c lcov


File: TheLogtalkHandbook-3.100.1.info,  Node: Automatically creating bug reports at issue trackers,  Next: Minimizing test results output,  Prev: Exporting code coverage results,  Up: lgtunit

5.13.33 Automatically creating bug reports at issue trackers
------------------------------------------------------------

To automatically create bug report issues for failed tests in GitHub or
GitLab servers, see the ‘issue_creator’ tool.


File: TheLogtalkHandbook-3.100.1.info,  Node: Minimizing test results output,  Next: Help with warnings,  Prev: Automatically creating bug reports at issue trackers,  Up: lgtunit

5.13.34 Minimizing test results output
--------------------------------------

To minimize the test results output, simply load the
‘minimal_output.lgt’ file before running the tests.  This file defines
an object, ‘minimal_output’, that intercepts and summarizes the unit
test execution messages.


File: TheLogtalkHandbook-3.100.1.info,  Node: Help with warnings,  Next: Known issues<5>,  Prev: Minimizing test results output,  Up: lgtunit

5.13.35 Help with warnings
--------------------------

Load the ‘tutor’ tool to get help with selected warnings printed by the
‘lgtunit’ tool.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<5>,  Prev: Help with warnings,  Up: lgtunit

5.13.36 Known issues
--------------------

Deterministic unit tests are currently not available when using Quintus
Prolog as it lacks built-in support that cannot be sensibly defined in
Prolog.

Parameter variables (‘_VariableName_’) cannot currently be used in the
definition of the ‘condition/1’, ‘setup/1’, and ‘cleanup/1’ test options
when using the ‘test/3’ dialect.  For example, the following condition
will not work:

     test(some_id, true, [condition(_ParVar_ == 42)]) :-
         ...

The workaround is to define an auxiliary predicate called from those
options.  For example:

     test(check_xyz, true, [condition(xyz_condition)]) :-
         ...

     xyz_condition :-
         _ParVar_ == 42.


File: TheLogtalkHandbook-3.100.1.info,  Node: linter,  Next: linter_reporter,  Prev: lgtunit,  Up: Developer Tools

5.14 ‘linter’
=============

Logtalk provides a built-in linter tool that runs automatically when
compiling and loading source files.  The lint warnings are controlled by
a set of flags(1).  The default values for these flags are defined in
the backend Prolog compiler adapter files and can be overridden from a
settings file, from a source file (e.g., a loader file), or from an
entity.  These flags can be set globally using the set_logtalk_flag/2(2)
built-in predicate.  For (source file or entity) local scope, use
instead the set_logtalk_flag/2(3) directive.

The linter flags can be managed as a group using the linter(4)
meta-flag.  See the documentation for details.

Some lint checks are turned off by default, specially when
computationally expensive.  Still, it’s a good idea to turn them on to
check your code on a regular basis (e.g., in CI/CD pipelines).

Note that, in some cases, the linter may generate false warnings due to
source code analysis limitations or special cases that, while valid when
intended, usually result from programming issues.  When a code rewrite
is not a sensible solution to avoid the warning, the workaround is to
turn off as locally as possible the flag that controls the warning.

* Menu:

* Main linter checks::
* Help on linter warnings::
* Extending the linter::
* Linting Prolog modules::
* Linting plain Prolog files::

   ---------- Footnotes ----------

   (1) ../userman/programming.html#programming-flags-lint

   (2) ../refman/predicates/set_logtalk_flag_2.html

   (3) ../refman/directives/set_logtalk_flag_2.html

   (4) ../userman/programming.html#flag-linter


File: TheLogtalkHandbook-3.100.1.info,  Node: Main linter checks,  Next: Help on linter warnings,  Up: linter

5.14.1 Main linter checks
-------------------------

Lint checks include:

   - Missing directives (including scope, meta-predicate, dynamic,
     discontiguous, and multifile directives)

   - Duplicated directives, clauses, and grammar rules

   - Missing predicates (unknown messages plus calls to non-declared and
     non-defined predicates)

   - Calls to declared but not defined static predicates

   - Non-terminals called as predicates (instead of via the ‘phrase/2-3’
     built-in methods)

   - Predicates called as non-terminals (instead of via the ‘call//1’
     built-in method)

   - Non-portable predicate calls, predicate options, arithmetic
     function calls, directives, flags, and flag values

   - Missing arithmetic functions (with selected backends)

   - Suspicious calls (syntactically valid calls that are likely
     semantic errors; e.g.  float comparisons using the standard
     arithmetic comparison operators or comparing numbers using
     unification)

   - Deprecated directives, predicates, arithmetic functions, control
     constructs, and flags

   - References to unknown entities (objects, protocols, categories, or
     modules)

   - Top-level shortcuts used as directives

   - Unification goals that will succeed without binding any variables

   - Unification goals that will succeed by creating a cyclic term

   - Goals that are always true or always false

   - Trivial goal failures (due to no matching predicate clause)

   - Redefined built-in predicates

   - Redefined standard operators

   - Lambda expression unclassified variables and mixed up variables

   - Lambda expression with parameter variables used elsewhere in a
     clause

   - Singleton variables

   - If-then-else and soft cut control constructs without an else part

   - If-then-else and soft cut control constructs where the test is a
     unification between a variable and a ground term

   - Missing parentheses around if-then-else and disjunction control
     constructs in the presence of cuts in the first argument

   - Cuts in clauses for multifile predicates

   - Missing cut in repeat loops

   - Possible non-steadfast predicate definitions

   - Non-tail recursive predicate definitions

   - Redundant calls to control constructs and built-in predicates

   - Calls to all-solutions predicates with existentially qualified
     variables not occurring in the qualified goal

   - Calls to all-solutions predicates with no shared variables between
     template and goal

   - Calls to ‘bagof/3’ and ‘setof/3’ where the goal argument contains
     singleton variables

   - Calls to ‘findall/3’ used to backtrack over all solutions of a goal
     without collecting them

   - Calls to ‘catch/3’ that catch all exceptions

   - Calls to standard predicates that have more efficient alternatives

   - Unsound calls in grammar rules

   - File, entity, predicate, and variable names not following official
     coding guidelines

   - Variable names that differ only on case

   - Clauses whose body is a disjunction (and that can be rewritten as
     multiple clauses per coding guidelines)

   - Naked meta-variables in cut-transparent control constructs

   - Left-recursion in clauses and grammar rules

Additional lint checks are provided by the ‘lgtunit’, ‘lgtdoc’, ‘make’,
and ‘dead_code_scanner’ tools.  For large projects, the data generated
by the ‘code_metrics’ tool may also be relevant in accessing code
quality and suggesting code refactoring candidates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Help on linter warnings,  Next: Extending the linter,  Prev: Main linter checks,  Up: linter

5.14.2 Help on linter warnings
------------------------------

By loading the ‘tutor’ tool, most lint warnings are expanded with
explanations and suggestions on how to fix the reported issues.  See
also the coding guidelines(1) for additional explanations.

   ---------- Footnotes ----------

   (1) https://logtalk.org/coding_style_guidelines.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Extending the linter,  Next: Linting Prolog modules,  Prev: Help on linter warnings,  Up: linter

5.14.3 Extending the linter
---------------------------

Experimental support for extending the linter with user-defined warnings
is available using the logtalk_linter_hook/7(1) multifile hook
predicate.  For example, the ‘format’ and ‘list’ library objects define
this hook predicate to lint calls to the ‘format/2-3’ and ‘append/3’
predicates for common errors and misuses.

   ---------- Footnotes ----------

   (1) ../refman/predicates/logtalk_linter_hook_7.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Linting Prolog modules,  Next: Linting plain Prolog files,  Prev: Extending the linter,  Up: linter

5.14.4 Linting Prolog modules
-----------------------------

This tool can also be applied to Prolog modules that Logtalk is able to
compile as objects.  For example, if the Prolog module file is named
‘module.pl’, try:

     | ?- logtalk_load(module, [source_data(on)]).

Due to the lack of standardization of module systems and the abundance
of proprietary extensions, this solution is not expected to work for all
cases.


File: TheLogtalkHandbook-3.100.1.info,  Node: Linting plain Prolog files,  Prev: Linting Prolog modules,  Up: linter

5.14.5 Linting plain Prolog files
---------------------------------

This tool can also be applied to plain Prolog code.  For example, if the
Prolog file is named ‘code.pl’, simply define an object including its
code:

     :- object(code).
         :- include('code.pl').
     :- end_object.

Save the object to an e.g.  ‘code.lgt’ file in the same directory as the
Prolog file and then load it:

     | ?- logtalk_load(code, [source_data(on)]).

In alternative, use the ‘object_wrapper_hook’ provided by the
‘hook_objects’ library:

     | ?- logtalk_load(hook_objects(loader)).
     ...

     | ?- logtalk_load(code, [hook(object_wrapper_hook), source_data(on)]).

With either wrapping solution, pay special attention to any compilation
warnings that may signal issues that could prevent the plain Prolog from
being fully checked when wrapped by an object.


File: TheLogtalkHandbook-3.100.1.info,  Node: linter_reporter,  Next: make,  Prev: linter,  Up: Developer Tools

5.15 ‘linter_reporter’
======================

This tool intercepts compiler linter warnings and caches them as
machine-readable diagnostics.  These diagnostics can be queried directly
or serialized as SARIF using the standalone ‘sarif’ tool.

* Menu:

* API documentation: API documentation<11>.
* Loading: Loading<12>.
* Testing: Testing<10>.
* Usage: Usage<7>.
* Options::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<11>,  Next: Loading<12>,  Up: linter_reporter

5.15.1 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#linter_reporter’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<12>,  Next: Testing<10>,  Prev: API documentation<11>,  Up: linter_reporter

5.15.2 Loading
--------------

Load the tool before loading the code to be checked:

     | ?- logtalk_load(linter_reporter(loader)).
     ...

Enable collecting linter warnings data using default options:

     | ?- linter_reporter::enable.
     true.

Or using explicit options:

     | ?- linter_reporter::enable([explanations(true)]).
     true.

Load the code for which you want diagnostics collected:

     | ?- logtalk_load(my_application(loader)).
     ...

Disable further collecting of linter warnings:

     | ?- linter_reporter::disable.
     true.

Query the cached diagnostics directly:

     | ?- linter_reporter::diagnostics(all, Diagnostics).
     ...

Warnings originating in an included file are not always file-scoped.
When the ‘include/1’ directive appears inside an entity, the diagnostic
context can be that entity; otherwise the context is typically the
included file.

Or generate a SARIF report using the standalone ‘sarif’ tool:

     | ?- logtalk_load(sarif(loader)).
     ...

     | ?- sarif::generate(linter_reporter, all, file('./linter_warnings.sarif'), []).
     true.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<10>,  Next: Usage<7>,  Prev: Loading<12>,  Up: linter_reporter

5.15.3 Testing
--------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(linter_reporter(tester)).

The test suite reuses ‘errors’ example files to exercise representative
built-in linter warnings and validates both the diagnostics API and
standalone SARIF generation in explanation-disabled and
explanation-enabled configurations.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<7>,  Next: Options,  Prev: Testing<10>,  Up: linter_reporter

5.15.4 Usage
------------

Load the tool, call ‘enable/0-1’ before compiling the code to be
checked, call ‘disable/0’ when warning collection is finished, and then
query the cached warnings using either the legacy warning predicates or
the diagnostics protocol predicates.  To generate SARIF from the cached
diagnostics, load the standalone ‘sarif’ tool and call
‘sarif::generate(linter_reporter, all, file('./linter_warnings.sarif'),
[]).’


File: TheLogtalkHandbook-3.100.1.info,  Node: Options,  Prev: Usage<7>,  Up: linter_reporter

5.15.5 Options
--------------

   - ‘explanations(Boolean)’ Boolean option accepted by ‘enable/1’.
     When set to ‘true’ (default is ‘false’), the tool enriches warnings
     with explanations from the ‘tutor_explanations’ category provided
     by the ‘tutor’ tool.


File: TheLogtalkHandbook-3.100.1.info,  Node: make,  Next: mutation_testing,  Prev: linter_reporter,  Up: Developer Tools

5.16 ‘make’
===========

Logtalk provides a make tool supporting several targets using the
‘logtalk_make/0-1’ built-in predicates.  Top-level shortcuts for the
targets are also provided.

* Menu:

* API documentation: API documentation<12>.
* Help with warnings: Help with warnings<2>.
* Known issues: Known issues<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<12>,  Next: Help with warnings<2>,  Up: make

5.16.1 API documentation
------------------------

To consult the documentation of the ‘logtalk_make/0-1’ built-in
predicates, open in a web browser the links:

   - ‘../refman/predicates/logtalk_make_0.html’

   - ‘../refman/predicates/logtalk_make_1.html’

There is also a user-defined hook predicate that supports defining
additional actions for the make targets (e.g., running tests
automatically on make check or regenerating API documentation on make
documentation):

   - ‘../refman/predicates/logtalk_make_target_action_1.html’


File: TheLogtalkHandbook-3.100.1.info,  Node: Help with warnings<2>,  Next: Known issues<6>,  Prev: API documentation<12>,  Up: make

5.16.2 Help with warnings
-------------------------

Load the ‘tutor’ tool to get help with selected warnings printed by the
‘make’ tool.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<6>,  Prev: Help with warnings<2>,  Up: make

5.16.3 Known issues
-------------------

The implementation of the ‘logtalk_make/0-1’ predicates for the target
‘all’ tries to avoid or minimize compilation warnings due to
out-of-order loading of modified source files by performing a file
topological sort based on the dependencies in the previous versions of
the files.  But it’s always possible that the new versions of the files
bring changes to those dependencies and thus result in compilation
warnings that could possibly be avoided with a different loading order.


File: TheLogtalkHandbook-3.100.1.info,  Node: mutation_testing,  Next: packs,  Prev: make,  Up: Developer Tools

5.17 ‘mutation_testing’
=======================

This tool provides mutation testing support for loaded Logtalk entities.
It’s still under development and breaking changes should be expected.

* Menu:

* API documentation: API documentation<13>.
* Loading: Loading<13>.
* Testing: Testing<11>.
* Features::
* Default mutators::
* Usage: Usage<8>.
* Limitations::
* Options: Options<2>.
* Sampling semantics::
* Defining new mutators::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<13>,  Next: Loading<13>,  Up: mutation_testing

5.17.1 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#mutation-testing’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<13>,  Next: Testing<11>,  Prev: API documentation<13>,  Up: mutation_testing

5.17.2 Loading
--------------

This tool can be loaded using the query:

     | ?- logtalk_load(mutation_testing(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<11>,  Next: Features,  Prev: Loading<13>,  Up: mutation_testing

5.17.3 Testing
--------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(mutation_testing(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features,  Next: Default mutators,  Prev: Testing<11>,  Up: mutation_testing

5.17.4 Features
---------------

   - Deterministic mutant discovery per entity predicate directive,
     predicate/non-terminal clause/rule, and mutator.

   - Configurable mutator sets and campaign size limits.

   - Deterministic sampled execution (‘sampling(all|count(N)|rate(R))’
     plus ‘seed/1’).

   - Mutation score computation (killed versus survived mutants).

   - Mutation generation guided by code coverage stats.

   - Threshold gating suitable for CI/CD checks.

   - Exporting of mutation campaign reports in plain text and JSON
     formats.


File: TheLogtalkHandbook-3.100.1.info,  Node: Default mutators,  Next: Usage<8>,  Prev: Features,  Up: mutation_testing

5.17.5 Default mutators
-----------------------

The default mutators are:

   - 
          ‘fail_insertion’
          Inserts failure in the selected predicate/non-terminal rule bodies.

   - 
          ‘body_goal_negation’
          Negates the selected predicate/non-terminal clause behavior.

   - 
          ‘relational_operator_replacement’
          Replaces a relational operator (e.g. ‘>’, ‘<’, ‘@=<’, ‘==’) with a complementary alternative.

   - 
          ‘arithmetic_operator_replacement’
          Replaces an arithmetic operator in selected expressions.

   - 
          ‘truth_literal_flip’
          Flips truth literals (‘true’ <-> ‘fail’) in selected goals.

   - 
          ‘head_arguments_mutation’
          Mutates one compile-time bound head argument using ‘type::mutation/3’.

   - 
          ‘head_arguments_reordering’
          Reorders head arguments (swapping the first two arguments).

   - 
          ‘clauses_reordering’
          Reorders predicate/non-terminal clauses/rules by swapping a clause with its successor.

   - 
          ‘scope_directive_replacement’
          Replaces a matching predicate/non-terminal scope directive visibility with an alternative visibility.

   - 
          ‘predicate_directive_suppression’
          Suppresses a matching predicate/non-terminal directive.

   - 
          ‘uses_directive_resource_deletion’
          Deletes one matching resource from a ‘uses/2’ directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<8>,  Next: Limitations,  Prev: Default mutators,  Up: mutation_testing

5.17.6 Usage
------------

Mutation testing 'requires' an existing set of tests for the code being
mutated.  These tests are used to verify if they are able to kill the
generated mutants or if they are too weak allowing the mutants to
survive.

By default, the tool looks for the tests driver file (usually,
‘tester.lgt’) in the directory of the entity, library, or directory
being tested.  If the tests driver file is not found there, the tool
looks into the startup directory of the Logtalk process.

Both the name of the tests driver file and its directory can be set
using the ‘tester_file_name/1’ and ‘tester_directory/1’ options if the
defaults don’t work in your particular case.

In this tool documentation, 'campaign predicates' refers to the
following public predicates:

   - ‘entity/1-2’

   - ‘predicate/2-3’

   - ‘library/1-2’

   - ‘directory/1-2’

These predicates run mutants and report results in one step.

Run mutation testing for one entity using defaults:

     | ?- mutation_testing::entity(my_object).

List generated mutants for one entity:

     | ?- mutation_testing::entity_mutants(my_object, Mutants).

Run with custom options:

     | ?- mutation_testing::entity(my_object, [
         mutators([fail_insertion, body_goal_negation]),
         max_mutations_per_mutator(5),
         sampling(count(100)),
         seed(20260303),
         max_mutators(100),
         threshold(60.0),
         verbose(true),
         print_mutation(true)
     ]).

Run campaigns for all loaded entities from a specific library:

     | ?- mutation_testing::library(core).

Run campaigns for all loaded entities from a specific directory:

     | ?- mutation_testing::directory('/path/to/sources').

Pretty-print a report term using the default text format:

     | ?- mutation_testing::report_entity(my_object, Report, []),
          mutation_testing::format_report(Report).

Suppress report formatting output for campaign predicates:

     | ?- mutation_testing::entity(my_object, [format(none)]).

Execution uses ‘lgtunit’ test sets only.  When using ‘timeout(Timeout)’,
timeout handling is best-effort.

When running mutation campaigns inside another ‘lgtunit’ test run,
per-mutant ‘killed’ versus ‘survived’ classification may be affected by
nested test-run message and event handling.  Campaign summary accounting
remains deterministic.


File: TheLogtalkHandbook-3.100.1.info,  Node: Limitations,  Next: Options<2>,  Prev: Usage<8>,  Up: mutation_testing

5.17.7 Limitations
------------------

   - Mutation points are currently mostly clause-level (one occurrence
     per clause per mutator), except ‘head_arguments_mutation’ which
     creates one occurrence per compile-time bound head argument with
     supported type; internal expression-level candidate enumeration is
     not implemented.

   - Equivalent mutant detection and duplicate mutant pruning are not
     implemented.

   - Built-in mutation apply/revert currently targets loaded source
     entities (objects/categories), not protocols.

   - Nested ‘lgtunit’ runs may affect per-mutant ‘killed’ vs ‘survived’
     status classification.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<2>,  Next: Sampling semantics,  Prev: Limitations,  Up: mutation_testing

5.17.8 Options
--------------

   - 
          ‘include_entities(Entities)’
          List of loaded entities to include (default ‘[]’ meaning all).

   - 
          ‘exclude_entities(Entities)’
          List of loaded entities to exclude (default ‘[]’).

   - 
          ‘max_mutators(Max)’
          Maximum number of discovered mutators to use when ‘mutators/1’ is not explicitly provided (‘all’ or positive integer; default ‘all’).

   - 
          ‘max_mutations_per_mutator(Max)’
          Maximum number of mutations generated per mutator and predicate/non-terminal (‘all’ or positive integer; default ‘5’).

   - 
          ‘mutators(Mutators)’
          Names of the mutators to use. When set to ‘[]’ (default), mutators are auto-discovered and optionally limited by ‘max_mutators/1’.

   - 
          ‘sampling(Sampling)’
          Mutant selection strategy (‘all’, ‘count(N)’, or ‘rate(R)’ where ‘0.0 =< R =< 1.0’; default ‘all’). See below for full details.

   - 
          ‘seed(Seed)’
          Pseudo-random generator seed for reproducible sampling (default ‘123456789’; ignored when ‘sampling(all)’).

   - 
          ‘timeout(Timeout)’
          Maximum time in seconds for each mutant execution (positive number; default ‘300’). Timeout handling is best-effort.

   - 
          ‘threshold(Threshold)’
          Minimum mutation score in range ‘0.0..100.0’ (default ‘0.0’).

   - 
          ‘verbose(Boolean)’
          Print per-mutant results (default ‘false’).

   - ‘format(Format)’ Controls report formatting output (‘none’, ‘text’,
     or ‘json’; default ‘text’).  When set to ‘text’ or ‘json’, a report
     file is generated automatically for campaign predicates.  The
     ‘json’ format implements the Stryker Mutation Testing Framework
     report format: ‘https://stryker-mutator.io/’

   - ‘report_file_name(FileName)’ Report output file base name or path
     without extension (atom; default ‘mutation_test_report’).  The
     extension is inferred from ‘format/1’ (‘text’ -> ‘.txt’, ‘json’ ->
     ‘.json’).  When not absolute, the file is saved in the tests driver
     directory.

   - 
          ‘print_mutation(Boolean)’
          When ‘true’, prints original and mutated terms with source location for mutators. This option is only effective when ‘verbose(true)’ (default ‘false’).

   - 
          ‘tester_file_name(Tester)’
          Name of the tests driver file for the code being tested (default ‘tester.lgt’).

   - 
          ‘tester_directory(Directory)’
          Full path to the directory containing the tests driver file for the code being tested (no default).


File: TheLogtalkHandbook-3.100.1.info,  Node: Sampling semantics,  Next: Defining new mutators,  Prev: Options<2>,  Up: mutation_testing

5.17.9 Sampling semantics
-------------------------

The ‘sampling(Sampling)’ option controls 'which generated mutants are
actually executed' in a mutation campaign.  It is a post-generation
selection step:

  1. Generate candidate mutants for the selected
     entities/predicates/mutators.

  2. Apply ‘sampling(...)’ to select a subset (or all).

  3. Execute only the selected mutants.

Because of this design, ‘sampling(...)’ affects campaign predicates
(‘entity/2’, ‘predicate/3’, ‘library/2’, ‘directory/2’).

The ‘format(Format)’ option affects only campaign predicates that
execute and report in one step (‘entity/2’, ‘predicate/3’, ‘library/2’,
‘directory/2’).  It does not affect the ‘*_mutants’ predicates or the
‘report_*’ predicates, which only compute and return terms.

For campaign predicates, a report file is written automatically unless
‘format(none)’ is used.

For ‘report_library/3’ and ‘report_directory/3’, call
‘format_report/2-3’ explicitly if you want to persist the computed
report term.  A single ‘format_report(..., Report)’ call always
generates a single output document (including JSON).

The ‘mutants/2-3’ predicates are still useful for inspecting the
generated deterministic mutant list itself; they are not
execution/reporting predicates.

* Menu:

* Sampling modes::
* Sampling usage in practice::


File: TheLogtalkHandbook-3.100.1.info,  Node: Sampling modes,  Next: Sampling usage in practice,  Up: Sampling semantics

5.17.9.1 Sampling modes
.......................

   - ‘sampling(all)’ Execute all generated mutants.

   - ‘sampling(count(N))’ Shuffle the generated mutant list and execute
     up to ‘N’ mutants.  If ‘N’ is greater than the total number of
     generated mutants, all mutants are executed.

   - ‘sampling(rate(R))’ Compute ‘round(R * TotalGeneratedMutants)’,
     shuffle the mutant list, and execute that many mutants.  If the
     computed value is greater than the total number of generated
     mutants, all mutants are executed.

The randomization used by ‘count/1’ and ‘rate/1’ is controlled by the
‘seed/1’ option, allowing reproducible selection.


File: TheLogtalkHandbook-3.100.1.info,  Node: Sampling usage in practice,  Prev: Sampling modes,  Up: Sampling semantics

5.17.9.2 Sampling usage in practice
...................................

   - 'Control campaign cost' Run a representative subset when the full
     mutant set is large.

   - 'Trade off speed vs.  confidence' Use smaller samples for quick
     feedback and larger/full runs for stronger confidence before
     release.

   - 'Enable reproducible sampling' With a fixed ‘seed/1’, repeated runs
     with the same generated mutant set and same sampling options select
     the same subset.  When all mutants are executed, (using
     ‘sampling(all)’) changing the seed has no effect on selection.

   - 'Complement other limits' ‘max_mutators/1’ and
     ‘max_mutations_per_mutator/1’ constrain mutant generation;
     ‘sampling/1’ controls execution selection after generation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining new mutators,  Prev: Sampling semantics,  Up: mutation_testing

5.17.10 Defining new mutators
-----------------------------

Define a new mutator as parametric object implementing the ‘expanding’
protocol, either the ‘clause_mutator_protocol’ or the
‘directive_mutator_protocol’ marker protocol, and importing the
‘mutator_common’ category:

     :- object(my_mutator(_Entity_, _Predicate_, _TargetIndex_, _Occurrence_, _PrintMutation_),
         implements((expanding, clause_mutator_protocol)),
         imports(mutator_common)).

         % mutate code when loading it using this object as a hook object
         term_expansion(Term, Mutation) :-
             ...

         % compute a term mutation; generate multiple mutations by backtracking
         mutation(Term, Mutation) :-
             ...

         % reset any required internal state
         reset :-
             ...

     :- end_object.

New mutators are found by dynamically looking for objects that conform
to either the ‘clause_mutator_protocol’ or the
‘directive_mutator_protocol’ marker protocols.

For implementation examples, see the default mutators:

   - ‘mutators/fail_insertion.lgt’

   - ‘mutators/body_goal_negation.lgt’

   - ‘mutators/relational_operator_replacement.lgt’

   - ‘mutators/arithmetic_operator_replacement.lgt’

   - ‘mutators/truth_literal_flip.lgt’

   - ‘mutators/head_arguments_mutation.lgt’

   - ‘mutators/head_arguments_reordering.lgt’

   - ‘mutators/clauses_reordering.lgt’

   - ‘mutators/scope_directive_replacement.lgt’


File: TheLogtalkHandbook-3.100.1.info,  Node: packs,  Next: ports_profiler,  Prev: mutation_testing,  Up: Developer Tools

5.18 ‘packs’
============

This tool provides predicates for downloading, installing, upgrading,
and uninstalling third-party libraries and applications, generically
known as 'packs'.  Collections of pack specifications are made available
using 'registries'.  Registries can be local to a system, publicly
shared, or private to a company (e.g., only available in a VPN). There
is no concept of a central registry.  Users can decide which registries
they trust and want to use and add them using their published URLs.  The
tool supports both pack checksums and signatures and takes several steps
to sanitize registry and pack specifications.  As with other Logtalk
developer tools, portability is a main goal.  This tool can be used with
any supported Prolog backend and run on both POSIX and Windows systems.
Moreover, this tool can be used not only for handling Logtalk packs but
also for Prolog only packs, thus providing a solution for sharing
portable resources between multiple systems.

A list of public Logtalk and Prolog pack registries is available at:

‘https://github.com/LogtalkDotOrg/pack-registries’

This tool is in the beta stage of development.  Feedback is most
welcome.

* Menu:

* Requirements: Requirements<5>.
* API documentation: API documentation<14>.
* Loading: Loading<14>.
* Testing: Testing<12>.
* Usage: Usage<9>.
* Programmatic query API::
* Registries and packs storage::
* Virtual environments::
* Lock files::
* Registry specification::
* Registry handling::
* Registry development::
* Pack specification::
* Encrypted packs::
* Signed packs::
* Pack URLs and Single Sign-On::
* Multiple pack versions::
* Pack dependencies::
* Pack portability::
* Pack development::
* Pack handling::
* Pack documentation::
* Pinning registries and packs::
* Testing packs::
* Security considerations::
* Best practices::
* Installing Prolog packs::
* Help with warnings: Help with warnings<3>.
* Known issues: Known issues<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Requirements<5>,  Next: API documentation<14>,  Up: packs

5.18.1 Requirements
-------------------

On POSIX systems (Linux, macOS, …), the following shell commands are
required:

   - ‘sha256sum’ (provided by GNU ‘coreutils’)

   - ‘curl’ (default file downloader)

   - ‘wget’ (alternative file downloader)

   - ‘bsdtar’ (provided by ‘libarchive’ or ‘libarchive-tools’)

   - ‘gpg’ (provided by ‘gnupg2’)

   - ‘git’

   - ‘direnv’ (when using virtual environments)

The tool uses ‘bsdtar’ instead of GNU ‘tar’ so that it can uncompress
‘.zip’ archives (‘unzip’ doesn’t provide the desired options that allow
a simple and reliable solution for ignoring the non-predictable name of
the wrapper directory).

On Windows systems, the following shell commands are required:

   - ‘certutil.exe’

   - ‘curl.exe’ (default file downloader)

   - ‘wget.exe’ (alternative file downloader)

   - ‘tar.exe’

   - ‘gpg.exe’

   - ‘git.exe’

   - ‘Set-PsEnv’ (when using virtual environments)

In recent Windows 10 builds, only ‘wget’, ‘gpg’, ‘git’, and ‘Set-PsEnv’
should require installation.  You can download the GnuPG software from:

‘https://www.gnupg.org/’

You can download Git from:

‘https://gitforwindows.org’

You can download Wget from:

‘https://eternallybored.org/misc/wget/’

You can also use Chocolatey to install the commands above:

     > choco install gnupg git wget

To install Set-PsEnv(1) from the PowerShell Gallery:

     PS> Install-Module -Name Set-PsEnv

On macOS systems, Apple bundles both ‘curl’ and BSD ‘tar’ (under the
name ‘tar’; you can simply create a ‘bsdtar’ alias or install a more
recent version).  The required commands can be easily installed using
MacPorts:

     $ sudo port install coreutils wget libarchive gnupg2 git direnv

Or using Homebrew:

     $ brew install coreutils wget libarchive gnupg2 git direnv

On Linux systems, use the distribution’s own package manager to install
any missing command.  For example, in recent Ubuntu versions:

     $ sudo apt update
     $ sudo apt install coreutils curl wget libarchive-tools gnupg2 git direnv

   ---------- Footnotes ----------

   (1) https://github.com/rajivharris/Set-PsEnv


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<14>,  Next: Loading<14>,  Prev: Requirements<5>,  Up: packs

5.18.2 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#packs’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<14>,  Next: Testing<12>,  Prev: API documentation<14>,  Up: packs

5.18.3 Loading
--------------

This tool can be loaded using the query:

     | ?- logtalk_load(packs(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<12>,  Next: Usage<9>,  Prev: Loading<14>,  Up: packs

5.18.4 Testing
--------------

To run the tool tests, use the query:

     | ?- logtalk_load(packs(tester)).

The tests can be run without interfering with the user packs setup.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<9>,  Next: Programmatic query API,  Prev: Testing<12>,  Up: packs

5.18.5 Usage
------------

The ‘packs’ tool loads at startup all the currently defined registry and
pack specifications (from the registries/packs storage directory; see
below).  When no registry/pack setup exists, a new one is automatically
created.

The tool provides two main objects, ‘registries’ and ‘packs’, for
handling, respectively, registries and packs.  Both objects accept a
‘help/0’ message that describes the most common queries.


File: TheLogtalkHandbook-3.100.1.info,  Node: Programmatic query API,  Next: Registries and packs storage,  Prev: Usage<9>,  Up: packs

5.18.6 Programmatic query API
-----------------------------

Besides the user-facing predicates that print information (e.g.,
‘describe/1-2’), the ‘packs’ object also provides a query API intended
for programmatic use by tools and tests.  This API exposes resolved
installed-pack metadata and current-session load participation as data
instead of formatted text.

The main predicates are:

   - ‘pack_metadata/4’

   - ‘pack_property/4’

   - ‘pack_object/3’

   - ‘loaded_pack/3’

   - ‘loaded_pack_file/4’

   - ‘pack_dependency/6’

   - ‘loaded_pack_dependency/6’

The ‘pack_metadata/4’ predicate enumerates installed packs and returns a
resolved metadata term with the shape:

     metadata(Name, Description, License, Home, SourceURL, Checksum, Dependencies, Portability, Directory, Pinned, Installed, Loaded)

The term combines metadata declared by the pack specification object
with the metadata selected from the installed version.  Missing optional
metadata is normalized to ‘none’.  The ‘Installed’ field is always
‘true’ on success.  The ‘Loaded’ field reports if the installed pack
contributed at least one currently loaded file to the session.

For example:

     | ?- packs::pack_metadata(Registry, Pack, Version, Metadata).
     ...

The ‘pack_property/4’ predicate provides selective access to resolved
metadata using property terms.  Supported properties are:

   - ‘name(Name)’

   - ‘description(Description)’

   - ‘license(License)’

   - ‘home(Home)’

   - ‘source_url(URL)’

   - ‘checksum(Checksum)’

   - ‘dependencies(Dependencies)’

   - ‘portability(Portability)’

   - ‘directory(Directory)’

   - ‘pinned(Boolean)’

   - ‘installed(Boolean)’

   - ‘loaded(Boolean)’

For example:

     | ?- packs::pack_property(local_1_d, foo, Version, license(License)).
     License = 'Apache-2.0'.

The ‘pack_object/3’ predicate is a low-level bridge that returns the
pack specification object implementing the ‘pack_protocol’ for a given
registry and pack.  Most clients should prefer ‘pack_metadata/4’ or
‘pack_property/4’ unless direct access to the pack object is required.

For example:

     | ?- packs::pack_object(local_1_d, foo, PackObject).
     PackObject = foo_pack.

The ‘loaded_pack/3’ and ‘loaded_pack_file/4’ predicates expose
current-session pack participation.  A pack is considered loaded iff at
least one currently loaded file belongs to its installation directory.
The first predicate is the high-level query, while the second predicate
can be used to inspect the files that justify that status.

For example:

     | ?- packs::loaded_pack(Registry, Pack, Version).
     ...

     | ?- packs::loaded_pack_file(Registry, Pack, Version, File).
     ...

The ‘pack_dependency/6’ predicate enumerates resolved direct
pack-to-pack dependencies for installed pack versions using the same
version comparison and dependency selection semantics used by the
installation logic.  Version ranges, alternatives, and conjunctions are
resolved canonically.  Non-pack dependencies on Logtalk, Prolog
backends, and operating systems are ignored by this predicate.

For example:

     | ?- packs::pack_dependency(local_1_d, foo, 2:0:0, DependencyRegistry, DependencyPack, DependencyVersion).
     DependencyRegistry = local_2_d,
     DependencyPack = baz,
     DependencyVersion = 1:0:0.

The ‘loaded_pack_dependency/6’ predicate is the loaded-session
counterpart of ‘pack_dependency/6’.  It only succeeds when both the
source pack and the dependency pack contributed loaded files to the
current session.

For example:

     | ?- packs::loaded_pack_dependency(Registry, Pack, Version, DependencyRegistry, DependencyPack, DependencyVersion).
     ...

These predicates are especially useful for tools such as ‘sbom’, which
need to query resolved pack metadata, determine which installed packs
contributed code to the current session, and enumerate relationships
between those packs without reconstructing that information manually.


File: TheLogtalkHandbook-3.100.1.info,  Node: Registries and packs storage,  Next: Virtual environments,  Prev: Programmatic query API,  Up: packs

5.18.7 Registries and packs storage
-----------------------------------

The tool uses a directory specified using the ‘logtalk_packs’ library
alias when defined (in a settings file or in a backend Prolog
initialization file).  When this library alias is not defined, the tool
uses the value of the ‘LOGTALKPACKS’ environment variable when defined.
Otherwise, it defaults to the ‘~/logtalk_packs’ directory.  The actual
directory can be retrieved by the query:

     | ?- packs::logtalk_packs(Directory).
     ...

This directory holds sub-directories for registries, packs, and
archives.  These sub-directories are automatically created when loading
the ‘packs’ tool if they don’t exist.  Users should not manually modify
the contents of these directories.  Multiple and independent
registry/pack setups are possible using 'virtual environments' as
explained next.

Your registries and packs setup can be saved and restored (e.g., in a
different system) by using the ‘packs::save/1-2’ and
‘packs::restore/1-2’ predicates, as explained in the next section about
virtual environments.  If necessary, before restoring, the
‘packs::reset/0’ predicate can be called to delete any defined
registries and installed packs.


File: TheLogtalkHandbook-3.100.1.info,  Node: Virtual environments,  Next: Lock files,  Prev: Registries and packs storage,  Up: packs

5.18.8 Virtual environments
---------------------------

An application may require specific pack versions.  These requirements
may differ between applications.  Different applications may also have
conflicting requirements.  Therefore, a 'virtual environment' where an
application requirements are fulfilled may be required to develop and/or
run it.  A virtual environment is essentially a registries/packs storage
directory.

Defining the ‘logtalk_packs’ library alias in a settings file or
defining the ‘LOGTALKPACKS’ environment variable before starting Logtalk
allows easy creation and switching between virtual environments.  By
using a per-application settings file (or a per-application environment
variable definition), each application can thus use its own virtual
environment.  The ‘settings.lgt’ file can define the ‘logtalk_packs’
library alias using code such as:

     :- initialization((
         logtalk_load_context(directory, Directory),
         assertz(logtalk_library_path(logtalk_packs, Directory))
     )).

The definition of the ‘logtalk_packs’ library alias 'must' always be an
atom and thus never use library notation (i.e., it must never depend on
other library aliases).

When a virtual environment also requires a specific Logtalk version
(e.g., the version used to test and certify it), this can be installed
as a pack from the official talkshow(1) registry and used by
(re)defining the ‘LOGTALKHOME’ and ‘LOGTALKUSER’ environment variables
to point to its pack directory (which can be queried by using the
‘packs::directory/2’ message).

Experimental ‘lgtenv.sh’ and ‘lgtenv.ps1’ scripts are included to
simplify creating virtual environments.  For example:

     $ lgtenv -d ~/my_venv -c -p logtalk_packs
     $ cd ~/my_venv
     direnv: loading ~/my_venv/.envrc
     direnv: export +LOGTALKPACKS

Type ‘lgtenv -h’ for details on the script options.

These scripts require, respectively, direnv(2) and Set-PsEnv(3) to be
installed.  These utilities load and unload environment variables when
changing the current directory.  On Windows systems, when using the
‘lgtenv.ps1’ script, you also need to redefine the PowerShell prompt in
a profile file (e.g., ‘$HOME\Documents\PowerShell\Profile.ps1’) to mimic
the functionality of ‘direnv’ of automatically loading an existing
‘.env’ file when changing to its directory.  For example:

     function prompt {
         Set-PsEnv
         'PS ' + $(Get-Location) + '> '
     }

A virtual environment setup (i.e., the currently defined registries and
installed packs) can be saved into a file (e.g., ‘requirements.lgt’)
using the ‘packs::save/1-2’ predicates.  For example:

     | ?- packs::save('requirements.lgt').
     ...

This query saves a listing of all the installed packs and their
registries.  Using the saved file, the virtual environment setup can
then be restored using the ‘packs::restore/1-2’ predicates.  The file
uses a simple format with ‘registry/2’, ‘pack/3’, ‘pinned_registry/1’,
and ‘pinned_pack/1’ facts (in this order) and can be manually created or
edited if necessary.  For example:

     registry(talkshow, 'https://github.com/LogtalkDotOrg/talkshow.git').
     pack(talkshow, logtalk, 3:45:0).
     pack(talkshow, lflat, 2:1:0).

These files can be distributed with applications so that users can
easily fulfill application requirements by running the query once:

     | ?- packs::restore('requirements.lgt').

Subsequently, the application ‘loader.lgt’ file can then load the
required packs using their loader files:

     :- initialization((
         % load required packs
         logtalk_load(foo(loader)),
         logtalk_load(bar(loader)),
         ...
         % load application files
         ...
     )).

Note that restoring encrypted registries or encrypted packs requires
entering the required passphrases.  Although the ‘restore/2’ predicate
accepts a list of options that include the ‘gpg/1’ option, this only
allows specifying a single and common passphrase when interactive
entering of passphrases is not convenient or possible.

   ---------- Footnotes ----------

   (1) https://github.com/LogtalkDotOrg/talkshow

   (2) https://github.com/direnv/direnv

   (3) https://github.com/rajivharris/Set-PsEnv


File: TheLogtalkHandbook-3.100.1.info,  Node: Lock files,  Next: Registry specification,  Prev: Virtual environments,  Up: packs

5.18.9 Lock files
-----------------

For deterministic installs and CI/CD reproducibility when working with
virtual environments, the ‘save/2’ and ‘restore/2’ predicates support a
‘lock(true)’ option.  Saving with this option writes lock extension
facts in addition to the requirements facts:

     lockfile_version(1).
     lock_registry_commit(talkshow, '0123456789abcdef0123456789abcdef01234567').
     lock_integrity(talkshow, lflat, 2:1:0, sha256, '8774b3863efc03bb6c85dcf34f69f1156d2496a3').

The ‘lock_registry_commit/2’ facts are generated only for registries
defined from git URLs.  Restoring with ‘lock(true)’ enforces lock
extension facts, including exact pack versions, integrity hashes, and
git registry commits.


File: TheLogtalkHandbook-3.100.1.info,  Node: Registry specification,  Next: Registry handling,  Prev: Lock files,  Up: packs

5.18.10 Registry specification
------------------------------

A registry is a git remote repo that can be cloned, a downloadable or
local archive, or a local directory containing a Logtalk loader file
that loads source files defining the registry itself and the packs it
provides.  The registry name is ideally a valid unquoted atom.  The
registry directory must contain at least two Logtalk source files:

   - A file defining an object named after the registry with a
     ‘_registry’ suffix, implementing the ‘registry_protocol’.  This
     naming convention helps prevent name conflicts.

   - A loader file (named ‘loader.lgt’ or ‘loader.logtalk’) that loads
     the registry object file and all pack object files.

An example of a registry specification object would be:

     :- object(jdoe_awesome_packs_registry,
         implements(registry_protocol)).

         :- info([
             version is 1:0:0,
             author is 'John Doe',
             date is 2021-10-18,
             comment is 'John Doe awesome packs registry spec.'
         ]).

         name(jdoe_awesome_packs).

         description('John Doe awesome packs').

         home('https://example.com/jdoe_awesome_packs').

         clone('https://github.com/jdoe/jdoe_awesome_packs.git').

         archive('https://github.com/jdoe/jdoe_awesome_packs/archive/main.zip').

     :- end_object.

Optionally, the registry object can also define a ‘note(Action, Note)’
predicate.  The ‘Action’ argument is an atom: ‘add’, ‘update’, or
‘delete’.  The ‘Note’ argument is also an atom.  The tool will print any
available notes when executing one of the registry actions.  See the
‘registry_protocol’ documentation for more details.

The registry directory should also contain ‘LICENSE’ and ‘README.md’
files (individual packs can use a different license, however).  The path
to the ‘README.md’ file is printed when the registry is added.  It can
also be queried using the ‘registries::directory/2’ predicate.  The
‘NOTES.md’ file name can also be used in alternative to the recommended
‘README.md’ file name.

Summarizing the required directory structure using the above example
(note that the registry and pack specification files are named after the
objects):

     jdoe_awesome_packs
         LICENSE
         README.md
         jdoe_awesome_packs_registry.lgt
         loader.lgt
         foo_pack.lgt
         bar_pack.lgt
         ...

With the contents of the ‘loader.lgt’ file being:

     :- initialization((
         logtalk_load(jdoe_awesome_packs_registry),
         logtalk_load(foo_pack),
         logtalk_load(bar_pack),
         ...
     )).

It would be, of course, possible to have all objects in a single source
file.  But having a file per-object and a loader file helps maintenance,
and it’s also a tool requirement for applying safety procedures to the
source file contents and thus successfully loading the registry and pack
specs.

As registries are git repos in the most common case, and thus adding
them performs a git repo cloning, they should only contain the strictly
required files.


File: TheLogtalkHandbook-3.100.1.info,  Node: Registry handling,  Next: Registry development,  Prev: Registry specification,  Up: packs

5.18.11 Registry handling
-------------------------

Registries can be added using the ‘registries::add/1-3’ predicates,
which take a registry URL. Using the example above:

     | ?- registries::add('https://github.com/jdoe/jdoe_awesome_packs.git').

HTTPS URLs must end with either a ‘.git’ extension or an archive
extension (same valid extensions as for pack archives, including ‘gpg’
encrypted).  Git cloning URLs are preferred as they simplify updating
registries.  But a registry can also be made available via a local
directory (using a ‘file://’ URL) or a downloadable archive (using a
‘https://’ URL).

For registries made available using an archive, the
‘registries::add/2-3’ predicates 'must' be used as the registry name
cannot in general be inferred from the URL basename or from the archived
directory name.  The registry argument must also be the declared
registry name in the registry specification object.  For example:

     | ?- registries::add(
             jdoe_awesome_packs,
             'https://github.com/jdoe/jdoe_awesome_packs/archive/main.zip'
          ).

When a registry may be already defined, you can use the ‘update(true)’
option to ensure that the registry will be updated to its latest
definition:

     | ?- registries::add(
             jdoe_awesome_packs,
             'https://github.com/jdoe/jdoe_awesome_packs/archive/main.zip',
             [update(true)]
          ).

The added registries can be listed using the ‘registries::list/0’
predicate:

     | ?- registries::list.

     % Defined registries:
     %   jdoe_awesome_packs (git)
     %   ...

The ‘registries::describe/1’ predicate can be used to print the details
of a registry:

     | ?- registries::describe(jdoe_awesome_packs).

     % Registry:    jdoe_awesome_packs
     % Description: John Doe awesome packs
     % Home:        https://example.com/jdoe_awesome_packs
     % Cloning URL: https://github.com/jdoe/jdoe_awesome_packs.git
     % Archive URL: https://github.com/jdoe/jdoe_awesome_packs/archive/main.zip

To update all registries, use the ‘registries::update/0’ predicate.  To
update a single registry, use the ‘registries::update/1-2’ predicates.
After updating, you can use the ‘packs::outdated/0-1’ predicates to list
any outdated packs.

Registries can also be deleted using the ‘registries::delete/1-2’
predicate.  By default, any registries with installed packs cannot be
deleted.  If you force deletion (by using the ‘force(true)’ option), you
can use the ‘packs::orphaned/0’ predicate to list any orphaned packs
that are installed.

See the tool API documentation on the registries(1) object for other
useful predicates.

   ---------- Footnotes ----------

   (1) ../../docs/registries_0.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Registry development,  Next: Pack specification,  Prev: Registry handling,  Up: packs

5.18.12 Registry development
----------------------------

To simplify registry development and testing, use a local directory and
a ‘file://’ URL when calling the ‘registries::add/1’ predicate.  For
example:

     | ?- registries::add('file:///home/jdoe/work/my_pack_collection').

If the directory is a git repo, the tool will clone it when adding it.
Otherwise, the files in the directory are copied to the registry
definition directory.  This allows the registry to be added and deleted
without consequences for the original registry source files.

The ‘registries::add/3’ and ‘registries::update/2’ predicates also
accept a ‘commit(Hash)’ option.  This option checks out a git registry
at an exact commit hash.  Using this option with non-git registries
fails with an error message.

To check your registry specifications, use the ‘registries::lint/0-1’
predicates after adding the registry.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pack specification,  Next: Encrypted packs,  Prev: Registry development,  Up: packs

5.18.13 Pack specification
--------------------------

A pack is specified using a Logtalk source file defining an object that
implements the ‘pack_protocol’.  The source file should be named after
the pack with a ‘_pack’ suffix.  This naming convention helps prevent
name conflicts, notably with the pack’s own objects.  The file must be
available from a declared pack registry (by having the registry loader
file loading it).  The pack name is preferably a valid unquoted atom.
An example of a pack specification object would be:

     :- object(lflat_pack,
         implements(pack_protocol)).

         :- info([
             version is 1:0:0,
             author is 'Paulo Moura',
             date is 2021-10-18,
             comment is 'L-FLAT - Logtalk Formal Language and Automata Toolkit pack spec.'
         ]).

         name(lflat).

         description('L-FLAT - Logtalk Formal Language and Automata Toolkit').

         license('MIT').

         home('https://github.com/l-flat/lflat').

         version(
             2:1:0,
             stable,
             'https://github.com/l-flat/lflat/archive/refs/tags/v2.1.0.tar.gz',
             sha256 - '9c298c2a08c4e2a1972c14720ef1498e7f116c7cd8bf7702c8d22d8ff549b6a1',
             [logtalk @>= 3:42:0],
             all
         ).

         version(
             2:0:2,
             stable,
             'https://github.com/l-flat/lflat/archive/refs/tags/v2.0.2.tar.gz',
             sha256 - '8774b3863efc03bb6c284935885dcf34f69f115656d2496a33a446b6199f3e19',
             [logtalk @>= 3:36:0],
             all
         ).

     :- end_object.

The ‘license/1’ argument must be an atom and should, whenever possible,
be a license identifier as specified in the SPDX standard(1).

Optionally, the pack object can also define a ‘note(Action, Version,
Note)’ predicate.  The ‘Action’ argument is an atom: ‘install’,
‘update’, or ‘uninstall’.  The ‘Note’ argument is also an atom.  The
tool will print any available notes when executing one of the registry
actions.  See the ‘pack_protocol’ documentation for more details.

The pack sources must be available either as a local directory (when
using a ‘file://’ URL) or for downloading as a supported archive.  The
checksum for the archive must use the SHA-256 hash algorithm (‘sha256’).
The pack may optionally be signed.  Supported archive formats and
extensions are:

   - ‘.zip’

   - ‘.tgz’, ‘.tar.gz’

   - ‘.tbz2’, ‘.tar.bz2’

Also, for encrypted packs, all the extensions above with a ‘.gpg’ suffix
(e.g., ‘.zip.gpg’).

The pack sources should contain ‘LICENSE’, ‘README.md’ (or ‘NOTES.md’),
and ‘loader.lgt’ (or ‘loader.logtalk’) files.  Ideally, it should also
contain a ‘tester.lgt’ (‘tester.logtalk’) file.  The path to the
‘README.md’ file is printed when the pack is installed or updated.  It
can also be queried using the ‘packs::directory/2’ predicate.

   ---------- Footnotes ----------

   (1) https://spdx.org/licenses/


File: TheLogtalkHandbook-3.100.1.info,  Node: Encrypted packs,  Next: Signed packs,  Prev: Pack specification,  Up: packs

5.18.14 Encrypted packs
-----------------------

Packs can be ‘gpg’ encrypted, with a choice of passphrase-based
encryption, key-based encryption, or both.  Encrypted pack archives must
always have a ‘.gpg’ extension.  For example, to encrypt a pack archive
with a symmetric cipher using a passphrase:

     $ tar -cvzf - my_pack | gpg -c --cipher-algo AES256 > v1.2.1.tar.gz.gpg

In this case, the passphrase would need to be securely communicated to
any users installing or updating the pack.

See the ‘gpg’ documentation for full details on encrypting and
decrypting archives.  If you get a “gpg: problem with the agent:
Inappropriate ioctl for device” error message with the command above,
try:

     $ export GPG_TTY=$(tty)


File: TheLogtalkHandbook-3.100.1.info,  Node: Signed packs,  Next: Pack URLs and Single Sign-On,  Prev: Encrypted packs,  Up: packs

5.18.15 Signed packs
--------------------

Packs can be ‘gpg’ signed.  Detached signature files are assumed and
expected to share the name of the archive and use ‘.asc’ or ‘.sig’
extensions.  For example, if the pack archive name is ‘v1.0.0.tar.gz’,
the signature file must be named ‘v1.0.0.tar.gz.asc’ or
‘v1.0.0.tar.gz.sig’.  When the ‘checksig(true)’ option is used, the
signature file is automatically downloaded using a URL constructed from
the pack archive URL. When both ‘.asc’ and ‘.sig’ files exist, the
‘.asc’ file is used.  An example of signing a pack and creating the
‘.asc’ file (assuming the default signing key) is:

     $ gpg --armor --detach-sign v1.0.0.tar.gz

To create instead a ‘.sig’ file:

     $ gpg --detach-sign v1.0.0.tar.gz

See the ‘gpg’ documentation for full details on signing archives and
sharing the public keys required to verify the signatures.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pack URLs and Single Sign-On,  Next: Multiple pack versions,  Prev: Signed packs,  Up: packs

5.18.16 Pack URLs and Single Sign-On
------------------------------------

Typically, pack archive download URLs are HTTPS URLs and handled using
‘curl’.  It’s also possible to use ‘git archive’ to download pack
archives, provided that the server supports it (as of this writing,
Bitbucket and GitLab public hosting services support it but not GitHub).
Using ‘git archive’ is specially useful when the packs registry is
hosted on a server using Single Sign-On (SSO) for authentication.  In
this case, HTTPS URLs can only be handled by ‘curl’ by passing a token
(see below for an example).  When the user has setup SSH keys to
authenticate to the packs registry server, ‘git archive’ simplifies pack
installation, providing a better user experience.  For example:

     version(
         1:0:1,
         stable,
         'git@gitlab.com:me/foo.git/v1.0.1.zip',
         sha256 - '0894c7cdb8968b6bbcf00e3673c1c16cfa98232573af30ceddda207b20a7a207',
         [logtalk @>= 3:36:0],
         all
     ).

The pseudo-URL must be the concatenation of the SSH repo cloning URL
with the archive name.  The archive name must be the concatenation of a
valid tag with a supported archive extension.  SSH repo cloning URLs use
the format:

     git@<hostname>:path/to/project.git

They can usually be easily copied from the hosting service repo webpage.
To compute the checksum, you must first download the archive.  For
example:

     $ git archive --output=foo-v1.0.1.zip --remote=git@gitlab.com:me/foo.git v1.0.1
     $ openssl sha256 foo-v1.0.1.zip

Be sure to use a format that is supported by both the ‘packs’ tool and
the ‘git archive’ command (the format is inferred from the ‘--output’
option).  Do not download the archive from the web interface of the git
hosting service in order to compute the checksum.  Different
implementations of the archiving and compressing algorithms may be used,
resulting in mismatched checksums.

Users installing packs available using ‘git archive’ URLs are advised to
run a SSH agent to avoid being prompted for passwords when installing or
updating packs.  They must also upload their SSH public keys to the pack
provider hosts.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multiple pack versions,  Next: Pack dependencies,  Prev: Pack URLs and Single Sign-On,  Up: packs

5.18.17 Multiple pack versions
------------------------------

A pack may specify multiple versions.  Each version is described using a
‘version/6’ predicate clause as illustrated in the example above.  The
versions must be listed in order from newest to oldest.  For details,
see the ‘pack_protocol’ API documentation.

Listing multiple versions allows the pack specification to be updated
(by updating its registry) without forcing existing users into
installing (or updating to) the latest version of the pack.  It allows
different applications depending on different pack versions to continue
to be built and deployed.

The pack version is complemented by the pack status.  Valid values are
‘stable’, ‘rc’, ‘beta’, ‘alpha’, ‘experimental’, and ‘deprecated’.
Packs with a ‘experimental’ or ‘deprecated’ status are 'never' installed
by default when using the install and update predicates unless their
version is explicitly specified.  When updating packs, we can restrict
the valid status of the updates using the ‘status/1’ option.  For
example, we can ensure that we only update to new stable pack versions
by using the option ‘status([stable])’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pack dependencies,  Next: Pack portability,  Prev: Multiple pack versions,  Up: packs

5.18.18 Pack dependencies
-------------------------

Pack dependencies on other packs can be specified using a list of
‘Registry::Pack Operator Version’ terms where ‘Operator’ is a standard
term comparison operator:

   - ‘Registry::Pack @>= Version’ - the pack requires a dependency with
     a version equal or above the specified one.  For example, ‘logtalk
     @>= 3:36:0’ means that the pack requires Logtalk 3.36.0 or a later
     version.

   - ‘Registry::Pack @=< Version’ - the pack requires a dependency with
     a version up to the specified one.  For example, ‘common::bits @=<
     2:1’ means that the pack requires a ‘common::bits’ pack up to 2.1.
     This includes all previous versions and also all patches for
     version 2.1 (e.g., 2.1.7, 2.1.8, …) but not version 2.2 or newer.

   - ‘Registry::Pack @< Version’ - the pack requires a dependency with
     version older than the specified one.  For example, ‘common::bits
     @< 3’ means that the pack requires a ‘common::bits’ 2.x or older
     version.

   - ‘Registry::Pack @> Version’ - the pack requires a dependency with
     version newer than the specified one.  For example, ‘common::bits
     @> 2:4’ means that the pack requires a ‘common::bits’ 2.5 or newer
     version.

   - ‘Registry::Pack == Version’ - the pack requires a dependency with a
     specific version.  For example, ‘common::bits == 2:1’ means that
     the pack requires a ‘common::bits’ pack version 2.1.x (thus, from
     version 2.1.0 to the latest patch for version 2.1).

   - ‘Registry::Pack \== Version’ - the pack requires a dependency with
     any version other than the one specified.  For example,
     ‘common::bits \== 2.1’ means that the pack requires a
     ‘common::bits’ pack version other than any 2.1.x version.

To specify 'range' dependencies by using two consecutive elements with
the lower bound followed by the upper bound.  For example, ‘common::bits
@>= 2, common::bits @< 3’ means all ‘common::bits’ 2.x versions but not
older or newer major versions.

It’s also possible to specify 'alternative' dependencies using the
‘(;)/2’ operator.  For example, ‘(common::bits == 1:9; common::bits @>=
2:3)’ means either ‘common::bits’ 1.9.x versions or 2.3.x and later
versions.  Alternatives should be listed in decreasing order of
preference.

When a pack also depends on a Logtalk or backend version, the name
‘logtalk’ or the backend identifier atom can be used in place of
‘Registry::Pack’ (see below for the table of backend specifiers).  For
example, ‘logtalk @>= 3.36.0’.

When a pack also depends on an operating-system version (e.g., a pack
containing shared libraries with executable code), the
‘os(Name,Machine)’ compound term can also be used in place of
‘Registry::Pack’.  For example, ‘os('Darwin',x86_64) @>= '23.0.0'’.
Note that, in this case, the release is an atom.  The operating-system
data (name, machine, and release) is queried using the corresponding
‘os’ library predicates (see the library documentation for details).


File: TheLogtalkHandbook-3.100.1.info,  Node: Pack portability,  Next: Pack development,  Prev: Pack dependencies,  Up: packs

5.18.19 Pack portability
------------------------

Ideally, packs are fully portable and can be used with all
Logtalk-supported Prolog backends.  This can be declared by using the
atom ‘all’ in the last argument of the ‘version/6’ predicate (see
example above).

When a pack can only be used with a subset of the Prolog backends, the
last argument of the ‘version/6’ predicate is a list of backend
identifiers (atoms):

   - B-Prolog: ‘b’

   - Ciao Prolog: ‘ciao’

   - CxProlog: ‘cx’

   - ECLiPSe: ‘eclipse’

   - GNU Prolog: ‘gnu’

   - JIProlog: ‘ji’

   - Quintus Prolog: ‘quintus’

   - SICStus Prolog: ‘sicstus’

   - SWI-Prolog: ‘swi’

   - Tau Prolog: ‘tau’

   - Trealla Prolog: ‘trealla’

   - XSB: ‘xsb’

   - XVM: ‘xvm’

   - YAP: ‘yap’


File: TheLogtalkHandbook-3.100.1.info,  Node: Pack development,  Next: Pack handling,  Prev: Pack portability,  Up: packs

5.18.20 Pack development
------------------------

To simplify pack development and testing, define a local registry and
add to it a pack specification with the development version available
from a local directory.  For example:

     version(
         0:11:0,
         beta,
         'file:///home/jdoe/work/my_awesome_library',
         none,
         [],
         all
     ).

If the directory is a git repo, the tool will clone it when installing
the pack.  Otherwise, the files in the directory are copied to the pack
installation directory.  This allows the pack to be installed, updated,
and uninstalled without consequences for the pack source files.

You can also use a local archive instead of a directory.  For example:

     version(
         1:0:0,
         stable,
         'file:///home/jdoe/work/my_awesome_library/v1.0.0.tar.gz',
         sha256 - '1944773afba1908cc6194297ff6b5ac649a844ef69a69b2bcdf267cfa8bfce1e',
         [],
         all
     ).

Packs that are expected to be fully portable should always be checked by
loading them with the ‘portability’ flag set to ‘warning’.

To check your pack manifest files, use the ‘packs::lint/0-2’ predicates
after adding the registry that provides the packs.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pack handling,  Next: Pack documentation,  Prev: Pack development,  Up: packs

5.18.21 Pack handling
---------------------

Packs must be available from a defined registry.  To list all packs that
are available for installation, use the ‘packs::available/0’ predicate:

     | ?- packs::available.

To list all installed packs, call the ‘packs::installed/0’ predicate:

     | ?- packs::installed.

To list only the installed packs from a specific registry, call instead
the ‘packs::installed/1’ predicate.  For example:

     | ?- packs::installed(talkshow).

To know more about a specific pack, use the ‘packs::describe/1-2’
predicates.  For example:

     | ?- packs::describe(bar).

The ‘packs::describe/2’ predicate can be used when two or more
registries provide packs with the same name.  For example:

     | ?- packs::describe(reg, bar).

To install the latest version of a pack, we can use the
‘packs::install/1-4’ predicates.  In the most simple case, when a pack
name is unique among registries, we can use the ‘packs::install/1’
predicate.  For example:

     | ?- packs::install(bar).

Any pack dependencies are also checked and installed or updated if
necessary.  Other install predicates are available to disambiguate
between registries and to install a specific pack version.

Packs become available for loading immediately after successful
installation (no restarting of the Logtalk session is required).  For
example, after the pack ‘bar’ is installed, you can load it at the
top-level by typing:

     | ?- {bar(loader)}.

or load it from a loader file using the goal
‘logtalk_load(bar(loader))’.

After updating the defined registries, outdated packs can be listed
using the ‘packs::outdated/0’ predicate.  You can update all outdated
packs by calling the ‘packs::update/0’ predicate or update a single pack
using the ‘packs::update/1-2’ predicates.  For example:

     | ?- packs::update(bar).

By default, updating a pack fails if it would break any dependent pack
(the ‘force(true)’ option, described below, can be used to force
updating in this case).

The tool provides versions of the pack install, update, and uninstall
predicates that accept a list of options:

   - ‘verbose(Boolean)’ (default is ‘false’)

   - ‘clean(Boolean)’ (default is ‘false’)

   - ‘update(Boolean)’ (default is ‘false’)

   - ‘force(Boolean)’ (default is ‘false’)

   - ‘compatible(Boolean)’ (default is ‘true’)

   - ‘checksum(Boolean)’ (default is ‘true’)

   - ‘checksig(Boolean)’ (default is ‘false’)

   - ‘git(Atom)’ (extra command-line options; default is ‘''’)

   - ‘downloader(Atom)’ (downloader utility; default is ‘curl’)

   - ‘curl(Atom)’ (extra command-line options; default is ‘''’)

   - ‘wget(Atom)’ (extra command-line options; default is ‘''’)

   - ‘gpg(Atom)’ (extra command-line options; default is ‘''’)

   - ‘tar(Atom)’ (extra command-line options; default is ‘''’)

Note that, by default, only compatible packs can be installed.  To
install a pack that is incompatible with the current Logtalk version,
backend version, or operating-system version, use the ‘install/4’ or
‘update/3’ predicates with the option ‘compatible(false)’.

When installing large packs over unreliable network conditions, you may
try switching the default downloader utility from ‘curl’ to ‘wget’.

When a pack may already be installed, you can use the ‘update(true)’
option to ensure that the installation will be updated to the specified
version:

     | ?- packs::install(reg, bar, 1:1:2, [update(true)]).

When using a ‘checksig(true)’ option to check a pack signature, it is
strongly advised that you also use the ‘verbose(true)’ option.  For
example:

     | ?- packs::install(reg, bar, 1:1:2, [verbose(true), checksig(true)]).

Note that the public key used to sign the pack archive must already be
present in your local system.

Downloading pack archives may require passing extra command-line options
to ‘curl’ for authentication.  A common solution is to use a personal
access token.  The details depend on the server software.  An example
when using GitHub:

     | ?- packs::install(reg, bar, 1:1:2, [curl('--header "Authorization: token foo42"')]).

Another example when using GitLab:

     | ?- packs::install(reg, bar, 1:1:2, [curl('--header "PRIVATE-TOKEN: foo42"')]).

Pack archives may be ‘gpg’ encrypted.  Encryption can be
passphrase-based, key-based, or both.  When using only passphrase-based
encryption, the archive passphrase must be entered (if not cached) when
installing or updating a pack.  In this case, the passphrase can be
entered interactively or using the ‘gpg/1’ option.  For example:

     | ?- packs::install(reg, bar, 1:1:2, [gpg('--batch --passphrase test123')]).

See the ‘gpg’ documentation for details.  When using the ‘gpg/1’ option,
you should be careful to not leak passphrases in, e.g., the query
history.

To uninstall a pack that you no longer need, use the
‘packs::uninstall/1-2’ predicates.  By default, only packs with no
dependent packs can be uninstalled.  You can print or get a list of the
packs that depend on a given pack by using the ‘packs::dependents/1-3’
predicates.  For example:

     | ?- packs::dependents(reg, bar, Dependents).

See the tool API documentation on the packs(1) object for other useful
predicates.

   ---------- Footnotes ----------

   (1) ../../docs/packs_0.html


File: TheLogtalkHandbook-3.100.1.info,  Node: Pack documentation,  Next: Pinning registries and packs,  Prev: Pack handling,  Up: packs

5.18.22 Pack documentation
--------------------------

The path to the pack ‘README.md’ file is printed when the pack is
installed or updated.  It can also be retrieved at any time by using the
‘readme/2’ predicate.  For example:

     | ?- packs::readme(lflat, Path).

Additional documentation may also be available from the pack home page,
which can be printed by using the ‘describe/1-2’ predicates.  For
example:

     | ?- packs::describe(lflat).

     % Registry:    ...
     % Pack:        lflat
     % Description: L-FLAT - Logtalk Formal Language and Automata Toolkit
     % License:     MIT
     % Home:        https://github.com/l-flat/lflat
     % Versions:
     ...

The pack API documentation can be generated using the ‘lgtdoc’ tool
library and directory predicates (depending on the pack source files
organization).  For example:

     | ?- {lflat(loader)},
          {lgtdoc(loader)},
          logtalk::expand_library_path(lflat, Path),
          lgtdoc::rdirectory(Path).
     ...

This query creates a ‘xml_docs’ directory in the current directory.  The
XML documentation files can then be converted into a final format, e.g.,
HTML, using one of the scripts provided by the ‘lgtdoc’ tool.  For
example:

     $ cd xml_docs
     $ lgt2html

For more details and alternatives, see the ‘lgtdoc’ tool documentation.

It is also possible to add API documentation and diagrams for all the
installed packs to the Logtalk distribution API documentation and
diagrams by calling the ‘build’ and ‘update_svg_diagrams’ scripts in the
‘docs/apis/sources’ directory with the ‘-i’ option.  See the scripts
documentation for more details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pinning registries and packs,  Next: Testing packs,  Prev: Pack documentation,  Up: packs

5.18.23 Pinning registries and packs
------------------------------------

Registries and packs can be 'pinned' after installation to prevent
accidental updating or deleting, e.g., when using the batch ‘update/0’
predicate.  This is useful when your application requires a specific
version or for security considerations (see below).  For example, if we
want the ‘bar’ pack to stay at its current installed version:

     | ?- packs::pin(bar).
     yes

After, any attempt to update or uninstall the pack will fail with an
error message:

     | ?- packs::update(bar).
     !     Cannot update pinned pack: bar
     no

     | ?- packs::uninstall(bar).
     !     Cannot uninstall pinned pack: bar
     no

To enable the pack to be updated or uninstalled, the pack must first be
unpinned.  Alternatively, the ‘force(true)’ option can be used.  Note
that if you force update a pinned pack, the new version will be
unpinned.

It’s also possible to pin (or unpin) all defined registries or installed
packs at once by using the ‘pin/0’ (or ‘unpin/0’) predicates.  But note
that registries added after or packs installed after will not be
automatically pinned.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing packs,  Next: Security considerations,  Prev: Pinning registries and packs,  Up: packs

5.18.24 Testing packs
---------------------

Logtalk packs (as most Logtalk libraries, tools, and examples) are
expected to have a ‘tester.lgt’ or ‘tester.logtalk’ tests driver file at
the root of their directory, which can be used for both automated and
manual testing.  For example, after installing the ‘foo’ pack:

     | ?- {foo(tester)}.

To test all installed packs, you can use the ‘logtalk_tester’ automation
script from the installed packs directory, which you can query using the
goal:

     | ?- packs::prefix(Directory).

Note that running the packs tests, like simply loading the pack, can
result in calling arbitrary code, which can potentially harm your
system.  Always take into account the security considerations discussed
below.


File: TheLogtalkHandbook-3.100.1.info,  Node: Security considerations,  Next: Best practices,  Prev: Testing packs,  Up: packs

5.18.25 Security considerations
-------------------------------

New pack registries should be examined before being added, specially if
public and from a previously unknown source.  The same precautions
should be taken when adding or updating a pack.  Note that a registry
can always index third-party packs.

Pack checksums are checked by default.  But pack signatures are only
checked if requested, as packs are often unsigned.  Care should be taken
when adding public keys for pack signers to your local system.

Registry and pack spec files, plus the registry loader file, are
compiled by term-expanding them so that only expected terms are actually
loaded and only expected ‘logtalk_load/2’ goals with expected relative
file paths are allowed.  Predicates defining URLs are discarded if the
URLs are neither ‘https://’ nor ‘file://’ URLs or if they contain
non-allowed characters (currently, only alpha-numeric ASCII characters
plus the ASCII ‘/’, ‘.’, ‘-’, and ‘_’ characters are accepted).  But
note that this tool makes no attempt to audit pack source files
themselves.

Registries and packs can always be pinned so that they are not
accidentally updated to a version that you may not have had the chance
to audit.


File: TheLogtalkHandbook-3.100.1.info,  Node: Best practices,  Next: Installing Prolog packs,  Prev: Security considerations,  Up: packs

5.18.26 Best practices
----------------------

   - Make available a new pack registry as a git repo.  This simplifies
     updating the registry and rolling back to a previous version.

   - Use registry and pack names that are valid unquoted atoms, thus
     simplifying usage.  Use descriptive names with underscores if
     necessary to link words.

   - Name the registry and pack specification objects after their names
     with a ‘_registry’ or ‘_pack’ suffix.  Save the objects in files
     named after the objects.

   - Create new pack versions from git tags.

   - If the sources of a pack are available from a git repo, consider
     using signed commits and signed tags for increased security.

   - When a new pack version breaks backwards compatibility, list both
     the old and the new versions on the pack specification file.

   - Pin registries and packs when specific versions are critical for
     your work so that you can still easily batch update the remaining
     packs and registries.

   - Include the ‘$LOGTALKPACKS’ directory (or the default
     ‘~/logtalk_packs’ directory) on your regular backups.


File: TheLogtalkHandbook-3.100.1.info,  Node: Installing Prolog packs,  Next: Help with warnings<3>,  Prev: Best practices,  Up: packs

5.18.27 Installing Prolog packs
-------------------------------

This tool can also be used to install Prolog packs that don’t use
Logtalk.  After installing a ‘pl_pack’ Prolog pack from a ‘pl_reg’
registry, it can be found in the ‘$LOGTALKPACKS/packs/pl_reg/pl_pack’
directory.  When the ‘LOGTALKPACKS’ environment variable is not defined,
the pack directory is by default ‘~/logtalk_packs/packs/pl_reg/pl_pack’.

Different Prolog systems provide different solutions for locating Prolog
code.  For example, several Prolog systems adopted the Quintus Prolog
‘file_search_path/2’ hook predicate.  For these systems, a solution
could be to add a fact to this predicate for each installed Prolog pack.
For example, assuming a ‘pl_pack’ Prolog pack:

     :- multifile(file_search_path/2).
     :- dynamic(file_search_path/2).

     file_search_path(library, '$LOGTALKPACKS/packs/pl_pack').

If the Prolog system also supports reading an initialization file at
startup, the above definition could be added there.


File: TheLogtalkHandbook-3.100.1.info,  Node: Help with warnings<3>,  Next: Known issues<7>,  Prev: Installing Prolog packs,  Up: packs

5.18.28 Help with warnings
--------------------------

Load the ‘tutor’ tool to get help with selected warnings printed by the
‘packs’ tool.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<7>,  Prev: Help with warnings<3>,  Up: packs

5.18.29 Known issues
--------------------

Using the ‘verbose(true)’ option on Windows systems may not provide the
shell commands output depending on the backend.

On Windows systems, the reset, delete, and uninstall predicates may fail
to delete all affected folders and files due to a operating-system bug.
Depending on the backend, this bug may cause some of the tests to fail.
For details on this bug, see:

‘https://github.com/microsoft/terminal/issues/309’

The workaround is to use the Windows File Explorer to delete the
leftover folders and files.

When using Ciao Prolog 1.20.0, a workaround is used for this system
non-standard support for multifile predicates.

When using GNU Prolog 1.5.0 as the backend on Windows, you may get an
error on ‘directory_files/2’ calls.  For details and a workaround, see:

‘https://github.com/didoudiaz/gprolog/issues/4’

This issue is fixed in the latest GNU Prolog git version.

Using SICStus Prolog as the backend on Windows doesn’t currently work in
version 4.7.0 and earlier versions.  The underlying issues are fixed in
the SICStus Prolog 4.7.1 version.

XSB has an odd bug (likely in its parser) when reading files that may
cause a pack installed version to be reported as the ‘end_of_file’ atom.

Some tests fail on Windows when using ECLiPSe or XSB due to file path
representation issues.


File: TheLogtalkHandbook-3.100.1.info,  Node: ports_profiler,  Next: profiler,  Prev: packs,  Up: Developer Tools

5.19 ‘ports_profiler’
=====================

This tool counts and reports the number of times each port in the
'procedure box model' is traversed during the execution of queries.  It
can also report the number of times each clause (or grammar rule) is
used.  It is inspired by the ECLiPSe ‘port_profiler’ tool.

The procedure box model is the same as the one used in the debugger
tool.  This is an extended version of the original Byrd’s four-port
model.  Besides the standard ‘call’, ‘exit’, ‘fail’, and ‘redo’ ports,
Logtalk also defines two post-unification ports, ‘fact’ and ‘rule’, and
an ‘exception’ port.  This tool can also distinguish between
deterministic exits (reported in the ‘exit’ column in the profiling
result tables) and exits that leave choice-points (reported in the
‘*exit’ column).

* Menu:

* API documentation: API documentation<15>.
* Loading: Loading<15>.
* Testing: Testing<13>.
* Compiling source files for port profiling::
* Generating profiling data::
* Printing profiling data reports::
* Interpreting profiling data::
* Profiling Prolog modules::
* Profiling plain Prolog code::
* Known issues: Known issues<8>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<15>,  Next: Loading<15>,  Up: ports_profiler

5.19.1 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#ports-profiler’

For sample queries, please see the ‘SCRIPT.txt’ file in the tool
directory.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<15>,  Next: Testing<13>,  Prev: API documentation<15>,  Up: ports_profiler

5.19.2 Loading
--------------

     | ?- logtalk_load(ports_profiler(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<13>,  Next: Compiling source files for port profiling,  Prev: Loading<15>,  Up: ports_profiler

5.19.3 Testing
--------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ports_profiler(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiling source files for port profiling,  Next: Generating profiling data,  Prev: Testing<13>,  Up: ports_profiler

5.19.4 Compiling source files for port profiling
------------------------------------------------

To compile source files for port profiling, simply compile them in debug
mode and with the ‘source_data’ flag turned on.  For example:

     | ?- logtalk_load(my_source_file, [debug(on), source_data(on)]).

Alternatively, you can also simply turn on the ‘debug’ and ‘source_data’
flags globally before compiling your source files:

     | ?- set_logtalk_flag(debug, on), set_logtalk_flag(source_data, on).

Be aware, however, that loader files (e.g., library loader files) may
override the default flag values, and thus the loaded files may not be
compiled in debug mode.  In this case, you will need to modify the
loader files themselves.


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating profiling data,  Next: Printing profiling data reports,  Prev: Compiling source files for port profiling,  Up: ports_profiler

5.19.5 Generating profiling data
--------------------------------

After loading this tool and compiling the source files that you want to
profile in debug mode, simply call the ‘ports_profiler::start’ goal
followed by the goals to be profiled.  Use the ‘ports_profiler::stop’
goal to stop profiling.

Note that the ‘ports_profiler::start/0’ predicate implicitly selects the
‘ports_profiler’ tool as the active debug handler.  If you have
additional debug handlers loaded (e.g., the ‘debugger’ tool), those
would no longer be active (there can be only one active debug handler at
any given time).


File: TheLogtalkHandbook-3.100.1.info,  Node: Printing profiling data reports,  Next: Interpreting profiling data,  Prev: Generating profiling data,  Up: ports_profiler

5.19.6 Printing profiling data reports
--------------------------------------

After calling the goals that you want to profile, you can print a table
with all profile data by typing:

     | ?- ports_profiler::data.

To print a table with data for a single entity, use the query:

     | ?- ports_profiler::data(Entity).

To print a table with data for a single entity predicate, use the query:

     | ?- ports_profiler::data(Entity, Predicate).

In this case, the second argument must be either a predicate indicator,
‘Name/Arity’, or a non-terminal indicator, ‘Name//Arity’.

The profiling data can be reset using the query:

     | ?- ports_profiler::reset.

To reset only the data for a specific entity, use the query:

     | ?- ports_profiler::reset(Entity).

To illustrate the tool output, consider the ‘family’ example in the
Logtalk distribution:

     | ?- {ports_profiler(loader)}.
     ...
     yes

     | ?- set_logtalk_flag(debug, on).
     yes

     | ?- logtalk_load(family(loader)).
     ...
     yes

     | ?- ports_profiler::start.
     yes

     | ?- addams::sister(Sister, Sibling).
     Sister = wednesday,
     Sibling = pubert ;
     Sister = wednesday,
     Sibling = pugsley ;
     Sister = wednesday,
     Sibling = pubert ;
     Sister = wednesday,
     Sibling = pugsley ;
     no

     | ?- ports_profiler::data.
     ----------------------------------------------------------------------
     Entity     Predicate    Fact  Rule  Call  Exit *Exit  Fail  Redo Error
     ----------------------------------------------------------------------
     addams     female/1        2     0     1     1     1     0     1     0
     addams     parent/2        8     0     4     3     5     1     5     0
     relations  sister/2        0     1     1     0     4     1     4     0
     ----------------------------------------------------------------------
     yes

     | ?- ports_profiler::data(addams).
     -----------------------------------------------------------
     Predicate    Fact  Rule  Call  Exit *Exit  Fail  Redo Error
     -----------------------------------------------------------
     female/1        2     0     1     1     1     0     1     0
     parent/2        8     0     4     3     5     1     5     0
     -----------------------------------------------------------
     yes

     | ?- ports_profiler::data(addams, parent/2).
     -------------
     Clause  Count
     -------------
          1      1
          2      1
          3      2
          4      1
          5      1
          6      2
     -------------
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Interpreting profiling data,  Next: Profiling Prolog modules,  Prev: Printing profiling data reports,  Up: ports_profiler

5.19.7 Interpreting profiling data
----------------------------------

Some useful information that can be inferred from the profiling data
include:

   - which predicates are called more often (from the ‘call’ port)

   - unexpected failures (from the ‘fail’ port)

   - unwanted non-determinism (from the ‘*exit’ port)

   - performance issues due to backtracking (from the ‘*exit’ and ‘redo’
     ports)

   - predicates acting like a generator of possible solutions (from the
     ‘*exit’ and ‘redo’ ports)

   - inefficient indexing of predicate clauses (from the ‘fact’, ‘rule’,
     and ‘call’ ports)

   - clauses that are never used or seldom used

The profiling data should be analyzed by taking into account the
expected behavior for the profiled predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Profiling Prolog modules,  Next: Profiling plain Prolog code,  Prev: Interpreting profiling data,  Up: ports_profiler

5.19.8 Profiling Prolog modules
-------------------------------

This tool can also be applied to Prolog modules that Logtalk is able to
compile as objects.  For example, if the Prolog module file is named
‘module.pl’, try:

     | ?- logtalk_load(module, [debug(on), source_data(on)]).

Due to the lack of standardization of module systems and the abundance
of proprietary extensions, this solution is not expected to work for all
cases.


File: TheLogtalkHandbook-3.100.1.info,  Node: Profiling plain Prolog code,  Next: Known issues<8>,  Prev: Profiling Prolog modules,  Up: ports_profiler

5.19.9 Profiling plain Prolog code
----------------------------------

This tool can also be applied to plain Prolog code.  For example, if the
Prolog file is named ‘code.pl’, simply define an object including its
code and declaring as public any predicates that you want to use as
messages to the object.  For example:

     :- object(code).

         :- public(foo/2).
         :- include('code.pl').

     :- end_object.

Save the object to an e.g.  ‘code.lgt’ file in the same directory as the
Prolog file and then load it in debug mode:

     | ?- logtalk_load(code, [debug(on), source_data(on)]).

In alternative, use the ‘object_wrapper_hook’ provided by the
‘hook_objects’ library:

     | ?- logtalk_load(hook_objects(loader)).
     ...

     | ?- logtalk_load(
              code,
              [hook(object_wrapper_hook), debug(on),
               source_data(on), context_switching_calls(allow)]
          ).

In this second alternative, you can then use the ‘(<<)/2’ context switch
control construct to call the wrapped predicates.  E.g.

     | ?- code<<foo(X, Y).

With either wrapping solution, pay special attention to any compilation
warnings that may signal issues that could prevent the plain Prolog code
from working as-is when wrapped by an object.  Often any required
changes are straightforward (e.g., adding ‘use_module/2’ directives for
called module library predicates).


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<8>,  Prev: Profiling plain Prolog code,  Up: ports_profiler

5.19.10 Known issues
--------------------

Determinism information is currently not available when using Quintus
Prolog as the backend compiler.


File: TheLogtalkHandbook-3.100.1.info,  Node: profiler,  Next: sarif,  Prev: ports_profiler,  Up: Developer Tools

5.20 ‘profiler’
===============

This tool contains simple wrappers for selected Prolog profiler tools.

* Menu:

* Loading: Loading<16>.
* Testing: Testing<14>.
* Supported backend Prolog compilers::
* Compiling source code for profiling::


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<16>,  Next: Testing<14>,  Up: profiler

5.20.1 Loading
--------------

This tool can be loaded using the query:

     ?- logtalk_load(profiler(loader)).

For sample queries, please see the ‘SCRIPT.txt’ file in the tool
directory.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<14>,  Next: Supported backend Prolog compilers,  Prev: Loading<16>,  Up: profiler

5.20.2 Testing
--------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(profiler(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported backend Prolog compilers,  Next: Compiling source code for profiling,  Prev: Testing<14>,  Up: profiler

5.20.3 Supported backend Prolog compilers
-----------------------------------------

Currently, this tool supports the profilers provided with SICStus Prolog
4, SWI-Prolog, and YAP. The tool includes two files:

   - 
          ‘yap_profiler.lgt’
          simple wrapper for the YAP count profiler

   - 
          ‘sicstus_profiler.lgt’
          simple wrapper for the SICStus Prolog 4 profiler

Logtalk also supports the YAP tick profiler (using the latest YAP
development version) and the SWI-Prolog XPCE profiler.  When using the
XPCE profiler, you can avoid profiling the Logtalk compiler (which is
invoked, e.g., when you use the ‘(::)/2’ message-sending operator at the
top-level interpreter) by compiling your code with the ‘optimize’ flag
turned on:

     ?- set_logtalk_flag(optimize, on).
     true.

     ?- use_module(library(statistics)).
     true.

     ?- profile(... :: ...).
     ...

Given that ‘prolog_statistics:profile/1’ is a meta-predicate, Logtalk
will compile its argument before calling it thanks to the
‘goal_expansion/2’ hook predicate definitions in the adapter file.
Without this hook definition, you would need to use instead (to avoid
profiling the compiler itself):

     ?- logtalk << (prolog_statistics:profile(... :: ...)).
     ...

In either case, don’t forget, however, to load the ‘prolog_statistics’
module 'before' using or compiling calls to the ‘profile/1’ to allow the
Logtalk compiler to access its meta-predicate template.

The profiler support attempts to conceal internal Logtalk
compiler/runtime predicates and the generated entity predicates that
implement predicate inheritance.  Calls to internal compiler and runtime
predicates have functors starting with ‘$lgt_’.  Calls to predicates
with functors such as ‘_def’, ‘_dcl’, or ‘_super’, used to implement
inheritance, may still be listed in a few cases.  Note that the time and
the number of calls/redos of concealed predicates are added to the
caller predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Compiling source code for profiling,  Prev: Supported backend Prolog compilers,  Up: profiler

5.20.4 Compiling source code for profiling
------------------------------------------

To get the user-level object and predicate names instead of the
compiler-generated internal names when using the SWI-Prolog and YAP
profilers, you must set ‘code_prefix’ flag to a character other than the
default ‘$’ before compiling your source code.  For example:

     ?- set_logtalk_flag(code_prefix, '.').

See also the ‘samples/settings-sample.lgt’ file for automating the
necessary setup at Logtalk startup.


File: TheLogtalkHandbook-3.100.1.info,  Node: sarif,  Next: sbom,  Prev: profiler,  Up: Developer Tools

5.21 ‘sarif’
============

The ‘sarif’ tool serializes diagnostics produced by tools implementing
the ‘tool_diagnostics_protocol’ protocol into SARIF 2.1.0 reports.

* Menu:

* API documentation: API documentation<16>.
* Loading: Loading<17>.
* Testing: Testing<15>.
* Usage: Usage<10>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<16>,  Next: Loading<17>,  Up: sarif

5.21.1 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#sarif’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<17>,  Next: Testing<15>,  Prev: API documentation<16>,  Up: sarif

5.21.2 Loading
--------------

Load the tool using:

     | ?- logtalk_load(sarif(loader)).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<15>,  Next: Usage<10>,  Prev: Loading<17>,  Up: sarif

5.21.3 Testing
--------------

To test this tool, load the ‘tester.lgt’ file:

     | ?- logtalk_load(sarif(tester)).

The test suite validates SARIF generation for single diagnostics
producers and explicit aggregate reports, including JSON Schema
validation against the SARIF 2.1.0 schema.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<10>,  Prev: Testing<15>,  Up: sarif

5.21.4 Usage
------------

Use the ‘term/4’ and ‘generate/4’ predicates to generate a report for a
single diagnostics producer, target, and options combination.  These
predicates generate a SARIF document with a single run.

For example:

     | ?- sarif::generate(dead_code_scanner, entity(my_object), file('./report.sarif'), []).
     true.

Use the ‘term/2’ and ‘generate/2’ predicates to generate an explicit
aggregate report from a list of specifications.  Each specification must
be a ‘tool_spec(Tool, Target, Options)’ term and produces a single SARIF
run.  Runs are emitted in the same order as the specifications list.

For example:

     | ?- sarif::generate([
              tool_spec(linter_reporter, all, []),
              tool_spec(dead_code_scanner, entity(my_object), [])
          ], file('./aggregate.sarif')).
     true.

Each specification uses the same target and options accepted by the
corresponding diagnostics producer.  The aggregate API is explicit: the
‘sarif’ tool does not infer producers or merge options across
specifications.


File: TheLogtalkHandbook-3.100.1.info,  Node: sbom,  Next: tool_diagnostics,  Prev: sarif,  Up: Developer Tools

5.22 ‘sbom’
===========

This tool generates a Software Bill of Materials (SBOM) for an
application, exported as a JSON file in either the ISO/IEC 5962:2021
standard SPDX 2.3 JSON format or the CycloneDX 1.6 JSON format:

‘https://www.iso.org/standard/81870.html’

‘https://cyclonedx.org/specification/overview/’

* Menu:

* API documentation: API documentation<17>.
* Loading: Loading<18>.
* Testing: Testing<16>.
* Usage: Usage<11>.
* Known issues: Known issues<9>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<17>,  Next: Loading<18>,  Up: sbom

5.22.1 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#sbom’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<18>,  Next: Testing<16>,  Prev: API documentation<17>,  Up: sbom

5.22.2 Loading
--------------

This tool can be loaded using the query:

     | ?- logtalk_load(sbom(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<16>,  Next: Usage<11>,  Prev: Loading<18>,  Up: sbom

5.22.3 Testing
--------------

To run the tool tests, use the query:

     | ?- logtalk_load(sbom(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<11>,  Next: Known issues<9>,  Prev: Testing<16>,  Up: sbom

5.22.4 Usage
------------

The tool inspects the current Logtalk session and generates a JSON SBOM
document describing:

   - the loaded application

   - the Logtalk version

   - the backend Prolog system and version

   - the installed packs that contributed loaded files to the current
     session

When exactly one loaded object conforms to the ‘application_protocol’
protocol from the ‘application’ library, the tool also uses that object
as the default source for application metadata.  If no conforming object
exists, or if multiple conforming objects are loaded, the tool falls
back to the explicit ‘sbom’ options and built-in defaults.

For single-value application metadata such as ‘name/1’, ‘version/1’,
‘license/1’, ‘built_date/1’, ‘release_date/1’, ‘valid_until_date/1’,
‘supplier/1’, and ‘originator/1’, explicit ‘sbom’ options override the
values declared by the application object.  For ‘creators/1’, explicit
‘creators/1’ options override the application object creators list.
Application external references declared by the object are combined with
any ‘application_external_reference/2’ options.

For CycloneDX exports, the generated BOM also includes a ‘serialNumber’
and records the Logtalk ‘sbom’ generator itself under
‘metadata.tools.components’.  The BOM document license is exported as
‘metadata.licenses’ with the SPDX identifier ‘CC0-1.0’.  The CycloneDX
BOM itself also exports top-level ‘externalReferences’ for the Logtalk
website and the Logtalk git repository.

   - ‘bom_external_reference(Type, URL)’ Adds a top-level CycloneDX
     ‘externalReferences’ entry to the generated BOM. This option is
     ignored for SPDX exports.  It can be repeated to export multiple
     references.  The built-in Logtalk website and git repository
     references are still exported by default.  Runtime components are
     exported with explicit CycloneDX ‘scope’ ‘required’, while the
     ‘sbom’ generator listed under ‘metadata.tools.components’ is
     exported with ‘scope’ ‘excluded’.  When available from existing
     metadata, CycloneDX components also export ‘externalReferences’:
     Logtalk and the ‘sbom’ tool export a website reference, the backend
     component exports a website reference from the bundled backend
     table, and loaded packs export their ‘home/1’ and version source
     URL values as website and distribution references.  For SPDX
     exports, the default ‘creationInfo.creators’ entry is a versioned
     tool identifier derived from the ‘sbom’ tool version.  When URL
     metadata is available, SPDX packages also export ‘externalRefs’:
     the Logtalk and backend packages export website references, loaded
     packs export website and distribution references, and
     ‘application_external_reference/2’ options are mapped to SPDX
     package external references for the application package.

The public predicates are:

   - ‘document/1’

   - ‘document/2’

   - ‘export/1’

   - ‘export/2’

The ‘document/1-2’ predicates return a JSON term.  The ‘export/1-2’
predicates write the JSON document to any sink accepted by the
‘json::generate/2’ predicate, including ‘atom(Atom)’ and ‘file(Path)’.
Follows the list of supported options.

Global/application options:

   - ‘name(Name)’ Sets the application name.  Exported as the SPDX
     application package name and as the CycloneDX
     ‘metadata.component.name’.  When exactly one object conforming to
     ‘application_protocol’ is loaded and declares ‘name/1’, that value
     is used by default.  Otherwise, the default is
     ‘loaded-application’.

   - ‘format(Format)’ Selects the export format.  Possible values are
     ‘spdx’ and ‘cyclonedx’.  Default is ‘spdx’.

   - ‘version(Version)’ Sets the application version.  Exported as the
     SPDX application package ‘versionInfo’ and as the CycloneDX
     ‘metadata.component.version’.  When exactly one object conforming
     to ‘application_protocol’ is loaded and declares ‘version/1’, that
     value is used by default.  Otherwise, the default is ‘0.0.0’.

   - ‘application_license(License)’ Sets the application license.
     Exported as the SPDX application package ‘licenseConcluded’ and
     ‘licenseDeclared’ fields and, unless the value is ‘NOASSERTION’, as
     the CycloneDX ‘metadata.component.licenses’ entry, using
     ‘license.id’ for SPDX license identifiers, ‘expression’ for SPDX
     license expressions, and ‘license.name’ otherwise.  When exactly
     one object conforming to ‘application_protocol’ is loaded and
     declares ‘license/1’, that value is used by default.  Otherwise,
     the default is ‘NOASSERTION’.

   - ‘application_built_date(Date)’ Sets the application build date.
     Exported as the SPDX application package ‘builtDate’ field and as
     the CycloneDX custom property ‘logtalk:sbom:built_date’.  When
     exactly one object conforming to ‘application_protocol’ is loaded
     and declares ‘built_date/1’, that value is used by default.
     Otherwise, the default is not exporting this information.

   - ‘application_release_date(Date)’ Sets the application release date.
     Exported as the SPDX application package ‘releaseDate’ field and as
     the CycloneDX custom property ‘logtalk:sbom:release_date’.  When
     exactly one object conforming to ‘application_protocol’ is loaded
     and declares ‘release_date/1’, that value is used by default.
     Otherwise, the default is not exporting this information.

   - ‘application_valid_until_date(Date)’ Sets the application validity
     limit date.  Exported as the SPDX application package
     ‘validUntilDate’ field and as the CycloneDX custom property
     ‘logtalk:sbom:valid_until_date’.  When exactly one object
     conforming to ‘application_protocol’ is loaded and declares
     ‘valid_until_date/1’, that value is used by default.  Otherwise,
     the default is not exporting this information.

   - ‘application_supplier(Supplier)’ Sets the application supplier.
     Exported as the SPDX application package ‘supplier’ field.  For
     CycloneDX, exported as ‘metadata.component.supplier’ when using the
     ‘Organization: Name’ convention and also as the custom property
     ‘logtalk:sbom:supplier’.  When exactly one object conforming to
     ‘application_protocol’ is loaded and declares ‘supplier/1’, that
     value is used by default.  Otherwise, the default is not exporting
     this information.

   - ‘application_originator(Originator)’ Sets the application
     originator.  Exported as the SPDX application package ‘originator’
     field.  For CycloneDX, exported as
     ‘metadata.component.manufacturer’ when using the ‘Organization:
     Name’ convention, or as ‘metadata.component.authors’ when using the
     ‘Person: Name’ convention, and also as the custom property
     ‘logtalk:sbom:originator’.  When exactly one object conforming to
     ‘application_protocol’ is loaded and declares ‘originator/1’, that
     value is used by default.  Otherwise, the default is not exporting
     this information.

   - ‘application_external_reference(Type, Locator)’ Adds application
     reference metadata.  For SPDX exports, this becomes an application
     package ‘externalRefs’ entry.  For CycloneDX exports, URL-based
     references are exported under
     ‘metadata.component.externalReferences’, while package and
     provenance identifiers use the dedicated component identity fields.
     This option can be repeated to export multiple references.  When
     exactly one object conforming to ‘application_protocol’ is loaded,
     its declared ‘external_reference/2’ metadata is also exported.  The
     ‘homepage/1’, ‘distribution/1’, ‘package/1’, ‘repository/1’,
     ‘git_object_identifier/1’, and ‘software_heritage_identifier/1’
     predicates are mapped to ‘website’, ‘distribution’, ‘purl’, ‘vcs’,
     ‘gitoid’, and ‘swh’ SBOM reference types, respectively.  SPDX
     categories are inferred from the reference type, with ‘purl’
     exported under ‘PACKAGE-MANAGER’ and ‘gitoid’ and ‘swh’ exported
     under ‘PERSISTENT-ID’.  For CycloneDX exports, ‘purl’ is written to
     ‘metadata.component.purl’, ‘gitoid’ values to
     ‘metadata.component.omniborId’, and ‘swh’ values to
     ‘metadata.component.swhid’.

   - ‘namespace(Namespace)’ Sets the base document namespace URI. A
     process and timestamp suffix is added automatically to guarantee
     uniqueness.  This option only applies to SPDX exports
     (‘documentNamespace’) and is ignored for CycloneDX exports.
     Default is ‘https://logtalk.org/spdxdocs/logtalk-sbom’.

   - ‘creators(Creators)’ Adds all atoms in the list ‘Creators’ to the
     SPDX ‘creationInfo.creators’ list and the CycloneDX
     ‘metadata.authors’ list.  When no creator option is provided, and
     exactly one object conforming to ‘application_protocol’ is loaded
     with a declared ‘creators/1’ predicate, that list is used.
     Otherwise, the default for SPDX exports is the versioned tool
     identifier ‘Tool: Logtalk SBOM generator-<version>’ and the default
     for CycloneDX exports is ‘Logtalk SBOM generator’.

   - ‘validate_export(Boolean)’ When ‘true’, validates the generated
     document against the bundled schema for the selected format before
     exporting it.  Default is ‘false’.

Logtalk options:

   - ‘logtalk_license(License)’ Sets the Logtalk component license.
     Exported as the SPDX Logtalk package ‘licenseConcluded’ and
     ‘licenseDeclared’ fields and, unless the value is ‘NOASSERTION’, as
     the CycloneDX component ‘licenses’ entry, using ‘license.id’ for
     SPDX license identifiers, ‘expression’ for SPDX license
     expressions, and ‘license.name’ otherwise.  Default is
     ‘Apache-2.0’.

   - ‘logtalk_built_date(Date)’ Sets the Logtalk build date.  Exported
     as the SPDX Logtalk package ‘builtDate’ field and as the CycloneDX
     custom property ‘logtalk:sbom:built_date’.  Default is not
     exporting this information.

   - ‘logtalk_release_date(Date)’ Sets the Logtalk release date.
     Exported as the SPDX Logtalk package ‘releaseDate’ field and as the
     CycloneDX custom property ‘logtalk:sbom:release_date’.  Default is
     not exporting this information.

   - ‘logtalk_valid_until_date(Date)’ Sets the Logtalk validity limit
     date.  Exported as the SPDX Logtalk package ‘validUntilDate’ field
     and as the CycloneDX custom property
     ‘logtalk:sbom:valid_until_date’.  Default is not exporting this
     information.

   - ‘logtalk_supplier(Supplier)’ Sets the Logtalk supplier.  Exported
     as the SPDX Logtalk package ‘supplier’ field.  For CycloneDX,
     exported as the component ‘supplier’ when using the ‘Organization:
     Name’ convention and also as the custom property
     ‘logtalk:sbom:supplier’.  Default is not exporting this
     information.

   - ‘logtalk_originator(Originator)’ Sets the Logtalk originator.
     Exported as the SPDX Logtalk package ‘originator’ field.  For
     CycloneDX, exported as the component ‘manufacturer’ or ‘authors’
     entry, depending on the value convention, and also as the custom
     property ‘logtalk:sbom:originator’.  Default is not exporting this
     information.

Backend options:

   - ‘backend_license(License)’ Sets the backend component license.
     Exported as the SPDX backend package ‘licenseConcluded’ and
     ‘licenseDeclared’ fields and, unless the value is ‘NOASSERTION’, as
     the CycloneDX component ‘licenses’ entry, using ‘license.id’ for
     SPDX license identifiers, ‘expression’ for SPDX license
     expressions, and ‘license.name’ otherwise.  Default is the license
     specified in the ‘backend/3’ table.

   - ‘backend_built_date(Date)’ Sets the backend build date.  Exported
     as the SPDX backend package ‘builtDate’ field and as the CycloneDX
     custom property ‘logtalk:sbom:built_date’.  Default is not
     exporting this information.

   - ‘backend_release_date(Date)’ Sets the backend release date.
     Exported as the SPDX backend package ‘releaseDate’ field and as the
     CycloneDX custom property ‘logtalk:sbom:release_date’.  Default is
     not exporting this information.

   - ‘backend_valid_until_date(Date)’ Sets the backend validity limit
     date.  Exported as the SPDX backend package ‘validUntilDate’ field
     and as the CycloneDX custom property
     ‘logtalk:sbom:valid_until_date’.  Default is not exporting this
     information.

   - ‘backend_supplier(Supplier)’ Sets the backend supplier.  Exported
     as the SPDX backend package ‘supplier’ field.  For CycloneDX,
     exported as the component ‘supplier’ when using the ‘Organization:
     Name’ convention and also as the custom property
     ‘logtalk:sbom:supplier’.  Default is not exporting this
     information.

   - ‘backend_originator(Originator)’ Sets the backend originator.
     Exported as the SPDX backend package ‘originator’ field.  For
     CycloneDX, exported as the component ‘manufacturer’ or ‘authors’
     entry, depending on the value convention, and also as the custom
     property ‘logtalk:sbom:originator’.  Default is not exporting this
     information.

Pack options:

   - ‘pack_license(Pack, License)’ Sets the license for a loaded pack
     named ‘Pack’.  Exported as the SPDX pack package ‘licenseConcluded’
     and ‘licenseDeclared’ fields and, unless the value is
     ‘NOASSERTION’, as the CycloneDX component ‘licenses’ entry, using
     ‘license.id’ for SPDX license identifiers, ‘expression’ for SPDX
     license expressions, and ‘license.name’ otherwise.  Default for
     packs without an explicit option is the result of sending the pack
     specification object the message ‘license(License)’, falling back
     to ‘NOASSERTION’ when no license is available.  Loaded packs also
     export a SPDX package ‘downloadLocation’ from the pack
     specification ‘version/6’ third argument and, when available, a
     SPDX ‘homepage’ from the pack specification ‘home/1’ predicate.
     Pack ‘home/1’ and ‘version/6’ URLs are also exported as SPDX
     package ‘externalRefs’ with ‘website’ and ‘distribution’
     ‘referenceType’ values.  Pack checksums are exported as SPDX
     package checksums and CycloneDX component hashes when the pack
     specification defines them in the ‘version/6’ predicate fourth
     argument.

   - ‘pack_built_date(Pack, Date)’ Sets the build date for the loaded
     pack named ‘Pack’.  Exported as the SPDX pack package ‘builtDate’
     field and as the CycloneDX custom property
     ‘logtalk:sbom:built_date’.  Default is not exporting this
     information.

   - ‘pack_release_date(Pack, Date)’ Sets the release date for the
     loaded pack named ‘Pack’.  Exported as the SPDX pack package
     ‘releaseDate’ field and as the CycloneDX custom property
     ‘logtalk:sbom:release_date’.  Default is not exporting this
     information.

   - ‘pack_valid_until_date(Pack, Date)’ Sets the validity limit date
     for the loaded pack named ‘Pack’.  Exported as the SPDX pack
     package ‘validUntilDate’ field and as the CycloneDX custom property
     ‘logtalk:sbom:valid_until_date’.  Default is not exporting this
     information.

   - ‘pack_supplier(Pack, Supplier)’ Sets the supplier for the loaded
     pack named ‘Pack’.  Exported as the SPDX pack package ‘supplier’
     field.  For CycloneDX, exported as the component ‘supplier’ when
     using the ‘Organization: Name’ convention and also as the custom
     property ‘logtalk:sbom:supplier’.  Default is not exporting this
     information.

   - ‘pack_originator(Pack, Originator)’ Sets the originator for the
     loaded pack named ‘Pack’.  Exported as the SPDX pack package
     ‘originator’ field.  For CycloneDX, exported as the component
     ‘manufacturer’ or ‘authors’ entry, depending on the value
     convention, and also as the custom property
     ‘logtalk:sbom:originator’.  Default is not exporting this
     information.

Examples:

     | ?- sbom::document(Document).

     | ?- sbom::document(Document, [name(my_app), version('1.2.3')]).

     | ?- sbom::export(file('sbom.spdx.json')).

     | ?- sbom::export(file('sbom.cdx.json'), [format(cdx)]).

     | ?- sbom::export(atom(Atom), [
             format(cdx),
             name(my_app),
             version('1.2.3'),
             application_license('MIT'),
             logtalk_license('Apache-2.0'),
             backend_license('BSD-2-Clause'),
             application_built_date('2026-03-23T00:00:00Z'),
             application_release_date('2026-03-23T00:00:00Z'),
             application_valid_until_date('2027-03-23T00:00:00Z'),
             application_supplier('Organization: Example Application'),
             application_originator('Person: Application Maintainer'),
             bom_external_reference(documentation, 'https://example.com/my_app/sbom'),
             application_external_reference(website, 'https://example.com/my_app'),
             application_external_reference(vcs, 'https://example.com/my_app.git'),
             logtalk_supplier('Organization: Logtalk.org'),
             backend_supplier('Organization: Backend Vendor'),
             pack_license(my_pack, 'MIT'),
             pack_supplier(my_pack, 'Organization: Pack Maintainer'),
             creators(['Tool: My build pipeline', 'Person: Release Manager', 'Organization: Example, Inc.']),
             validate_export(true)
          ]).

Use the ‘.spdx.json’ extension for SPDX exports and the ‘.cdx.json’
extension for CycloneDX exports.

See the ‘sbom-example.spdx.json’ file for a representative SPDX export.
See the ‘sbom-example.cdx.json’ file for a representative CycloneDX
export.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<9>,  Prev: Usage<11>,  Up: sbom

5.22.5 Known issues
-------------------

The ECLiPSe and GNU Prolog backends fail several ‘sbom’ tests and cannot
be used for CycloneDX exports.  The root cause is that both backends are
limited to the US-ASCII charset, which prevents processing the
SPDX/CycloneDX schema data required for CycloneDX license validation and
export validation.


File: TheLogtalkHandbook-3.100.1.info,  Node: tool_diagnostics,  Next: tutor,  Prev: sbom,  Up: Developer Tools

5.23 ‘tool_diagnostics’
=======================

This tool provides the shared ‘tool_diagnostics_protocol’ protocol and
the ‘tool_diagnostics_common’ category used by developer tools such as
‘dead_code_scanner’, ‘lgtdoc’, ‘lgtunit’, and ‘linter_reporter’ to
expose machine-readable diagnostics.

The protocol is designed so that producer tools can keep their own
internal semantics while still providing a common interface for querying
diagnostics directly or for generating SARIF reports using the ‘sarif’
tool.

* Menu:

* API documentation: API documentation<18>.
* Loading: Loading<19>.
* Protocol overview::
* Term conventions::
* Usage: Usage<12>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<18>,  Next: Loading<19>,  Up: tool_diagnostics

5.23.1 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#tool_diagnostics_protocol’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<19>,  Next: Protocol overview,  Prev: API documentation<18>,  Up: tool_diagnostics

5.23.2 Loading
--------------

Load the protocol and common category definitions using:

     | ?- logtalk_load(tool_diagnostics(loader)).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol overview,  Next: Term conventions,  Prev: Loading<19>,  Up: tool_diagnostics

5.23.3 Protocol overview
------------------------

The protocol defines predicates for reporting:

   - tool metadata using ‘diagnostics_tool/5’

   - supported target patterns using ‘diagnostic_target/1’

   - rule descriptors using ‘diagnostic_rule/5’ and ‘diagnostic_rules/1’

   - diagnostics using ‘diagnostic/2-3’ and ‘diagnostics/2-3’

   - summaries using ‘diagnostics_summary/2-3’

   - preflight issues using ‘diagnostics_preflight/2-3’

Common target terms include ‘all’, ‘file(File)’, ‘directory(Directory)’,
‘rdirectory(Directory)’, ‘library(Library)’, ‘rlibrary(Library)’,
‘entity(Entity)’, and ‘tests(Object)’.

Predicates taking an ‘Options’ argument must accept the common option
‘explanations(Boolean)’.  Tools may use it to include
‘explanation(Text)’ properties when available, but implementations that
do not provide additional explanation text must still accept the option
as a no-op.


File: TheLogtalkHandbook-3.100.1.info,  Node: Term conventions,  Next: Usage<12>,  Prev: Protocol overview,  Up: tool_diagnostics

5.23.4 Term conventions
-----------------------

Tool metadata uses terms of the form:

     diagnostics_tool(Id, Name, Version, InformationURI, Properties)

The ‘Id’ and ‘Name’ arguments identify the tool.  The ‘Version’ argument
should be derived reflectively from the implementing object ‘info/1’
metadata using ‘object_property/2’ instead of being hardcoded.  The
‘InformationURI’ argument is a stable tool home or documentation URI and
is exported by the ‘sarif’ tool as the SARIF
‘tool.driver.informationUri’ value.

The ‘Properties’ list is intended for exporter and post-processing
hints.  The current ‘sarif’ tool interprets the following entries:

   - ‘guid(Guid)’ sets the SARIF ‘tool.driver.guid’ value when present.

   - ‘fingerprint_algorithm(Algorithm)’ sets the exported run
     ‘fingerprintAlgorithm’ property and selects the canonical result
     fingerprint key.  The current implementation distinguishes
     ‘canonical_finding_v1’ from the default warning-oriented path and
     computes result identities from normalized relative locations
     instead of raw absolute file paths.

   - ‘automation_id(target)’ requests that the SARIF
     ‘run.automationDetails.id’ value be derived from the queried target
     term, allowing different targets of the same tool to produce
     distinct run identities.

   - ‘automation_id(tool)’ denotes a tool-scoped automation identifier.
     In the current ‘sarif’ implementation this is redundant because
     omitting ‘automation_id(target)’ already falls back to the tool
     identifier.

   - ‘include_invocations(true)’ requests a SARIF ‘invocations’ section,
     including ‘toolExecutionNotifications’ when preflight issues exist.

   - ‘include_git_metadata(true)’ requests SARIF ‘gitBranch’ and
     ‘gitCommitHash’ run properties when a stable Git context can be
     inferred.  When this succeeds, the ‘sarif’ tool also normalizes
     artifact locations and fingerprint inputs relative to the
     repository root.  The ‘gitBranch’ value is descriptive metadata;
     the ‘gitCommitHash’ value provides the stable revision identity
     used to disambiguate repository-relative paths.

   - ‘include_version_control_provenance(true)’ requests SARIF
     ‘versionControlProvenance’ data when repository details can be
     inferred from diagnostic file paths.

   - ‘count_key(Key)’ selects the property name used for the exported
     count, e.g.  ‘diagnosticsCount’ or ‘totalWarnings’.

When ‘include_git_metadata(true)’ is not present or a stable Git context
cannot be inferred, the ‘sarif’ tool falls back to
application-root-relative artifact locations and fingerprint inputs
instead.

Rule descriptors use terms of the form:

     diagnostic_rule(RuleId, ShortDescription, FullDescription, DefaultSeverity, Properties)

The ‘diagnostic_rules/1’ predicate should return these descriptors in a
stable order.  Rule descriptor properties may contain terms such as
‘guid(Guid)’, ‘help(Text)’, ‘help_uri(URI)’, ‘tags(Tags)’, and
‘precision(Precision)’.

Diagnostics use terms of the form:

     diagnostic(RuleId, Severity, Confidence, Message, Context, File, Lines, Properties)

The ‘Context’ argument is represented using the term ‘context(Kind,
Identifier)’ where ‘Kind’ is a tool-defined atom such as ‘file’,
‘object’, ‘category’, ‘protocol’, or ‘test_set’.  For file-scoped
diagnostics, ‘Identifier’ is the source file path when available and the
empty atom otherwise.  Diagnostics originating in an included file may
still use an entity context when the ‘include/1’ directive appears
inside that entity; otherwise they are file-scoped.

The ‘File’ argument is a source file path or the empty atom when
unavailable.  The ‘Lines’ argument uses the ‘Start-End’ notation.  The
value ‘0-0’ means that no precise line information is available.

Supported severity values are ‘error’, ‘warning’, and ‘note’.  Supported
confidence values are ‘high’, ‘medium’, ‘low’, and ‘not_applicable’.

The ‘Properties’ argument should include stable structured metadata such
as ‘raw_term(Term)’, ‘explanation(Text)’, ‘flag(Flag)’,
‘directive(Directive)’, ‘indicator(Indicator)’, ‘key(Key)’,
‘test(Test)’, ‘option(Option)’, and any other tool-specific facts useful
for post-processing.

Preflight issues use terms of the form:

     preflight_issue(Id, Severity, Message, Context, File, Lines, Properties)

Preflight issues describe prerequisites or analysis quality issues
instead of findings.

Summaries use terms of the form:

     diagnostics_summary(Target, TotalContexts, TotalDiagnostics, Breakdown, ContextSummaries)

The ‘Breakdown’ argument uses a ‘diagnostic_breakdown(RuleCounts,
SeverityCounts, ConfidenceCounts)’ term and ‘ContextSummaries’ is a list
of ‘context_summary(Context, DiagnosticsCount, Breakdown)’ terms.

Rule counts use ‘rule_count(RuleId, Count)’ terms, severity counts use
‘severity_count(Severity, Count)’ terms, and confidence counts use
‘confidence_count(Confidence, Count)’ terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<12>,  Prev: Term conventions,  Up: tool_diagnostics

5.23.5 Usage
------------

Tools implementing this protocol can be queried directly for diagnostics
after compiling code that results in the production of diagnostics.  For
example:

     | ?- logtalk_load(dead_code_scanner(loader)).
     ...

     | ?- logtalk_load(my_library(loader)).
     ...

     | ?- dead_code_scanner::diagnostics(library(my_library), Diagnostics).
     ...

To serialize diagnostics as SARIF, load the standalone ‘sarif’ tool and
generate a report from a diagnostics producer:

     | ?- logtalk_load(sarif(loader)).
     ...

     | ?- sarif::generate(dead_code_scanner, entity(my_object), file('./report.sarif'), []).
     true.

To generate an explicit aggregate SARIF report with multiple diagnostics
producers, pass a list of ‘tool_spec(Tool, Target, Options)’ terms:

     | ?- sarif::generate([
     |        tool_spec(linter_reporter, all, []),
     |        tool_spec(dead_code_scanner, entity(my_object), [])
     |    ], file('./aggregate.sarif')).
     true.


File: TheLogtalkHandbook-3.100.1.info,  Node: tutor,  Next: wrapper,  Prev: tool_diagnostics,  Up: Developer Tools

5.24 ‘tutor’
============

This tool adds explanations and suggestions for selected warning and
error messages from the compiler/runtime and the developer tools.  It’s
specially useful for new users not yet familiar with the warning and
error messages and looking for advice on how to solve the reported
issues.

* Menu:

* API documentation: API documentation<19>.
* Loading: Loading<20>.
* Usage: Usage<13>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<19>,  Next: Loading<20>,  Up: tutor

5.24.1 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#tutor’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<20>,  Next: Usage<13>,  Prev: API documentation<19>,  Up: tutor

5.24.2 Loading
--------------

This tool can be loaded using the query:

     | ?- logtalk_load(tutor(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<13>,  Prev: Loading<20>,  Up: tutor

5.24.3 Usage
------------

Simply load the tool at startup (e.g., from a settings file).  As an
example, with this tool loaded, instead of terse compiler warnings such
as:

     *     No matching clause for goal: baz(a)
     *       while compiling object main_include_compiler_warning
     *       in file logtalk/examples/errors/include_compiler_warning.lgt between lines 37-38
     *
     *     Duplicated clause: b(one)
     *       first found at or above line 45
     *       while compiling object main_include_compiler_warning
     *       in file logtalk/examples/errors/include_compiler_warning.lgt at or above line 48

the user will get:

     *     No matching clause for goal: baz(a)
     *       while compiling object main_include_compiler_warning
     *       in file logtalk/examples/errors/include_compiler_warning.lgt between lines 37-38
     *     Calls to locally defined predicates without a clause with a matching head
     *     fail. Typo in a predicate argument? Predicate definition incomplete?
     *
     *     Duplicated clause: b(one)
     *       first found at or above line 45
     *       while compiling object main_include_compiler_warning
     *       in file logtalk/examples/errors/include_compiler_warning.lgt at or above line 48
     *     Duplicated clauses are usually a source code editing error and can
     *     result in spurious choice-points, degrading performance. Delete or
     *     correct the duplicated clause to fix this warning.


File: TheLogtalkHandbook-3.100.1.info,  Node: wrapper,  Prev: tutor,  Up: Developer Tools

5.25 ‘wrapper’
==============

This is a prototype tool to help port a plain Prolog application to
Logtalk.  It can also be used to enable applying other Logtalk developer
tools, such as the documenting and diagramming tools, to plain Prolog
code.

The tool takes a directory of Prolog files or a list of Prolog files,
loads and wraps the code in each file using an object wrapper, and
advises on missing directives to be added to those objects by using the
compiler lint checker and the reflection API. The user can then either
save the generated wrapper objects or copy and paste the printed advice
into the Prolog files (updating them to Logtalk files by adding the
object opening and closing directives to the Prolog files).  The wrapper
objects use ‘include/1’ directives to include the Prolog files and can
be loaded for testing and for use with other tools.  The wrapped Prolog
files are not modified and thus require only read permission.

* Menu:

* API documentation: API documentation<20>.
* Loading: Loading<21>.
* Workflows::
* Customization: Customization<3>.
* Current limitations::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<20>,  Next: Loading<21>,  Up: wrapper

5.25.1 API documentation
------------------------

This tool API documentation is available at:

‘../../apis/library_index.html#wrapper’


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<21>,  Next: Workflows,  Prev: API documentation<20>,  Up: wrapper

5.25.2 Loading
--------------

This tool can be loaded using the query:

     | ?- logtalk_load(wrapper(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Workflows,  Next: Customization<3>,  Prev: Loading<21>,  Up: wrapper

5.25.3 Workflows
----------------

The typical porting workflow is:

     | ?- wrapper::rdirectory(root_directory_of_prolog_code).
     ...
     | ?- wrapper::save.
     ...

See the next section on how to customize the API calls for more flexible
processing.


File: TheLogtalkHandbook-3.100.1.info,  Node: Customization<3>,  Next: Current limitations,  Prev: Workflows,  Up: wrapper

5.25.4 Customization
--------------------

The tool can be customized by extending the ‘wrapper’ object.  A common
scenario is when wrapping plain Prolog code just to take advantage, for
example, of the documenting tool or for generating cross-referencing
diagrams.  In this case, we can workaround any compiler errors by
specializing the inherited definitions for the ‘term_expansion/2’ and
‘goal_expansion/2’ predicates and then load the wrapper objects for
further processing by using the ‘include_wrapped_files(false)’ option
described below.

The API predicates also accept a set of options for customization:

   - 
          ‘prolog_extensions(Extensions)’
          list of file name extensions used to recognize Prolog source files (default is ‘['.pl', '.pro', '.prolog']’)

   - 
          ‘logtalk_extension(Extension)’
          Logtalk file name extension to be used for the generated wrapper files (default is ‘'.lgt'’)

   - 
          ‘exclude_files(Files)’
          list of Prolog source files to exclude (default is ‘[]’)

   - 
          ‘exclude_directories(Directories)’
          list of sub-directories to exclude (default is ‘[]’)

   - 
          ‘include_wrapped_files(Boolean)’
          generate ‘include/1’ directives for the wrapped Prolog source files (default is ‘true’)

The use, by default, of ‘include/1’ directives to wrap the code in
Prolog source files facilitates running in parallel the Logtalk port and
the original Prolog code.  This is specially useful when the Prolog code
being ported lacks a comprehensive set of tests that could be adapted to
verify the Logtalk port.  The generated Logtalk files can also take
advantage of ‘uses/2’ directives, including predicate aliases and
predicate shorthands to minimize the changes to the original Prolog code
and help verify if replacement calls to Logtalk library predicates
provide the same semantics as the original calls.


File: TheLogtalkHandbook-3.100.1.info,  Node: Current limitations,  Prev: Customization<3>,  Up: wrapper

5.25.5 Current limitations
--------------------------

   - The tool cannot deal with syntax errors in the Prolog files.  These
     errors usually occur when using a backend Prolog system different
     from the one used to compile the original plain Prolog code.  A
     common cause of syntax errors is operator definitions.  These can
     often be solved by defining those operators for the Prolog backend
     used to run Logtalk and this tool.  An alternative is to preload
     the Prolog files where those operators are declared.  Preloading
     the plain Prolog application can also help in wrapping it by
     ensuring that its dependencies are also loaded.

   - The tool assumes that all files to be wrapped have different names
     (even if found in different directories).  If that is not the case,
     the name conflicts must be manually solved before using the tool.

   - There’s only preliminary support for dealing with meta-predicates
     and advise on missing meta-predicate directives.


File: TheLogtalkHandbook-3.100.1.info,  Node: Libraries,  Next: Ports,  Prev: Developer Tools,  Up: Top

6 Libraries
***********

The documentation of each library can also be found in the library
directory in the ‘NOTES.md’ file.

* Menu:

* Overview: Overview<2>.
* adaptive_boosting_classifier::
* agglomerative_clusterer::
* amqp::
* anomaly_detection_protocols::
* application::
* apriori_pattern_miner::
* arbitrary::
* arrangements::
* assignvars::
* avro::
* base32::
* base58::
* base64::
* base85::
* basic_types::
* bayesian_ridge_regression::
* borda_ranker::
* bradley_terry_ranker::
* c45_classifier::
* cartesian_products::
* cbor::
* character_sets::
* ccsds_frames::
* ccsds_link_profiles::
* ccsds_packet_services::
* ccsds_packetization::
* ccsds_packets::
* ccsds_tc_services::
* ccsds_time_codes::
* ccsds_time_fields::
* classification_protocols::
* clo_span_pattern_miner::
* clustering_protocols::
* colley_ranker::
* combinations::
* command_line_options::
* core::
* copeland_ranker::
* coroutining::
* crs_projections::
* csv::
* cuid2::
* cusum_anomaly_detector::
* datalog::
* dates::
* dates_tz::
* dbscan_clusterer::
* dependents::
* deques::
* derangements::
* dictionaries::
* dif::
* dimension_reduction_protocols::
* eclat_pattern_miner::
* edcg::
* elastic_net_regression::
* elo_ranker::
* events::
* ewma_anomaly_detector::
* expand_library_alias_paths::
* expecteds::
* format::
* fp_growth_pattern_miner::
* frequent_pattern_mining_protocols::
* gaussian_mixture_clusterer::
* gaussian_process_regression::
* genint::
* gensym::
* geojson::
* geospatial::
* git::
* glicko2_ranker::
* glicko2_periodic_ranker::
* gradient_boosting_classifier::
* gradient_boosting_regression::
* grammars::
* graphs::
* gsp_pattern_miner::
* hashes::
* hdbscan_clusterer::
* heaps::
* hierarchical_clustering::
* hierarchies::
* hmac::
* hodge_rank::
* hook_flows::
* hook_objects::
* html::
* ica_projection::
* ids::
* ieee_754::
* intervals::
* iqr_anomaly_detector::
* iso_639::
* iso_3166::
* iso_4217::
* iso_9362::
* iso_13616::
* isolation_forest_anomaly_detector::
* java::
* json::
* json_ld::
* json_lines::
* json_pointer::
* json_rpc::
* json_schema::
* kcenters_clusterer::
* kemeny_young_ranker::
* kernel_svm_classifier::
* kernel_pca_projection::
* kmeans_clusterer::
* kmedians_clusterer::
* kmedoids_clusterer::
* kmodes_clusterer::
* knn_classifier::
* knn_distance_anomaly_detector::
* knn_regression::
* kprototypes_clusterer::
* ksuid::
* lasso_regression::
* lda_classifier::
* lda_projection::
* linda::
* linear_algebra::
* linear_regression::
* linear_svm_classifier::
* listing::
* lof_anomaly_detector::
* logging::
* logistic_regression_classifier::
* loops::
* massey_ranker::
* mcp_server::
* memcached::
* message_pack::
* meta::
* meta_compiler::
* mime_types::
* modified_z_score_anomaly_detector::
* mutations::
* multisets::
* nanoid::
* naive_bayes_classifier::
* nearest_centroid_classifier::
* nested_dictionaries::
* Raw Sentence Representation::
* Typed data/2 Results::
* Date Rule::
* Current Scope::
* nmf_projection::
* optics_clusterer::
* optionals::
* options::
* os::
* partitions::
* pattern_mining_protocols::
* pca_projection::
* permutations::
* plackett_luce_ranker::
* plackett_luce_last_ranker::
* pls_projection::
* prefix_span_pattern_miner::
* probabilistic_pca_projection::
* process::
* protobuf::
* qda_classifier::
* queues::
* random::
* random_forest_classifier::
* random_forest_regression::
* random_projection::
* rank_centrality::
* ranked_pairs::
* ranking_protocols::
* reader::
* recorded_database::
* redis::
* regression_protocols::
* regression_tree::
* regularized_bradley_terry_ranker::
* ridge_regression::
* schulze_ranker::
* sequential_pattern_mining_protocols::
* sets::
* sgd_classifier::
* snowflakeid::
* sockets::
* spade_pattern_miner::
* simulated_annealing::
* statistics::
* stemming::
* stomp::
* string_distance::
* strings::
* subsequences::
* term_io::
* thurstone_mosteller_ranker::
* time_scales::
* timeout::
* tle_orbits::
* toml::
* toon::
* truncated_svd_projection::
* tsv::
* types::
* tzif::
* ulid::
* unicode_data::
* union_find::
* url::
* uuid::
* validations::
* wkt_wkb::
* yaml::
* z_score_anomaly_detector::
* zippers::


File: TheLogtalkHandbook-3.100.1.info,  Node: Overview<2>,  Next: adaptive_boosting_classifier,  Up: Libraries

6.1 Overview
============

This folder contains libraries of useful objects, categories, and
protocols.  The currently available libraries can be grouped by scope as
follows (the grouping is thematic only, as some libraries naturally span
multiple areas):

   - Application metadata, configuration, and logging: ‘application’,
     ‘expand_library_alias_paths’, ‘command_line_options’, ‘logging’,
     and ‘options’.

   - Types, collections and generic data processing: ‘basic_types’,
     ‘types’, ‘assignvars’, ‘deques’, ‘dictionaries’,
     ‘nested_dictionaries’, ‘graphs’, ‘heaps’, ‘hierarchies’,
     ‘intervals’, ‘queues’, ‘sets’, ‘subsequences’, ‘union_find’, and
     ‘zippers’.

   - Combinatorics: ‘arrangements’, ‘cartesian_products’,
     ‘combinations’, ‘derangements’, ‘multisets’, ‘partitions’, and
     ‘permutations’.

   - Meta-programming: ‘meta’ and ‘meta_compiler’

   - Monoid implementations: ‘expecteds’, ‘optionals’, and
     ‘validations’.

   - Control, state, and developer support: ‘dependents’, ‘edcg’,
     ‘events’, ‘listing’, ‘reader’, and ‘term_io’.

   - Term- and goal-expansion: ‘hook_flows’ and ‘hook_objects’.

   - Portability: ‘coroutining’, ‘dif’, ‘format’, ‘process’,
     ‘recorded_database’, and ‘timeout’.

   - Dates and time: ‘dates’, ‘dates_tz’, ‘time_scales’, and ‘tzif’.

   - Geospatial data: ‘crs_projections’, ‘geojson’, ‘geohash’,
     ‘geospatial’, ‘nmea’, ‘tle_orbits’, and ‘wkt_wkb’

   - Space communications and telemetry: ‘ccsds_frames’,
     ‘ccsds_link_profiles’, ‘ccsds_packet_services’,
     ‘ccsds_packetization’, ‘ccsds_packets’, ‘ccsds_tc_services’,
     ‘ccsds_time_codes’, ‘ccsds_time_fields’,

   - Text and NLP: ‘character_sets’, ‘grammars’, ‘stemming’,
     ‘string_distance’, and ‘strings’.

   - Web: ‘html’, ‘mime_types’, and ‘url’.

   - Identifiers: ‘cuid2’, ‘genint’, ‘gensym’, ‘ids’, ‘ksuid’, ‘nanoid’,
     ‘snowflakeid’, ‘ulid’, and ‘uuid’.

   - Interchange formats and wire protocols: ‘amqp’, ‘avro’, ‘base32’,
     ‘base58’, ‘base64’, ‘base85’, ‘cbor’, ‘csv’, ‘json’, ‘json_ld’,
     ‘json_lines’, ‘json_pointer’, ‘json_rpc’, ‘json_schema’,
     ‘message_pack’, ‘mcp_server’, ‘protobuf’, ‘stomp’, ‘toml’, ‘toon’,
     ‘tsv’, and ‘yaml’.

   - Coordination and data stores: ‘linda’, ‘memcached’, and ‘redis’.

   - System and external integration: ‘git’, ‘java’, ‘os’, and
     ‘sockets’.

   - Logic and symbolic computing: ‘datalog’.

   - Security and integrity: ‘hashes’ and ‘hmac’.

   - Randomness: ‘arbitrary’, ‘mutations’, and ‘random’.

   - Mathematics, statistics, and optimization: ‘ieee_754’,
     ‘linear_algebra’, ‘simulated_annealing’, and ‘statistics’.

   - Machine learning:

        - Classification: ‘classification_protocols’,
          ‘adaptive_boosting_classifier’, ‘c45_classifier’,
          ‘gradient_boosting_classifier’, ‘kernel_svm_classifier’,
          ‘knn_classifier’, ‘lda_classifier’, ‘linear_svm_classifier’,
          ‘logistic_regression_classifier’, ‘naive_bayes_classifier’,
          ‘nearest_centroid_classifier’, ‘qda_classifier’,
          ‘random_forest_classifier’, and ‘sgd_classifier’.

        - Anomaly detection: ‘anomaly_detection_protocols’,
          ‘cusum_anomaly_detector’, ‘ewma_anomaly_detector’,
          ‘iqr_anomaly_detector’, ‘isolation_forest_anomaly_detector’,
          ‘knn_distance_anomaly_detector’, ‘lof_anomaly_detector’,
          ‘modified_z_score_anomaly_detector’, and
          ‘z_score_anomaly_detector’.

        - Regression: ‘regression_protocols’,
          ‘bayesian_ridge_regression’, ‘elastic_net_regression’,
          ‘gradient_boosting_regression’, ‘gaussian_process_regression’,
          ‘knn_regression’, ‘lasso_regression’, ‘linear_regression’,
          ‘random_forest_regression’, ‘regression_tree’, and
          ‘ridge_regression’.

        - Ranking: ‘ranking_protocols’, ‘borda_ranker’,
          ‘bradley_terry_ranker’, ‘colley_ranker’, ‘copeland_ranker’,
          ‘elo_ranker’, ‘glicko2_ranker’, ‘glicko2_periodic_ranker’,
          ‘hodge_rank’, ‘kemeny_young_ranker’, ‘massey_ranker’,
          ‘plackett_luce_ranker’, ‘plackett_luce_last_ranker’,
          ‘rank_centrality’, ‘ranked_pairs’,
          ‘regularized_bradley_terry_ranker’, ‘schulze_ranker’, and
          ‘thurstone_mosteller_ranker’.

        - Clustering: ‘clustering_protocols’, ‘agglomerative_clusterer’,
          ‘dbscan_clusterer’, ‘gaussian_mixture_clusterer’,
          ‘hdbscan_clusterer’, ‘hierarchical_clustering’,
          ‘kcenters_clusterer’, ‘kmeans_clusterer’,
          ‘kmedians_clusterer’, ‘kmedoids_clusterer’,
          ‘kmodes_clusterer’, ‘kprototypes_clusterer’, and
          ‘optics_clusterer’.

        - Dimension reduction: ‘dimension_reduction_protocols’,
          ‘ica_projection’, ‘kernel_pca_projection’, ‘lda_projection’,
          ‘nmf_projection’, ‘pca_projection’, ‘pls_projection’,
          ‘probabilistic_pca_projection’, and ‘random_projection’.

        - Pattern mining: ‘pattern_mining_protocols’,
          ‘frequent_pattern_mining_protocols’,
          ‘sequential_pattern_mining_protocols’,
          ‘apriori_pattern_miner’, ‘clo_span_pattern_miner’,
          ‘eclat_pattern_miner’, ‘fp_growth_pattern_miner’,
          ‘gsp_pattern_miner’, ‘prefix_span_pattern_miner’, and
          ‘spade_pattern_miner’.

In addition to the loader-based libraries, this directory also contains
a small number of standalone reusable entities, namely ‘attributes’,
‘cloning’, ‘counters’, and ‘streamvars’.

Specific notes about individual libraries can be found in the
corresponding library directory ‘NOTES.md’ files.

A plain Prolog version of the Unicode 6.2 standard is also included in
the ‘unicode_data’ folder.  See its ‘README.md’ file for details.

A ‘parallel_logtalk_processes_setup.pl’ Prolog file is also provided
with sample code for selected backend Prolog compilers for initializing
Logtalk processes such that each process uses a unique scratch
directory, therefore allowing parallel process execution (e.g., for
usage at continuous integration servers).  Starting with Logtalk 3.48.0,
this setup is only required in general when running with the ‘clean’
flag turned off.  See the comments in the file itself for usage
instructions.

* Menu:

* Library documentation::
* Loading libraries::
* Testing libraries::
* Credits::
* Other notes: Other notes<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Library documentation,  Next: Loading libraries,  Up: Overview<2>

6.1.1 Library documentation
---------------------------

Specific notes about each library can be found in the corresponding
‘NOTES.md’ files.  HTML documentation for each library API can be found
on the ‘docs’ directory (open the ‘../docs/handbook/index.html’ file
with your web browser).


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading libraries,  Next: Testing libraries,  Prev: Library documentation,  Up: Overview<2>

6.1.2 Loading libraries
-----------------------

All the individual libraries can be loaded using the ‘<library
name>(loader)’ notation as argument for the compiling and loading
predicates.  For example:

     | ?- logtalk_load(random(loader)).

There is also a file named ‘all_loader.lgt’ that will load all
libraries.  Simply type the goal:

     | ?- logtalk_load(library(all_loader)).

As a general rule, always use the corresponding loader file to load a
library.  Most library entities are part of small hierarchies or depend
on other libraries and thus cannot be loaded and compiled separately
(e.g., the ‘list’ object implements the ‘listp’ protocol and is part of
a basic types hierarchy).  Using the loader files takes care of all
dependencies and also ensures compilation in optimized mode.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing libraries,  Next: Credits,  Prev: Loading libraries,  Up: Overview<2>

6.1.3 Testing libraries
-----------------------

Most of the libraries include unit tests in their directory, together
with a ‘tester.lgt’ file for running them.  For example, to run the
tests for the ‘random’ library, we can use the goal:

     | ?- logtalk_load(random(tester)).

To run all library tests, we can use the ‘logtalk_tester’ automation
script from the ‘library’ directory at the root of the Logtalk
distribution.  For example, assuming the Logtalk user directory is
‘~/logtalk’ and that we want to run the tests using ECLiPSe as the
backend Prolog compiler:

     $ cd ~/logtalk/library
     $ logtalk_tester -p eclipse


File: TheLogtalkHandbook-3.100.1.info,  Node: Credits,  Next: Other notes<2>,  Prev: Testing libraries,  Up: Overview<2>

6.1.4 Credits
-------------

Some code in this library is based on public domain Prolog code, in
particular, code adopted from the Edinburgh Prolog library.  The
definition of the predicate ‘reverse/2’ in the ‘list’ object is from
Richard O’Keefe and can be found in its book “The Craft of Prolog”.

Some elements of this library are inspired by Richard O’Keefe library
proposal available at:

‘http://www.cs.otago.ac.nz/staffpriv/ok/pllib.htm’

Some libraries, or parts of libraries, are either ports of Prolog system
libraries or inspired by Prolog system libraries.  See the individual
library notes for details.  See also the ‘NOTICE.txt’ file at the root
of the Logtalk distribution for copyright information on third-party
source code.


File: TheLogtalkHandbook-3.100.1.info,  Node: Other notes<2>,  Prev: Credits,  Up: Overview<2>

6.1.5 Other notes
-----------------

Some files contained in this directory represent work in progress and
are not loaded by default by any loader utility file.


File: TheLogtalkHandbook-3.100.1.info,  Node: adaptive_boosting_classifier,  Next: agglomerative_clusterer,  Prev: Overview<2>,  Up: Libraries

6.2 ‘adaptive_boosting_classifier’
==================================

Adaptive Boosting (aka AdaBoost) classifier using C4.5 decision trees as
base learners.  Implements the SAMME (Stagewise Additive Modeling using
a Multi-class Exponential loss function) variant, which supports
multi-class classification by adjusting the weight update formula to
account for the number of classes.  Builds an ensemble of weighted
decision trees where each subsequent tree focuses on the examples
misclassified by previous trees: after each iteration, the weights of
misclassified examples are increased so that subsequent learners focus
more on difficult cases.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
an ensemble classifier from a dataset, using it to make predictions
(with class probabilities), and exporting it as a list of predicate
clauses or to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  See ‘test_files’
directory for examples.

* Menu:

* API documentation: API documentation<21>.
* Loading: Loading<22>.
* Testing: Testing<17>.
* Features: Features<2>.
* Options: Options<3>.
* Classifier representation::
* References::
* Usage: Usage<14>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<21>,  Next: Loading<22>,  Up: adaptive_boosting_classifier

6.2.1 API documentation
-----------------------

Open the ‘../../docs/library_index.html#adaptive_boosting_classifier’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<22>,  Next: Testing<17>,  Prev: API documentation<21>,  Up: adaptive_boosting_classifier

6.2.2 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(adaptive_boosting_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<17>,  Next: Features<2>,  Prev: Loading<22>,  Up: adaptive_boosting_classifier

6.2.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(adaptive_boosting_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<2>,  Next: Options<3>,  Prev: Testing<17>,  Up: adaptive_boosting_classifier

6.2.4 Features
--------------

   - 'Adaptive Boosting': Iteratively trains weighted decision trees,
     focusing on misclassified examples

   - 'SAMME Algorithm': Supports multi-class classification via the
     SAMME variant of AdaBoost

   - 'C4.5 Base Learners': Uses C4.5 decision trees as weak learners for
     each boosting round

   - 'Weighted Voting': Final predictions determined by weighted voting
     where more accurate learners have higher weight

   - 'Probability Estimation': Provides confidence scores based on
     weighted vote proportions

   - 'Early Stopping': Training stops early if a perfect classifier is
     found or if a base learner is worse than random

   - 'Configurable Options': Number of estimators (boosting rounds)
     configurable via predicate options

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<3>,  Next: Classifier representation,  Prev: Features<2>,  Up: adaptive_boosting_classifier

6.2.5 Options
-------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘number_of_estimators(N)’: Number of boosting rounds / weak
     learners (default: 10)


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation,  Next: References,  Prev: Options<3>,  Up: adaptive_boosting_classifier

6.2.6 Classifier representation
-------------------------------

The learned classifier is represented as a compound term:

     ab_classifier(WeightedTrees, ClassValues, Options)

Where:

   - ‘WeightedTrees’: List of ‘weighted_tree(Alpha, C45Tree,
     AttributeNames)’ elements

   - ‘ClassValues’: List of possible class values

   - ‘Options’: List of options used during learning

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References,  Next: Usage<14>,  Prev: Classifier representation,  Up: adaptive_boosting_classifier

6.2.7 References
----------------

  1. Freund, Y. and Schapire, R.E. (1997).  “A Decision-Theoretic
     Generalization of On-Line Learning and an Application to Boosting”.
     Journal of Computer and System Sciences, 55(1), 119-139.

  2. Zhu, J., Zou, H., Rosset, S., and Hastie, T. (2009).  “Multi-class
     AdaBoost”.  Statistics and Its Interface, 2(3), 349-360.

  3. Quinlan, J.R. (1993).  “C4.5: Programs for Machine Learning”.
     Morgan Kaufmann.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<14>,  Prev: References,  Up: adaptive_boosting_classifier

6.2.8 Usage
-----------

* Menu:

* Learning a Classifier::
* Making Predictions::
* Exporting the Classifier::
* Using a Saved Classifier::
* Printing the Classifier::


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a Classifier,  Next: Making Predictions,  Up: Usage<14>

6.2.8.1 Learning a Classifier
.............................

     % Learn an AdaBoost classifier with default options (10 estimators)
     | ?- adaptive_boosting_classifier::learn(play_tennis, Classifier).
     ...

     % Learn with custom options
     | ?- adaptive_boosting_classifier::learn(play_tennis, Classifier, [number_of_estimators(20)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Making Predictions,  Next: Exporting the Classifier,  Prev: Learning a Classifier,  Up: Usage<14>

6.2.8.2 Making Predictions
..........................

     % Predict class for a new instance
     | ?- adaptive_boosting_classifier::learn(play_tennis, Classifier),
          adaptive_boosting_classifier::predict(Classifier, [outlook-sunny, temperature-hot, humidity-high, wind-weak], Class).
     Class = no
     ...

     % Get probability distribution from weighted voting
     | ?- adaptive_boosting_classifier::learn(play_tennis, Classifier),
          adaptive_boosting_classifier::predict_probabilities(Classifier, [outlook-overcast, temperature-mild, humidity-normal, wind-weak], Probabilities).
     Probabilities = [yes-0.9, no-0.1]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the Classifier,  Next: Using a Saved Classifier,  Prev: Making Predictions,  Up: Usage<14>

6.2.8.3 Exporting the Classifier
................................

     % Export as predicate clauses
     | ?- adaptive_boosting_classifier::learn(play_tennis, Classifier),
          adaptive_boosting_classifier::export_to_clauses(play_tennis, Classifier, my_boost, Clauses).
     ...

     % Export to a file
     | ?- adaptive_boosting_classifier::learn(play_tennis, Classifier),
          adaptive_boosting_classifier::export_to_file(play_tennis, Classifier, my_boost, 'boost.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Using a Saved Classifier,  Next: Printing the Classifier,  Prev: Exporting the Classifier,  Up: Usage<14>

6.2.8.4 Using a Saved Classifier
................................

     % Load and use a previously saved classifier
     | ?- logtalk_load('boost.pl'),
          my_boost(Classifier),
          adaptive_boosting_classifier::predict(Classifier, [outlook-sunny, temperature-cool, humidity-normal, wind-weak], Class).
     Class = yes
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Printing the Classifier,  Prev: Using a Saved Classifier,  Up: Usage<14>

6.2.8.5 Printing the Classifier
...............................

     % Print a summary of the AdaBoost classifier
     | ?- adaptive_boosting_classifier::learn(play_tennis, Classifier),
          adaptive_boosting_classifier::print_classifier(Classifier).

     AdaBoost Classifier
     ===================

     Learning options: [number_of_estimators(10)]

     Class values: [yes,no]
     Number of estimators: 10

     Weighted trees:
       Estimator 1 (alpha=1.2345, features: [outlook,temperature,humidity,wind]):
         -> tree rooted at outlook
       ...
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: agglomerative_clusterer,  Next: amqp,  Prev: adaptive_boosting_classifier,  Up: Libraries

6.3 ‘agglomerative_clusterer’
=============================

Agglomerative clusterer.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<22>.
* Loading: Loading<23>.
* Testing: Testing<18>.
* Features: Features<3>.
* Options: Options<4>.
* Clusterer representation::
* Diagnostics::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<22>,  Next: Loading<23>,  Up: agglomerative_clusterer

6.3.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#agglomerative_clusterer’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<23>,  Next: Testing<18>,  Prev: API documentation<22>,  Up: agglomerative_clusterer

6.3.2 Loading
-------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(agglomerative_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<18>,  Next: Features<3>,  Prev: Loading<23>,  Up: agglomerative_clusterer

6.3.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(agglomerative_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(agglomerative_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<3>,  Next: Options<4>,  Prev: Testing<18>,  Up: agglomerative_clusterer

6.3.4 Features
--------------

   - 'Bottom-Up Clustering': Uses deterministic bottom-up
     agglomerative_clusterer clustering and stops when the requested
     number of clusters is reached.

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Linkage Strategies': Supports ‘single’, ‘complete’, and ‘average’
     linkage.

   - 'Distance Metrics': Supports ‘euclidean’ and ‘manhattan’ distances.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Linkage-Aware Prediction': New instances are assigned to the
     nearest learned cluster using the selected linkage strategy and
     distance metric applied to the learned cluster members.

   - 'Deterministic Ordering': Equal-distance merges are broken using
     node-id order and final clusters are ordered by minimum training
     example id so equivalent dataset permutations keep the same cluster
     ids.

   - 'Cached Distances': Inter-cluster distances are cached and
     incrementally updated after each merge instead of being fully
     recomputed from cluster members at every iteration.

   - 'Priority-Queue Merge Selection': Candidate merges are tracked in a
     min-heap keyed by distance and node-id order, allowing stale
     entries to be discarded lazily while keeping merge selection
     deterministic.

   - 'Rich Diagnostics': Diagnostics report the training example count,
     performed merge count, initial pair count, maximum heap size,
     stale-pair discard count, deterministic pair-selection strategy,
     and linkage-aware prediction strategy.

   - 'Fail-Fast Consistency Checks': Internal heap, active-node, and
     cached-distance inconsistencies raise explicit
     ‘agglomerative_error/2’ exceptions instead of failing silently.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<4>,  Next: Clusterer representation,  Prev: Features<3>,  Up: agglomerative_clusterer

6.3.5 Options
-------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of clusters to retain after merging.  Default is
     ‘2’.

   - ‘linkage(Linkage)’: Linkage strategy to use.  Options: ‘single’,
     ‘complete’, or ‘average’ (default).

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default) or ‘manhattan’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation,  Next: Diagnostics,  Prev: Options<4>,  Up: agglomerative_clusterer

6.3.6 Clusterer representation
------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     agglomerative_clusterer(Encoders, Clusters, Prototypes, Options, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Clusters’: List of ‘cluster(Id, Points)’ terms in cluster-id
     order.

   - ‘Prototypes’: List of average vectors used for display,
     diagnostics, and export metadata.

   - ‘Options’: Effective training options used to learn the clusterer.

   - ‘Diagnostics’: Training metadata including heap and prediction
     details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics,  Prev: Clusterer representation,  Up: agglomerative_clusterer

6.3.7 Diagnostics
-----------------

The ‘diagnostics/2’ predicate returns metadata including:

   - ‘training_example_count/1’

   - ‘merge_count/1’

   - ‘initial_pair_count/1’

   - ‘maximum_heap_size/1’

   - ‘stale_pair_discard_count/1’

   - ‘pair_selection(priority_queue)’

   - ‘prediction_strategy(cluster_member_linkage_distance)’

   - ‘tie_breaking(node_id_order)’

   - ‘options/1’


File: TheLogtalkHandbook-3.100.1.info,  Node: amqp,  Next: anomaly_detection_protocols,  Prev: agglomerative_clusterer,  Up: Libraries

6.4 ‘amqp’
==========

Portable AMQP 0-9-1 (Advanced Message Queuing Protocol) client
implementation.  This library uses the ‘sockets’ library and supports
all backend Prolog systems supported by that library: ECLiPSe, GNU
Prolog, SICStus Prolog, SWI-Prolog, Trealla Prolog, and XVM.

‘https://www.rabbitmq.com/amqp-0-9-1-reference.html’

AMQP 0-9-1 is a binary wire-level protocol for message-oriented
middleware.  It is the de facto standard for message broker
interoperability and is supported by RabbitMQ, Apache Qpid, Apache
ActiveMQ, and other brokers.

* Menu:

* API documentation: API documentation<23>.
* Loading: Loading<24>.
* Testing: Testing<19>.
* Features: Features<4>.
* Usage: Usage<15>.
* Connection Pooling::
* Binary Frame Encoding::
* Data Types::
* Float/Double Encoding/Decoding::
* Error Handling::
* Comparison with STOMP::
* Future Work::
* Known Limitations and Issues::
* AMQP 1.0 vs AMQP 0-9-1: AMQP 1 0 vs AMQP 0-9-1.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<23>,  Next: Loading<24>,  Up: amqp

6.4.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#amqp’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<24>,  Next: Testing<19>,  Prev: API documentation<23>,  Up: amqp

6.4.2 Loading
-------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(amqp(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<19>,  Next: Features<4>,  Prev: Loading<24>,  Up: amqp

6.4.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(amqp(tester)).

Note: Integration tests require a running AMQP 0-9-1 server (e.g.,
RabbitMQ). RabbitMQ AMQP listens on port 5672 by default with
guest/guest credentials.


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<4>,  Next: Usage<15>,  Prev: Testing<19>,  Up: amqp

6.4.4 Features
--------------

   - Full AMQP 0-9-1 protocol support with binary frame
     encoding/decoding

   - Connection management with heartbeat negotiation

   - Automatic reconnection with configurable retry attempts and delays

   - Connection pooling with automatic connection management

   - Multiple concurrent channels over a single connection

   - Exchange operations: declare, delete, bind, unbind

   - Queue operations: declare, delete, bind, unbind, purge

   - Basic messaging: publish, consume, get, ack, nack, reject

   - Quality of service (QoS) with prefetch settings

   - Transaction support: tx.select, tx.commit, tx.rollback

   - Publisher confirms (RabbitMQ extension)

   - SASL PLAIN authentication

   - Custom message properties and headers

   - Content properties: content-type, delivery-mode, priority, etc.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<15>,  Next: Connection Pooling,  Prev: Features<4>,  Up: amqp

6.4.5 Usage
-----------

* Menu:

* Connecting to an AMQP server::
* Opening a channel::
* Declaring exchanges and queues::
* Publishing messages::
* Consuming messages::
* Synchronous get::
* Quality of Service::
* Transactions::
* Publisher Confirms (RabbitMQ extension): Publisher Confirms RabbitMQ extension.
* Closing connections::


File: TheLogtalkHandbook-3.100.1.info,  Node: Connecting to an AMQP server,  Next: Opening a channel,  Up: Usage<15>

6.4.5.1 Connecting to an AMQP server
....................................

Basic connection to RabbitMQ with default settings:

     ?- amqp::connect(localhost, 5672, Connection, []).

Connection with custom credentials and virtual host:

     ?- amqp::connect(localhost, 5672, Connection, [
         username('myuser'),
         password('mypassword'),
         virtual_host('/myvhost'),
         heartbeat(30)
     ]).

Connection with automatic reconnection enabled:

     ?- amqp::connect(localhost, 5672, Connection, [
         reconnect(true),
         reconnect_attempts(5),
         reconnect_delay(2)
     ]).

This will attempt to connect up to 5 times with a 2 second delay between
attempts.  If all attempts fail, an ‘amqp_error(reconnect_failed)’ error
is thrown.  The reconnection options are:

   - ‘reconnect(Boolean)’ - Enable automatic reconnection (default:
     ‘false’)

   - ‘reconnect_attempts(N)’ - Maximum number of connection attempts
     (default: ‘3’)

   - ‘reconnect_delay(Seconds)’ - Delay between attempts in seconds
     (default: ‘1’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Opening a channel,  Next: Declaring exchanges and queues,  Prev: Connecting to an AMQP server,  Up: Usage<15>

6.4.5.2 Opening a channel
.........................

AMQP operations require a channel.  Open one on the connection:

     ?- amqp::channel_open(Connection, 1, Channel).

You can open multiple channels (with different numbers) on a single
connection.


File: TheLogtalkHandbook-3.100.1.info,  Node: Declaring exchanges and queues,  Next: Publishing messages,  Prev: Opening a channel,  Up: Usage<15>

6.4.5.3 Declaring exchanges and queues
......................................

Declare a direct exchange:

     ?- amqp::exchange_declare(Channel, 'my.exchange', [
         type(direct),
         durable(true)
     ]).

Declare a queue:

     ?- amqp::queue_declare(Channel, 'my.queue', [
         durable(true),
         auto_delete(false)
     ]).

Declare a queue with server-generated name:

     ?- amqp::queue_declare(Channel, Queue, [exclusive(true)]).
     % Queue will be unified with the generated name

Bind a queue to an exchange:

     ?- amqp::queue_bind(Channel, 'my.queue', 'my.exchange', [
         routing_key('my.routing.key')
     ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Publishing messages,  Next: Consuming messages,  Prev: Declaring exchanges and queues,  Up: Usage<15>

6.4.5.4 Publishing messages
...........................

Publish a simple message:

     ?- amqp::basic_publish(Channel, 'my.exchange', 'Hello, World!', [
         routing_key('my.routing.key')
     ]).

Publish with properties:

     ?- amqp::basic_publish(Channel, 'my.exchange', '{"data": "json"}', [
         routing_key('my.routing.key'),
         content_type('application/json'),
         delivery_mode(2),  % persistent
         correlation_id('abc123'),
         reply_to('reply.queue')
     ]).

Publish with custom headers:

     ?- amqp::basic_publish(Channel, 'my.exchange', 'Message', [
         routing_key('my.key'),
         headers([
             'x-custom-header'-longstr('value'),
             'x-priority'-int(5)
         ])
     ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Consuming messages,  Next: Synchronous get,  Prev: Publishing messages,  Up: Usage<15>

6.4.5.5 Consuming messages
..........................

Start a consumer:

     ?- amqp::basic_consume(Channel, 'my.queue', [
         consumer_tag('my-consumer'),
         no_ack(false)
     ]).

Receive messages:

     ?- amqp::receive(Channel, Message, [timeout(5000)]).

Extract message data:

     ?- amqp::message_body(Message, Body),
        amqp::message_delivery_tag(Message, DeliveryTag),
        amqp::message_property(Message, content_type, ContentType).

Acknowledge a message:

     ?- amqp::basic_ack(Channel, DeliveryTag, []).

Reject a message:

     ?- amqp::basic_reject(Channel, DeliveryTag, [requeue(true)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Synchronous get,  Next: Quality of Service,  Prev: Consuming messages,  Up: Usage<15>

6.4.5.6 Synchronous get
.......................

Get a single message synchronously:

     ?- amqp::basic_get(Channel, 'my.queue', [no_ack(false)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Quality of Service,  Next: Transactions,  Prev: Synchronous get,  Up: Usage<15>

6.4.5.7 Quality of Service
..........................

Set prefetch count to limit unacknowledged messages:

     ?- amqp::basic_qos(Channel, [prefetch_count(10)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transactions,  Next: Publisher Confirms RabbitMQ extension,  Prev: Quality of Service,  Up: Usage<15>

6.4.5.8 Transactions
....................

Enable transactions on a channel:

     ?- amqp::tx_select(Channel).

Publish messages within a transaction:

     ?- amqp::basic_publish(Channel, 'exchange', 'Msg1', [routing_key('key')]),
        amqp::basic_publish(Channel, 'exchange', 'Msg2', [routing_key('key')]),
        amqp::tx_commit(Channel).

Rollback a transaction:

     ?- amqp::tx_rollback(Channel).


File: TheLogtalkHandbook-3.100.1.info,  Node: Publisher Confirms RabbitMQ extension,  Next: Closing connections,  Prev: Transactions,  Up: Usage<15>

6.4.5.9 Publisher Confirms (RabbitMQ extension)
...............................................

Enable publisher confirms:

     ?- amqp::confirm_select(Channel).


File: TheLogtalkHandbook-3.100.1.info,  Node: Closing connections,  Prev: Publisher Confirms RabbitMQ extension,  Up: Usage<15>

6.4.5.10 Closing connections
............................

Close a channel:

     ?- amqp::channel_close(Channel).

Close the connection:

     ?- amqp::close(Connection).


File: TheLogtalkHandbook-3.100.1.info,  Node: Connection Pooling,  Next: Binary Frame Encoding,  Prev: Usage<15>,  Up: amqp

6.4.6 Connection Pooling
------------------------

The library provides connection pooling through the ‘amqp_pool’
category.  To create a connection pool, define an object that imports
this category:

* Menu:

* Defining a pool::
* Initializing the pool::
* Acquiring and releasing connections::
* Using with_connection/1::
* Pool statistics::
* Resizing the pool::
* Destroying the pool::
* Creating pools dynamically::


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a pool,  Next: Initializing the pool,  Up: Connection Pooling

6.4.6.1 Defining a pool
.......................

     :- object(my_pool,
         imports(amqp_pool)).
     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Initializing the pool,  Next: Acquiring and releasing connections,  Prev: Defining a pool,  Up: Connection Pooling

6.4.6.2 Initializing the pool
.............................

Initialize the pool with configuration options:

     ?- my_pool::initialize([
         host(localhost),
         port(5672),
         min_size(2),
         max_size(10),
         connection_options([
             username('guest'),
             password('guest'),
             virtual_host('/')
         ])
     ]).

Pool configuration options:

   - ‘host(Host)’ - AMQP server hostname (default: ‘localhost’)

   - ‘port(Port)’ - AMQP server port (default: ‘5672’)

   - ‘min_size(N)’ - Minimum connections to maintain (default: ‘1’)

   - ‘max_size(N)’ - Maximum connections allowed (default: ‘10’)

   - ‘connection_options(Options)’ - Options passed to ‘amqp::connect/4’
     (default: ‘[]’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Acquiring and releasing connections,  Next: Using with_connection/1,  Prev: Initializing the pool,  Up: Connection Pooling

6.4.6.3 Acquiring and releasing connections
...........................................

Manually acquire and release connections:

     ?- my_pool::acquire(Connection),
        amqp::channel_open(Connection, 1, Channel),
        % ... use the channel ...
        amqp::channel_close(Channel),
        my_pool::release(Connection).


File: TheLogtalkHandbook-3.100.1.info,  Node: Using with_connection/1,  Next: Pool statistics,  Prev: Acquiring and releasing connections,  Up: Connection Pooling

6.4.6.4 Using with_connection/1
...............................

Use ‘with_connection/1’ for automatic connection management:

     ?- my_pool::with_connection(do_work).

     do_work(Connection) :-
         amqp::channel_open(Connection, 1, Channel),
         amqp::basic_publish(Channel, '', 'Hello!', [routing_key('my.queue')]),
         amqp::channel_close(Channel).

The connection is automatically released even if the goal fails or
throws an exception.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pool statistics,  Next: Resizing the pool,  Prev: Using with_connection/1,  Up: Connection Pooling

6.4.6.5 Pool statistics
.......................

Get pool statistics:

     ?- my_pool::stats(stats(Available, InUse, Total, MinSize, MaxSize)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Resizing the pool,  Next: Destroying the pool,  Prev: Pool statistics,  Up: Connection Pooling

6.4.6.6 Resizing the pool
.........................

Resize the pool at runtime:

     ?- my_pool::resize(5, 20).


File: TheLogtalkHandbook-3.100.1.info,  Node: Destroying the pool,  Next: Creating pools dynamically,  Prev: Resizing the pool,  Up: Connection Pooling

6.4.6.7 Destroying the pool
...........................

Close all connections and clear pool state:

     ?- my_pool::destroy.


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating pools dynamically,  Prev: Destroying the pool,  Up: Connection Pooling

6.4.6.8 Creating pools dynamically
..................................

Pools can also be created at runtime using ‘create_object/4’:

     ?- create_object(dynamic_pool, [imports(amqp_pool)], [], []),
        dynamic_pool::initialize([host(localhost), port(5672)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Binary Frame Encoding,  Next: Data Types,  Prev: Connection Pooling,  Up: amqp

6.4.7 Binary Frame Encoding
---------------------------

AMQP 0-9-1 is a binary protocol.  The library provides low-level
encoding and decoding predicates for working with raw frames:

* Menu:

* Frame structure::
* Encoding/decoding frames::


File: TheLogtalkHandbook-3.100.1.info,  Node: Frame structure,  Next: Encoding/decoding frames,  Up: Binary Frame Encoding

6.4.7.1 Frame structure
.......................

An AMQP frame consists of:

   - Type (1 byte): 1=method, 2=header, 3=body, 8=heartbeat

   - Channel (2 bytes): Channel number (0 for connection frames)

   - Size (4 bytes): Payload size

   - Payload (Size bytes): Frame-specific data

   - Frame end (1 byte): 0xCE marker


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding/decoding frames,  Prev: Frame structure,  Up: Binary Frame Encoding

6.4.7.2 Encoding/decoding frames
................................

Encode a frame to bytes:

     ?- amqp::encode_frame(Frame, Bytes).

Decode bytes to a frame:

     ?- amqp::decode_frame(Bytes, Frame).


File: TheLogtalkHandbook-3.100.1.info,  Node: Data Types,  Next: Float/Double Encoding/Decoding,  Prev: Binary Frame Encoding,  Up: amqp

6.4.8 Data Types
----------------

The library handles AMQP data types automatically:

   - 'octet': 8-bit unsigned integer

   - 'short': 16-bit unsigned integer (big-endian)

   - 'long': 32-bit unsigned integer (big-endian)

   - 'longlong': 64-bit unsigned integer (big-endian)

   - 'shortstr': Short string (length <= 255)

   - 'longstr': Long string

   - 'table': Field table (key-value pairs)

   - 'array': Field array

Field values in tables use type tags:

   - ‘bool(true/false)’ - Boolean

   - ‘byte(V)’ - Signed 8-bit

   - ‘short(V)’ - Signed 16-bit

   - ‘int(V)’ - Signed 32-bit

   - ‘long(V)’ - Signed 64-bit

   - ‘float(V)’ - 32-bit float

   - ‘double(V)’ - 64-bit float

   - ‘longstr(V)’ - Long string

   - ‘table(Pairs)’ - Nested table

   - ‘array(Values)’ - Array

   - ‘timestamp(V)’ - Timestamp

   - ‘void’ - No value


File: TheLogtalkHandbook-3.100.1.info,  Node: Float/Double Encoding/Decoding,  Next: Error Handling,  Prev: Data Types,  Up: amqp

6.4.9 Float/Double Encoding/Decoding
------------------------------------

The library implements proper IEEE 754 encoding and decoding for
floating-point values:

'Float (32-bit IEEE 754 single precision):'

   - Format: 1 sign bit + 8 exponent bits (bias 127) + 23 mantissa bits

   - Encoded as 4 bytes in big-endian order

   - Used for ‘float(Value)’ field values

'Double (64-bit IEEE 754 double precision):'

   - Format: 1 sign bit + 11 exponent bits (bias 1023) + 52 mantissa
     bits

   - Encoded as 8 bytes in big-endian order

   - Used for ‘double(Value)’ field values

'Special values representation:'

The library represents IEEE 754 special values using Prolog compound
terms:

   - ‘@infinity’ - Positive infinity

   - ‘@negative_infinity’ - Negative infinity

   - ‘@not_a_number’ - NaN (Not a Number)

These special values are automatically encoded to and decoded from their
standard IEEE 754 binary representations.

'Known limitation:'

Most Prolog backends cannot distinguish between ‘-0.0’ and ‘0.0’ when
comparing floating-point values.  While the library correctly encodes
and decodes both positive and negative zero according to IEEE 754, these
values will typically compare as equal in Prolog arithmetic operations.
This limitation is unlikely to affect typical AMQP messaging
applications.


File: TheLogtalkHandbook-3.100.1.info,  Node: Error Handling,  Next: Comparison with STOMP,  Prev: Float/Double Encoding/Decoding,  Up: amqp

6.4.10 Error Handling
---------------------

The library throws structured errors:

   - ‘amqp_error(connection_failed)’ - TCP connection failed

   - ‘amqp_error(auth_failed)’ - Authentication failed

   - ‘amqp_error(protocol_error(Msg))’ - Protocol violation

   - ‘amqp_error(channel_error(Msg))’ - Channel-level error

   - ‘amqp_error(exchange_error(Msg))’ - Exchange operation failed

   - ‘amqp_error(queue_error(Msg))’ - Queue operation failed

   - ‘amqp_error(basic_error(Msg))’ - Basic operation failed

   - ‘amqp_error(tx_error(Msg))’ - Transaction error


File: TheLogtalkHandbook-3.100.1.info,  Node: Comparison with STOMP,  Next: Future Work,  Prev: Error Handling,  Up: amqp

6.4.11 Comparison with STOMP
----------------------------

AMQP 0-9-1 and STOMP are both messaging protocols, but differ
significantly:

Feature            AMQP 0-9-1          STOMP
                                       
------------------------------------------------------------
Protocol type      Binary              Text
                                       
Complexity         High                Low
                                       
Exchange types     Multiple            Broker-dependent
                                       
Routing            Flexible            Simple
                                       
Transactions       Native              Native
                                       
QoS                Native prefetch     Limited
                                       
Performance        Higher              Lower
                                       

Use AMQP when you need:

   - Fine-grained routing control

   - High performance

   - Advanced message patterns

   - Exchange-based routing

Use STOMP when you need:

   - Simple text-based protocol

   - Easy debugging

   - Protocol simplicity


File: TheLogtalkHandbook-3.100.1.info,  Node: Future Work,  Next: Known Limitations and Issues,  Prev: Comparison with STOMP,  Up: amqp

6.4.12 Future Work
------------------

   - Logtalk protocols for messaging patterns (request/reply, pub/sub,
     etc.)

   - Categories for common message transformations

   - Async message handlers


File: TheLogtalkHandbook-3.100.1.info,  Node: Known Limitations and Issues,  Next: AMQP 1 0 vs AMQP 0-9-1,  Prev: Future Work,  Up: amqp

6.4.13 Known Limitations and Issues
-----------------------------------

   - SSL/TLS connections not yet supported (use stunnel or similar)

   - Heartbeat sending must be done manually via ‘send_heartbeat/1’

   - Most Prolog backends cannot distinguish between ‘-0.0’ and ‘0.0’
     (see the “Float/Double Encoding/Decoding” section above for
     details)

   - GNU Prolog support is partial as it doesn’t currently support null
     characters in atoms


File: TheLogtalkHandbook-3.100.1.info,  Node: AMQP 1 0 vs AMQP 0-9-1,  Prev: Known Limitations and Issues,  Up: amqp

6.4.14 AMQP 1.0 vs AMQP 0-9-1
-----------------------------

This library implements AMQP 0-9-1 only.  Despite the similar name,
'AMQP 1.0 is a fundamentally different protocol' and is not supported by
this library.  The two versions are not wire-compatible and have
different conceptual models:

Aspect              AMQP 0-9-1                AMQP 1.0
                                              
------------------------------------------------------------------------
Design              Broker-centric            Peer-to-peer
                                              
Routing             Exchanges + queues        Link-based addressing
                                              
Frame structure     Custom binary framing     Layered performatives
                                              
Data encoding       Custom type system        CBOR-like encoding
                                              

'Key differences:'

   - AMQP 0-9-1 uses exchanges, bindings, and queues as core protocol
     concepts

   - AMQP 1.0 abstracts these as broker-specific “nodes” and uses links

   - Frame encoding, handshake, and message format are completely
     different

   - Minimal code could be shared between the two implementations

AMQP 1.0 support would require a separate library with its own distinct
API reflecting the link-based model, rather than the exchange/queue
model of AMQP 0-9-1.

'Practical note:' RabbitMQ and most message brokers continue to
primarily use AMQP 0-9-1, making this library suitable for the vast
majority of use cases.


File: TheLogtalkHandbook-3.100.1.info,  Node: anomaly_detection_protocols,  Next: application,  Prev: amqp,  Up: Libraries

6.5 ‘anomaly_detection_protocols’
=================================

This library provides protocols used in the implementation of machine
learning anomaly-detection algorithms.  Datasets are represented as
objects implementing the ‘anomaly_dataset_protocol’ protocol.  Anomaly
detectors are represented as objects importing the
‘anomaly_detector_common’ category which imports the
‘anomaly_detector_protocol’ protocol.  The category provides shared
‘learn/2’, ‘predict/3-4’, ‘diagnostics/2’, ‘diagnostic/2’,
‘anomaly_detector_options/2’, file export, baseline training-selection
helpers, and dataset helper predicates.  It keeps threshold-based
prediction and export behavior separate from the algorithm-specific
learning, scoring, clause export, pretty-printing, and diagnostics
metadata code.

The shared category also provides reusable protected predicates for
baseline-only training workflows.  Libraries can use the
‘baseline_class_values/1’ and ‘baseline_selection_policy/1’ options via
a single helper instead of reimplementing class-label validation and
baseline-example filtering or rejection logic locally.

Learned detector terms can be validated explicitly using the shared
‘check_anomaly_detector/1’ and ‘valid_anomaly_detector/1’ predicates.
This validation API is never called implicitly by scoring, prediction,
printing, or export predicates.

This library also provides a reusable shared category, anomaly benchmark
datasets, and a small family smoke-test suite.

* Menu:

* Export header format::
* API documentation: API documentation<24>.
* Loading: Loading<25>.
* Testing: Testing<20>.
* Test datasets::


File: TheLogtalkHandbook-3.100.1.info,  Node: Export header format,  Next: API documentation<24>,  Up: anomaly_detection_protocols

6.5.1 Export header format
--------------------------

The shared exporter in the ‘anomaly_detector_common’ category writes a
header before the exported clauses in the following format:

     % exported anomaly detector predicate: Functor/Arity
     % training dataset: Dataset
     % options: Options
     % Functor(Detector)
     Functor(Detector)

The exported clauses serialize the learned detector term as a single
predicate argument so that loading the file gives a detector term that
can be passed directly to the ‘predict/3-4’ and ‘score_all/3’
predicates.

When exporting a serialized detector term, using a noun such as
‘detector/1’ or ‘model/1’ is recommended.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<24>,  Next: Loading<25>,  Prev: Export header format,  Up: anomaly_detection_protocols

6.5.2 API documentation
-----------------------

Open the ‘../../apis/library_index.html#anomaly-detection-protocols’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<25>,  Next: Testing<20>,  Prev: API documentation<24>,  Up: anomaly_detection_protocols

6.5.3 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

| ?- logtalk_load(anomaly_detection_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<20>,  Next: Test datasets,  Prev: Loading<25>,  Up: anomaly_detection_protocols

6.5.4 Testing
-------------

To run the library smoke tests, shared category tests, and dataset
checks, load the ‘tester.lgt’ file:

| ?- logtalk_load(anomaly_detection_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test datasets,  Prev: Testing<20>,  Up: anomaly_detection_protocols

6.5.5 Test datasets
-------------------

Several sample datasets are included in the ‘test_datasets’ directory:

   - ‘gaussian_anomalies.lgt’ — A synthetic 2D anomaly detection dataset
     with 48 examples and 2 continuous attributes (x, y).  Normal points
     are sampled from a standard normal distribution centered at the
     origin.  Anomalous points are placed far from the cluster center.
     Inspired by the canonical test case used in the Extended Isolation
     Forest paper by Hariri et al.  (2019).

   - ‘malformed_anomalies.lgt’ — A negative fixture with invalid class
     labels for testing family-level dataset validation.

   - ‘mixed_anomalies.lgt’ — A small mixed-feature anomaly dataset with
     16 examples, 2 continuous attributes (age, income), and 2
     categorical attributes (student, credit_rating).  Includes missing
     values and uncommon feature combinations to exercise
     anomaly-detection code on heterogeneous data.

   - ‘mixed_distance_behaviors.lgt’ — A compact mixed-feature anomaly
     fixture with 8 examples, 2 continuous attributes (size, weight),
     and 2 categorical attributes (color, shape).  Intended for
     smoke-testing continuous plus categorical distance behavior and
     basic mixed-data handling.

   - ‘sensor_anomalies.lgt’ — A synthetic industrial sensor anomaly
     dataset with 40 examples and 3 continuous attributes (temperature,
     pressure, vibration).  Contains missing values (14 examples with
     missing values, represented using anonymous variables).  Normal
     readings cluster around typical operating ranges.  Anomalous
     readings show extreme values indicating equipment malfunction.

   - ‘shuttle_anomalies.lgt’ — A subset of the Statlog Shuttle dataset
     with 50 examples and 9 continuous attributes representing sensor
     readings from the NASA Space Shuttle.  Class 1 (Rad Flow) is the
     majority class (normal), while all other classes are treated as
     anomalies.  Originally from Catlett, J. (1991).  Available from the
     UCI Machine Learning Repository:
     ‘https://archive.ics.uci.edu/dataset/148/statlog+shuttle’

   - ‘water_potability.lgt’ — A water potability dataset with 48
     examples and 9 continuous attributes (pH, hardness, solids,
     chloramines, sulfate, conductivity, organic carbon,
     trihalomethanes, turbidity).  Normal instances represent potable
     water samples within acceptable ranges.  Anomalous instances
     represent water samples with hazardous contamination levels.  Based
     on the publicly available Water Quality dataset (Kadiwal, A., 2020,
     Kaggle).


File: TheLogtalkHandbook-3.100.1.info,  Node: application,  Next: apriori_pattern_miner,  Prev: anomaly_detection_protocols,  Up: Libraries

6.6 ‘application’
=================

This library provides the ‘application_common’ category and the
‘application_protocol’ protocol for declaring application metadata,
including optional git-related facts such as repository URL, branch,
commit, author, and commit message, plus optional package and archive
identifiers.  Application metadata is typically consumed by tools such
as ‘sbom’.

The library distinguishes two kinds of information:

   - release metadata, such as name, version, description, license,
     distribution location, package identifier, release date, and
     validity date

   - optional source provenance metadata, such as repository URL,
     branch, commit, commit date, author, commit message, and archive
     identifiers

Source provenance predicates are explicit facts declared by the
application.  They are not a reflection of the current status of a local
git checkout and should not be assumed to identify a released artifact
unless the application author chooses to state them for that purpose.

* Menu:

* API documentation: API documentation<25>.
* Loading: Loading<26>.
* Testing: Testing<21>.
* Usage: Usage<16>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<25>,  Next: Loading<26>,  Up: application

6.6.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#application’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<26>,  Next: Testing<21>,  Prev: API documentation<25>,  Up: application

6.6.2 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(application(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<21>,  Next: Usage<16>,  Prev: Loading<26>,  Up: application

6.6.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(application(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<16>,  Prev: Testing<21>,  Up: application

6.6.4 Usage
-----------

Define an application metadata object importing the ‘application_common’
category and declaring the metadata that is known explicitly.  For
example:

     :- object(my_application,
         imports(application_common)).

         name(my_application).
         version('1.2.3').
         description('Example application metadata object').
         license('Apache-2.0').
         homepage('https://example.com/my_application').
         distribution('https://example.com/my_application/releases/download/v1.2.3/my_application.tgz').
         package('pkg:generic/my_application@1.2.3').
         creators(['Tool: Build pipeline', 'Person: Alice']).
         supplier('Organization: Example Application').
         originator('Organization: Upstream Project').
         repository('https://example.com/my_application.git').
         repository_branch(main).
         repository_commit('0123456789abcdef0123456789abcdef01234567').
         git_object_identifier('gitoid:commit:sha1:0123456789abcdef0123456789abcdef01234567').
         software_heritage_identifier('swh:1:rev:0123456789abcdef0123456789abcdef01234567').
         repository_commit_author('Alice').

     :- end_object.

The library distinguishes between creators and originator using two
predicates:

   - ‘creators/1’ identifies the people, organizations, or tools
     credited with creating the application or preparing its release
     metadata

   - ‘originator/1’ identifies the original source of the software when
     that is relevant and distinct from the creators

For example, an internal application might use the same party for both
‘creators/1’ and ‘originator/1’.  A packaged or redistributed
application may use ‘creators/1’ for the team or toolchain preparing the
release metadata and ‘originator/1’ for the original upstream source.

The imported category provides a default definition for the
‘loader_file/1’ predicate and derived external references that use the
same vocabulary as the corresponding first-class predicates:

   - ‘external_reference(homepage, URL)’ from ‘homepage/1’

   - ‘external_reference(distribution, URL)’ from ‘distribution/1’

   - ‘external_reference(package, Identifier)’ from ‘package/1’

   - ‘external_reference(repository, URL)’ from ‘repository/1’

   - ‘external_reference(git_object_identifier, Identifier)’ from
     ‘git_object_identifier/1’

   - ‘external_reference(software_heritage_identifier, Identifier)’ from
     ‘software_heritage_identifier/1’

The following predicates are intended to help tools such as ‘sbom’
export stronger standardized references:

   - ‘package/1’ Stores an application package identifier as a PURL.
     This is distinct from ‘distribution/1’, which stores a download
     location URL. Tools such as ‘sbom’ can use ‘package/1’ to export a
     package identity reference instead of only a release download
     location.  Example: ‘package('pkg:generic/my_application@1.2.3')’.

   - ‘git_object_identifier/1’ Stores a standardized Git object
     identifier as a gitoid.  This is distinct from
     ‘repository_commit/1’, which stores the raw commit hash as
     provenance metadata.  Tools such as ‘sbom’ can use
     ‘git_object_identifier/1’ to export a stronger provenance
     reference.  Example:
     ‘git_object_identifier('gitoid:commit:sha1:0123456789abcdef0123456789abcdef01234567')’.

   - ‘software_heritage_identifier/1’ Stores a Software Heritage
     identifier (SWHID) for an archived release or revision.  Tools such
     as ‘sbom’ can use it to export a stable archived source provenance
     reference when one is known.  Example:
     ‘software_heritage_identifier('swh:1:rev:0123456789abcdef0123456789abcdef01234567')’.

Git-related predicates are optional source provenance facts, not
reflection over the current state of a local repository checkout.

Release-oriented metadata typically includes:

   - ‘name/1’

   - ‘version/1’

   - ‘description/1’

   - ‘license/1’

   - ‘homepage/1’

   - ‘distribution/1’

   - ‘package/1’

   - ‘creators/1’

   - ‘supplier/1’

   - ‘originator/1’

   - ‘built_date/1’

   - ‘release_date/1’

   - ‘valid_until_date/1’

   - ‘external_reference/2’

Optional source provenance metadata typically includes:

   - ‘repository/1’

   - ‘repository_branch/1’

   - ‘repository_commit/1’

   - ‘repository_commit_abbreviated/1’

   - ‘repository_commit_date/1’

   - ‘repository_commit_author/1’

   - ‘repository_commit_message/1’

   - ‘git_object_identifier/1’

   - ‘software_heritage_identifier/1’


File: TheLogtalkHandbook-3.100.1.info,  Node: apriori_pattern_miner,  Next: arbitrary,  Prev: application,  Up: Libraries

6.7 ‘apriori_pattern_miner’
===========================

Apriori frequent itemset miner for transaction datasets.  The library
depends on the ‘frequent_pattern_mining_protocols’ support library,
implements the generic ‘pattern_miner_protocol’ defined in the
‘pattern_mining_protocols’ core library, and mines frequent itemsets
using deterministic level-wise candidate generation and anti-monotone
pruning with one transaction rescan per candidate level using a
candidate hash tree backed by keyed bucket dictionaries.  Requires a
dataset implementing ‘transaction_dataset_protocol’ with transactions
represented as canonical sorted lists of unique declared items.

* Menu:

* API documentation: API documentation<26>.
* Loading: Loading<27>.
* Testing: Testing<22>.
* Features: Features<5>.
* Options: Options<5>.
* Pattern miner representation::
* References: References<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<26>,  Next: Loading<27>,  Up: apriori_pattern_miner

6.7.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#apriori_pattern_miner’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<27>,  Next: Testing<22>,  Prev: API documentation<26>,  Up: apriori_pattern_miner

6.7.2 Loading
-------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(apriori_pattern_miner(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<22>,  Next: Features<5>,  Prev: Loading<27>,  Up: apriori_pattern_miner

6.7.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(apriori_pattern_miner(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<5>,  Next: Options<5>,  Prev: Testing<22>,  Up: apriori_pattern_miner

6.7.4 Features
--------------

   - 'Deterministic Level-Wise Mining': Builds frequent itemsets level
     by level by generating deterministic candidate combinations,
     pruning candidates whose subsets are infrequent, and rescanning
     transactions once per level to compute support counts for all
     candidates using a candidate hash tree.

   - 'Candidate Hash Tree Counting': Counts supports for an entire
     candidate level by traversing a hash tree with keyed bucket and
     item dictionaries instead of linearly scanning bucket lists for
     every transaction.

   - 'Library Hashing': Uses the ‘hashes’ library ‘fnv1a_32’ object to
     hash candidate items instead of relying on an ad hoc local hash
     function.

   - 'Apriori Join Step': Generates level candidates by pairwise joins
     of the previous frequent itemsets with shared prefixes.

   - 'Apriori Pruning': Rejects candidate itemsets whose immediate
     subsets are not all frequent using ordered subset checks over the
     previous level.

   - 'Canonical Transactions': Validates that transactions are sorted,
     duplicate-free, and restricted to declared items.

   - 'Flexible Support Thresholds': Supports relative minimum support
     and absolute minimum support count.

   - 'Model Export': Mined pattern collections can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<5>,  Next: Pattern miner representation,  Prev: Features<5>,  Up: apriori_pattern_miner

6.7.5 Options
-------------

The ‘mine/3’ predicate accepts the following options:

   - ‘minimum_support/1’: Relative minimum support threshold in the
     interval ‘]0.0, 1.0]’.  The default is ‘0.5’.

   - ‘minimum_support_count/1’: Absolute minimum support count.  When
     both support options are provided, this option takes precedence.

   - ‘maximum_pattern_length/1’: Maximum itemset length to mine.  The
     default is ‘1000’, which is effectively capped by the longest
     transaction in the dataset.

   - ‘minimum_pattern_length/1’: Minimum itemset length retained in the
     mined result.  The default is ‘1’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pattern miner representation,  Next: References<2>,  Prev: Options<5>,  Up: apriori_pattern_miner

6.7.6 Pattern miner representation
----------------------------------

The mined pattern miner result is represented by a compound term with
the functor chosen by the implementation and arity 3.  For example:

     apriori_pattern_miner(ItemDomain, Patterns, Options)

Where:

   - ‘ItemDomain’: Canonical sorted list of declared dataset items.

   - ‘Patterns’: List of ‘itemset(Items, SupportCount)’ terms ordered
     first by pattern length and then lexicographically.

   - ‘Options’: Effective mining options used to mine the frequent
     itemsets.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<2>,  Prev: Pattern miner representation,  Up: apriori_pattern_miner

6.7.7 References
----------------

  1. Agrawal, R. and Srikant, R. (1994) - “Fast algorithms for mining
     association rules in large databases”.


File: TheLogtalkHandbook-3.100.1.info,  Node: arbitrary,  Next: arrangements,  Prev: apriori_pattern_miner,  Up: Libraries

6.8 ‘arbitrary’
===============

The ‘arbitrary’ library defines an ‘arbitrary’ category providing
predicates for generating random values for selected types to the ‘type’
object, complementing its type checking predicates.  Both the object and
the category predicates can be extended by the user with definitions for
new types by defining clauses for multifile predicates.  This library is
notably used in the QuickCheck implementation by the ‘lgtunit’ tool.
See also the documentation of the ‘mutations’ library for related
functionality.

* Menu:

* API documentation: API documentation<27>.
* Loading: Loading<28>.
* Testing: Testing<23>.
* Pre-defined types::
* Usage: Usage<17>.
* Defining new generators and shrinkers::
* Scoped generators and shrinkers::
* Reproducing sequences of arbitrary terms::
* Default size of generated terms::
* Known issues: Known issues<10>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<27>,  Next: Loading<28>,  Up: arbitrary

6.8.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#arbitrary’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<28>,  Next: Testing<23>,  Prev: API documentation<27>,  Up: arbitrary

6.8.2 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(arbitrary(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<23>,  Next: Pre-defined types,  Prev: Loading<28>,  Up: arbitrary

6.8.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(arbitrary(tester)).

Several of the provided tests are generic and verify the correct
behavior of all pre-defined and loaded user-defined generators and
shrinkers for all ground types.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pre-defined types,  Next: Usage<17>,  Prev: Testing<23>,  Up: arbitrary

6.8.4 Pre-defined types
-----------------------

This library defines random generators for the most common Logtalk and
Prolog types.  See the API documentation(1) for a listing of all the
pre-defined types.

   ---------- Footnotes ----------

   (1) ../../apis/library_index.html#arbitrary


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<17>,  Next: Defining new generators and shrinkers,  Prev: Pre-defined types,  Up: arbitrary

6.8.5 Usage
-----------

The ‘arbitrary’ category complements the ‘type’ object and thus its
predicates are accessed via this object.  For example:

     | ?- type::arbitrary(integer, Arbitrary).
     Arbitrary = -816
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining new generators and shrinkers,  Next: Scoped generators and shrinkers,  Prev: Usage<17>,  Up: arbitrary

6.8.6 Defining new generators and shrinkers
-------------------------------------------

To define a generator of arbitrary values for a type, define a clause
for the ‘arbitrary::arbitrary/1’ multifile predicate specifying the type
and a clause for the ‘arbitrary::arbitrary/2’ multifile predicate
generating an arbitrary term of the specified type.  As a simple
example, assume that we want to define an “odd integer type”.  We start
by defining both the type checker and the arbitrary generator:

     :- multifile(type::type/1).
     type::type(odd).

     :- multifile(type::check/2).
     type::check(odd, Term) :-
         (   var(Term) ->
             throw(instantiation_error)
         ;   integer(Term),
             Term mod 2 =:= 1 ->
             true
         ;   throw(type_error(odd, Term))
         ).

     :- multifile(arbitrary::arbitrary/1).
     arbitrary::arbitrary(odd).

     :- multifile(arbitrary::arbitrary/2).
     arbitrary::arbitrary(odd, Arbitrary) :-
         type::arbitrary(integer, Arbitrary0),
         (   Arbitrary0 mod 2 =:= 1 ->
             Arbitrary = Arbitrary0
         ;   Arbitrary is Arbitrary0 + 1
         ).

The ‘arbitrary’ library also provides 'meta-types' that can simplify the
definition of new generators.  For example, the ‘odd’ type above can
also be defined using the ‘constrain/2’ meta-type to only generate
values that satisfy a closure:

     arbitrary::arbitrary(odd, Arbitrary) :-
         arbitrary(constrain(integer, [Arbitrary]>>(Arbitrary mod 2 =:= 1)), Arbitrary).

Another example is using the ‘transform/2’ meta-type to transform
generated values for a base type using a closure.  Assuming that we want
to generate a sorted list of random integers, we can write:

     arbitrary::arbitrary(sorted_integer_list, Arbitrary) :-
         arbitrary(transform(list(integer), sort), Arbitrary).

We can also define a clause for the ‘arbitrary::shrinker/1’ multifile
predicate to declare a new shrinker and a ‘arbitrary::shrink/3’
multifile predicate for shrinking arbitrary values for QuickCheck usage:

     :- multifile(arbitrary::shrinker/1).
     arbitrary::shrinker(odd).

     :- multifile(arbitrary::shrink/3).
     arbitrary::shrink(odd, Large, Small) :-
         integer(Large),
         (   Large < -1 ->
             Small is Large + 2
         ;   Large > 1,
             Small is Large - 2
         ).

Definitions for the ‘shrink/3’ predicate should either succeed or fail
but never throw an exception.  The ‘shrink_sequence/3’ predicate can be
used to help test that shrinking a value results in a finite sequence of
values.

It is also possible to define edge cases for a given type for use with
QuickCheck implementations.  For example:

     :- multifile(arbitrary::edge_case/2).
     arbitrary::edge_case(odd,  1).
     arbitrary::edge_case(odd, -1).

Edge cases are tried before resorting to generating arbitrary values for
a type.

A more complex example is generating arbitrary values for a recursive
type.  A simple example of a recursive type is a binary tree.  Assuming
that we are working with a binary tree holding integers where each node
is represented by a ‘node(Left, Right)’ compound term, we can define a
‘node(Depth)’ type where ‘Depth’ is the maximum depth of the tree.  This
argument allows us to prevent excessively deep trees:

     :- category(binary_tree).

         :- multifile(type::type/1).
         type::type(node(_)).

         :- multifile(type::check/2).
         type::check(node(_), Term) :-
             (   check(Term) ->
                 true
             ;   var(Term) ->
                 throw(instantiation_error)
             ;   throw(type_error(node(_), Term))
             ).

         check(Term) :-
             (   integer(Term) ->
                 true
             ;   compound(Term),
                 Term = node(Left, Right),
                 check(Left),
                 check(Right)
             ).

         :- multifile(arbitrary::arbitrary/1).
         arbitrary::arbitrary(node(_)).

         :- multifile(arbitrary::arbitrary/2).
         arbitrary::arbitrary(node(Depth), Arbitrary) :-
         (   Depth > 1 ->
             NewDepth is Depth - 1,
             type::arbitrary(
                 types_frequency([
                     integer - 1,
                     compound(
                         node,
                         [
                             types([node(NewDepth), integer]),
                             types([node(NewDepth), integer])
                         ]
                     ) - 3
                 ]),
                 Arbitrary
             )
         ;   type::arbitrary(
         integer, Arbitrary)
         ).

     :- end_category.

In this second example, we use some of the pre-defined types provided by
the library.  The ‘types_frequency(Pairs)’ type supports generating
random terms for a type in the ‘Type-Frequency’ pairs list where the
type is randomly chosen after the types relative frequency.  The
‘compound(Name, Types)’ type supports generating compound terms with a
given name and random arguments after the given types:

     | ?- type::arbitrary(node(4), Arbitrary).
     Arbitrary = 907
     yes

     | ?- type::arbitrary(node(4), Arbitrary).
     Arbitrary = node(node(node(522, 509), node(83, 453)), node(454, -197))
     yes

     | ?- type::arbitrary(node(4), Arbitrary).
     Arbitrary = node(node(-875, -866), -254)
     yes

     | ?- type::arbitrary(node(4), Arbitrary).
     Arbitrary = node(-133, -831)
     yes

The source code of these examples can be found in the ‘test_files’
directory.  Other examples of arbitrary term generators can be found in
the implementation of the ‘optionals’ and ‘expecteds’ libraries.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoped generators and shrinkers,  Next: Reproducing sequences of arbitrary terms,  Prev: Defining new generators and shrinkers,  Up: arbitrary

6.8.7 Scoped generators and shrinkers
-------------------------------------

Declaring a new generator and possibly a shrinker for a custom type
raises the possibility of a conflict with third-party-defined generators
and shrinkers.  An alternative is to use the ‘(::)/2’ meta-type to
define scoped generators and shrinkers.  For example:

     :- object(scoped).

         % the same predicate is used for both generating and validating
         :- public(custom/1).
         custom(Term) :-
             (   var(Term) ->
                 % assume predicate used as a generator
                 random::random(Term)
             ;   % assume predicate used as a validator
                 float(Term)
             ).

         % a predicate with the same name is used for shrinking
         :- public(custom/2).
         custom(Larger, Small) :-
             Small is Larger / 2.

     :- end_object.

Some sample calls:

     | ?- type::arbitrary(scoped::custom, Arbitrary).
     Arbitrary = 0.5788130906607927
     yes

     | ?- type::valid(scoped::custom, foo).
     no

     | ?- type::check(scoped::custom, _).
     ERROR: type_error(instantiation_error)

     | ?- type::check(scoped::custom, foo).
     ERROR: type_error(scoped::custom, foo)

     | ?- type::shrink(scoped::custom, 0.42, Smaller).
     Smaller = 0.21
     yes

The source code of this example can be found in the ‘test_files’
directory.


File: TheLogtalkHandbook-3.100.1.info,  Node: Reproducing sequences of arbitrary terms,  Next: Default size of generated terms,  Prev: Scoped generators and shrinkers,  Up: arbitrary

6.8.8 Reproducing sequences of arbitrary terms
----------------------------------------------

The ‘arbitrary’ category provides access to the pseudo-random generator
it uses via the ‘get_seed/1’ and ‘set_seed/1’.  This allows sequences of
arbitrary values to be reproduced.  For example:

     | ?- type::get_seed(Seed).
     Seed = seed(3172, 9814, 20125)
     yes

     | ?- type::arbitrary(integer, Arbitrary).
     Arbitrary = -816
     yes

     | ?- type::arbitrary(integer, Arbitrary).
     Arbitrary = -113
     yes

     | ?- type::arbitrary(integer, Arbitrary).
     Arbitrary = 446

     | ?- type::set_seed(seed(3172, 9814, 20125)).
     yes

     | ?- type::arbitrary(integer, Arbitrary).
     Arbitrary = -816
     yes

     | ?- type::arbitrary(integer, Arbitrary).
     Arbitrary = -113
     yes

     | ?- type::arbitrary(integer, Arbitrary).
     Arbitrary = 446
     yes

The seed should be regarded as an opaque term and handled using the
‘get_seed/1’ and ‘set_seed/1’ predicates.  These predicates are notably
used in the QuickCheck implementation provided by the ‘lgtunit’ tool.


File: TheLogtalkHandbook-3.100.1.info,  Node: Default size of generated terms,  Next: Known issues<10>,  Prev: Reproducing sequences of arbitrary terms,  Up: arbitrary

6.8.9 Default size of generated terms
-------------------------------------

The library uses the value 42 for the default size of generated terms
for types where size is meaningful and implicit.  To override this
default value, define a clause for the ‘arbitrary::max_size/1’ multifile
predicate.  The new default size must be a positive integer.  For
example:

     :- multifile(arbitrary::max_size/1).
     arbitrary::max_size(7).

When multiple definitions exist, the first valid one found is used.
When no definition is valid, the default value of 42 is used.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<10>,  Prev: Default size of generated terms,  Up: arbitrary

6.8.10 Known issues
-------------------

Some Prolog systems either don’t support the null character or provide
buggy results when calling ‘char_code/2’ with a code of zero.  When
that’s the case, the null character is excluded when generating
arbitrary characters or character codes.

Generating arbitrary Unicode characters (instead of Unicode codepoints)
is inherently problematic as the process first generates codepoints and
then tries to use the standard ‘char_code/2’ to convert them to
characters.  But, depending on the backend Prolog system and its
internal (if any) Unicode normalization, it may not be possible to
convert a codepoint to a single character.


File: TheLogtalkHandbook-3.100.1.info,  Node: arrangements,  Next: assignvars,  Prev: arbitrary,  Up: Libraries

6.9 ‘arrangements’
==================

This library provides predicates for generating and querying
arrangements over lists.  Arrangements are ordered selections of a given
length with element repetition allowed.  The following categories of
predicates are provided:

   - 'Generation operations' - Predicates for generating arrangements.

   - 'Ordering variants' - Predicates that support an additional order
     argument (‘default’ or ‘lexicographic’) for controlling output
     order.

   - 'Distinct-value generation' - Predicates for generating
     arrangements while deduplicating equal-valued results.

   - 'Indexed access' - Predicates for direct access to arrangements at
     specific positions, including distinct arrangements.

   - 'Lexicographic stepping' - Predicates for navigating arrangements
     in lexicographic order.

   - 'Counting operations' - Predicates for counting arrangements and
     distinct arrangements.

   - 'Random selection' - Predicates for randomly selecting and sampling
     arrangements and distinct arrangements.

Dedicated ‘cartesian_products’, ‘permutations’, ‘combinations’,
‘multisets’, ‘derangements’, ‘partitions’, and ‘subsequences’ libraries
are also available for focused APIs on related operations.

* Menu:

* API documentation: API documentation<28>.
* Loading: Loading<29>.
* Testing: Testing<24>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<28>,  Next: Loading<29>,  Up: arrangements

6.9.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#arrangements’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<29>,  Next: Testing<24>,  Prev: API documentation<28>,  Up: arrangements

6.9.2 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(arrangements(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<24>,  Prev: Loading<29>,  Up: arrangements

6.9.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(arrangements(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: assignvars,  Next: avro,  Prev: arrangements,  Up: Libraries

6.10 ‘assignvars’
=================

The ‘assignvarsp’ protocol declares the predicates used for logical
assignment of Prolog terms developed by Nobukuni Kino.

The ‘assignvars’ object provides a declarative implementation of the
‘assignvarsp’ protocol.  It can be used with any backend Prolog
compiler.

The ‘nd_assignvars’ object provides a non-declarative but faster
implementation of the ‘assignvarsp’ protocol.  It can be used with the
following backend Prolog compilers: B-Prolog, CxProlog, ECLiPSe, GNU
Prolog, SICStus Prolog, SWI-Prolog, and YAP.

For more information on assignvars, please consult the URL:

‘https://web.archive.org/web/20160818050049/http://www.kprolog.com/en/logical_assignment/’

The representation of assignable terms should be regarded as an opaque
term and only accessed using the library predicates.

* Menu:

* API documentation: API documentation<29>.
* Loading: Loading<30>.
* Testing: Testing<25>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<29>,  Next: Loading<30>,  Up: assignvars

6.10.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#assignvars’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<30>,  Next: Testing<25>,  Prev: API documentation<29>,  Up: assignvars

6.10.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(assignvars(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<25>,  Prev: Loading<30>,  Up: assignvars

6.10.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(assignvars(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: avro,  Next: base32,  Prev: assignvars,  Up: Libraries

6.11 ‘avro’
===========

The ‘avro’ library implements predicates for reading (parsing) and
writing (generating) data in the Apache Avro binary format:

   - ‘https://avro.apache.org/docs/current/specification/’

'This library requires a backend supporting unbounded integer
arithmetic.'

* Menu:

* API documentation: API documentation<30>.
* Loading: Loading<31>.
* Testing: Testing<26>.
* Schema representation::
* Data representation::
* Schema Examples::
* Encoding::
* Decoding::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<30>,  Next: Loading<31>,  Up: avro

6.11.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#avro’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<31>,  Next: Testing<26>,  Prev: API documentation<30>,  Up: avro

6.11.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(avro(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<26>,  Next: Schema representation,  Prev: Loading<31>,  Up: avro

6.11.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(avro(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Schema representation,  Next: Data representation,  Prev: Testing<26>,  Up: avro

6.11.4 Schema representation
----------------------------

Schema files use the ‘.avsc’ extension and their contents are always
valid JSON values.  They can be parsed using the ‘json(curly,dash,atom)’
library object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Data representation,  Next: Schema Examples,  Prev: Schema representation,  Up: avro

6.11.5 Data representation
--------------------------

Data to be serialized to Avro binary format files can be represented in
the JSON Lines format (using the ‘.jsonl’ extension) and parsed using
the ‘json_lines(curly, dash, atom)’ library object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Schema Examples,  Next: Encoding,  Prev: Data representation,  Up: avro

6.11.6 Schema Examples
----------------------

Primitive type schemas:

   - ‘null’

   - ‘boolean’

   - ‘int’

   - ‘long’

   - ‘float’

   - ‘double’

   - ‘bytes’

   - ‘string’

Array schema example represented as a JSON term:

     {type-array, items-int}


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding,  Next: Decoding,  Prev: Schema Examples,  Up: avro

6.11.7 Encoding
---------------

Encoding is accomplished using the ‘generate/3’ or ‘generate/4’
predicates.  For example, assuming the schema is just ‘int’:

     | ?- avro::generate(bytes(Bytes), int, 42).
     Bytes = [84]
     yes

Or an array of ‘int’:

     | ?- avro::generate(bytes(Bytes), {type-array,items-int}, [42,37,13,17]).
     Bytes = [8,84,74,26,34,0]
     yes

To include the schema in the output (as an Avro Object Container File),
use the ‘generate/4’ predicate with the second argument set to ‘true’.
For example:

     | ?- avro::generate(file('output.avro'), true, {type-array,items-int}, [42,37,13,17]).
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding,  Prev: Encoding,  Up: avro

6.11.8 Decoding
---------------

Decoding is accomplished using the ‘parse/2’ or ‘parse/3’ predicates.

When parsing a file that includes a schema (Avro Object Container File),
use ‘parse/2’ which returns a ‘Schema-Data’ pair.  For example:

     | ?- avro::parse(file('input.avro'), Schema-Data).

When the schema is not present in the file, ‘Schema’ is unified with
‘false’.

When parsing with a known schema, use instead the ‘parse/3’ predicate.
For example:

     | ?- avro::parse(bytes([84]), int, Data).
     Data = 42
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: base32,  Next: base58,  Prev: avro,  Up: Libraries

6.12 ‘base32’
=============

The ‘base32’ library provides predicates for encoding and decoding data
in the Base32 format as per the specification found at:

‘https://www.rfc-editor.org/rfc/rfc4648’

* Menu:

* API documentation: API documentation<31>.
* Loading: Loading<32>.
* Testing: Testing<27>.
* Encoding: Encoding<2>.
* Decoding: Decoding<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<31>,  Next: Loading<32>,  Up: base32

6.12.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#base32’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<32>,  Next: Testing<27>,  Prev: API documentation<31>,  Up: base32

6.12.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(base32(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<27>,  Next: Encoding<2>,  Prev: Loading<32>,  Up: base32

6.12.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(base32(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding<2>,  Next: Decoding<2>,  Prev: Testing<27>,  Up: base32

6.12.4 Encoding
---------------

Encoding a list of bytes in Base32 format is accomplished by the
‘base32::generate/2’ predicate.  For example:

     | ?- atom_codes('Hello!', Bytes),
          base32::generate(atom(Base32), Bytes).
     Base32 = 'JBSWY3DPEE======'
     Bytes = [72,101,108,108,111,33]
     yes

     | ?- atom_codes('Hello!', Bytes),
          base32::generate(codes(Base32), Bytes).
     Base32 = [74,66,83,87,89,51,68,80,69,69,61,61,61,61,61,61]
     Bytes = [72,101,108,108,111,33]
     yes

The Base32 result can also be represented using a list of chars, written
to a file or to a stream.  See the API documentation for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding<2>,  Prev: Encoding<2>,  Up: base32

6.12.5 Decoding
---------------

Decoding of Base32 data is accomplished using the ‘base32::parse/2’
predicate.  For example:

     | ?- base32::parse(atom('JBSWY3DPEE======'), Bytes),
          atom_codes(Atom, Bytes).
     Atom = 'Hello!'
     Bytes = [72,101,108,108,111,33]
     yes

     | ?- base32::parse(chars(['J','B','S','W','Y','3','D','P','E','E','=','=','=','=','=','=']), Bytes),
          atom_codes(Atom, Bytes).
     Atom = 'Hello!'
     Bytes = [72,101,108,108,111,33]
     yes

The ‘base32::parse/2’ predicate accepts other input sources such as a
file or a stream.  See the API documentation for details.  Both
uppercase and lowercase letters are accepted when decoding.


File: TheLogtalkHandbook-3.100.1.info,  Node: base58,  Next: base64,  Prev: base32,  Up: Libraries

6.13 ‘base58’
=============

The ‘base58’ library provides predicates for encoding and decoding data
in the Base58 format using the Bitcoin alphabet variant.  Base58 is
commonly used in Bitcoin addresses and other cryptocurrency
applications.  The Bitcoin alphabet excludes visually ambiguous
characters:

   - ‘0’ (zero), ‘O’ (uppercase o)

   - ‘I’ (uppercase i), ‘l’ (lowercase L)

Alphabet: ‘123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz’

For more details, see for example:

‘https://bitcoinwiki.org/wiki/base58’

'This library requires a backend supporting unbounded integer
arithmetic.'

* Menu:

* API documentation: API documentation<32>.
* Loading: Loading<33>.
* Testing: Testing<28>.
* Encoding: Encoding<3>.
* Decoding: Decoding<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<32>,  Next: Loading<33>,  Up: base58

6.13.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#base58’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<33>,  Next: Testing<28>,  Prev: API documentation<32>,  Up: base58

6.13.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(base58(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<28>,  Next: Encoding<3>,  Prev: Loading<33>,  Up: base58

6.13.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(base58(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding<3>,  Next: Decoding<3>,  Prev: Testing<28>,  Up: base58

6.13.4 Encoding
---------------

Encoding a list of bytes in Base58 format is accomplished by the
‘base58::generate/2’ predicate.  For example:

     | ?- atom_codes('Hello World', Bytes),
          base58::generate(atom(Base58), Bytes).
     Base58 = 'JxF12TrwUP45BMd'
     Bytes = [72,101,108,108,111,32,87,111,114,108,100]
     yes

Leading zero bytes are preserved and encoded as ‘1’ characters:

     | ?- base58::generate(atom(Base58), [0, 0, 0, 1, 2, 3]).
     Base58 = '111Ldp'
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding<3>,  Prev: Encoding<3>,  Up: base58

6.13.5 Decoding
---------------

Decoding of Base58 data is accomplished using the ‘base58::parse/2’
predicate.  For example:

     | ?- base58::parse(atom('JxF12TrwUP45BMd'), Bytes),
          atom_codes(Atom, Bytes).
     Atom = 'Hello World'
     Bytes = [72,101,108,108,111,32,87,111,114,108,100]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: base64,  Next: base85,  Prev: base58,  Up: Libraries

6.14 ‘base64’
=============

The ‘base64’ library provides predicates for parsing and generating data
in the Base64 and Base64URL formats as per the specification found at:

‘https://www.rfc-editor.org/rfc/rfc4648’

* Menu:

* API documentation: API documentation<33>.
* Loading: Loading<34>.
* Testing: Testing<29>.
* Encoding: Encoding<4>.
* Decoding: Decoding<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<33>,  Next: Loading<34>,  Up: base64

6.14.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#base64’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<34>,  Next: Testing<29>,  Prev: API documentation<33>,  Up: base64

6.14.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(base64(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<29>,  Next: Encoding<4>,  Prev: Loading<34>,  Up: base64

6.14.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(base64(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding<4>,  Next: Decoding<4>,  Prev: Testing<29>,  Up: base64

6.14.4 Encoding
---------------

Encoding a list of bytes in Base64 format is accomplished by the
‘base64::generate/2’ predicate.  For example:

     | ?- atom_codes('Hello world!', Bytes),
          base64::generate(atom(Base64), Bytes).
     Base64 = 'SGVsbG8gd29ybGQh'
     Bytes = [72,101,108,108,111,32,119,111,114,108,100,33]
     yes

     | ?- atom_codes('Hello world!', Bytes),
          base64::generate(codes(Base64), Bytes).
     Base64 = [83,71,86,115,98,71,56,103,100,50,57,121,98,71,81,104]
     Bytes = [72,101,108,108,111,32,119,111,114,108,100,33]
     yes

The Base64 result can also be represented using a list of chars, written
to a file or to a stream.  See the API documentation for details.

For safe encoding of URLs, use instead the Base64URL format.  For
example:

     | ?- base64url::generate(atom(Base64URL), 'https://logtalk.org').
     Base64URL == 'aHR0cHM6Ly9sb2d0YWxrLm9yZw'
     yes

The Base64URL can also be represented using a list of chars or a list of
codes.  The input URL should be in the same format.


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding<4>,  Prev: Encoding<4>,  Up: base64

6.14.5 Decoding
---------------

Decoding of Base64 data is accomplished using the ‘base64::parse/2’
predicate.  For example:

     | ?- base64::parse(atom('SGVsbG8gd29ybGQh'), Bytes),
          atom_codes(Atom, Bytes).
     Atom = 'Hello world!'
     Bytes = [72,101,108,108,111,32,119,111,114,108,100,33]
     yes

     | ?- base64::parse(chars(['S','G','V',s,b,'G','8',g,d,'2','9',y,b,'G','Q',h]), Bytes),
          atom_codes(Atom, Bytes).
     Atom = 'Hello world!'
     Bytes = [72,101,108,108,111,32,119,111,114,108,100,33]
     yes

The ‘base64::parse/2’ predicate accepts other input source such as a
file or a stream.  See the API documentation for details.

For decoding of URLs in the Base64URL format, use the
‘base64url::parse/2’ predicate.  For example:

     | ?- base64url::parse(atom('aHR0cHM6Ly9sb2d0YWxrLm9yZw'), URL).
     URL == 'https://logtalk.org'
     yes

The ‘base64url::parse/2’ predicate also accepts a list of chars or a
list of codes as input.  See the API documentation for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: base85,  Next: basic_types,  Prev: base64,  Up: Libraries

6.15 ‘base85’
=============

The ‘base85’ library provides predicates for encoding and decoding data
in the Base85 (Ascii85) format.  Ascii85 is used in PostScript and PDF
files.  The encoding uses printable ASCII characters from ‘!’ (33) to
‘u’ (117).  A special shortcut ‘z’ represents four zero bytes.  For more
details, see for example:

‘https://en.wikipedia.org/wiki/Ascii85’

* Menu:

* API documentation: API documentation<34>.
* Loading: Loading<35>.
* Testing: Testing<30>.
* Encoding: Encoding<5>.
* Decoding: Decoding<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<34>,  Next: Loading<35>,  Up: base85

6.15.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#base85’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<35>,  Next: Testing<30>,  Prev: API documentation<34>,  Up: base85

6.15.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(base85(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<30>,  Next: Encoding<5>,  Prev: Loading<35>,  Up: base85

6.15.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(base85(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding<5>,  Next: Decoding<5>,  Prev: Testing<30>,  Up: base85

6.15.4 Encoding
---------------

Encoding a list of bytes in Base85 format is accomplished by the
‘base85::generate/2’ predicate.  For example:

     | ?- atom_codes('Man ', Bytes),
          base85::generate(atom(Base85), Bytes).
     Base85 = '9jqo^'
     Bytes = [77,97,110,32]
     yes

Four zero bytes are encoded as the special character ‘z’:

     | ?- base85::generate(atom(Base85), [0, 0, 0, 0]).
     Base85 = 'z'
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding<5>,  Prev: Encoding<5>,  Up: base85

6.15.5 Decoding
---------------

Decoding of Base85 data is accomplished using the ‘base85::parse/2’
predicate.  For example:

     | ?- base85::parse(atom('9jqo^'), Bytes),
          atom_codes(Atom, Bytes).
     Atom = 'Man '
     Bytes = [77,97,110,32]
     yes

The parser also accepts input with optional ‘<~’ and ‘~>’ delimiters:

     | ?- base85::parse(atom('<~9jqo^~>'), Bytes),
          atom_codes(Atom, Bytes).
     Atom = 'Man '
     Bytes = [77,97,110,32]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: basic_types,  Next: bayesian_ridge_regression,  Prev: base85,  Up: Libraries

6.16 ‘basic_types’
==================

The ‘basic_types’ library is a virtual library that loads only basic
types from the ‘types’ library:

   - ‘comparingp’

   - ‘termp’, ‘term’

   - ‘atomic’, ‘atom’, ‘number’, ‘float’, ‘integer’

   - ‘compound’, ‘listp’, ‘list’

   - ‘type’

* Menu:

* API documentation: API documentation<35>.
* Loading: Loading<36>.
* Testing: Testing<31>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<35>,  Next: Loading<36>,  Up: basic_types

6.16.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#types’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<36>,  Next: Testing<31>,  Prev: API documentation<35>,  Up: basic_types

6.16.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(basic_types(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<31>,  Prev: Loading<36>,  Up: basic_types

6.16.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file for the
‘types’ library:

     | ?- logtalk_load(types(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: bayesian_ridge_regression,  Next: borda_ranker,  Prev: basic_types,  Up: Libraries

6.17 ‘bayesian_ridge_regression’
================================

Bayesian ridge regression regressor supporting continuous and
mixed-feature datasets.  The library implements the ‘regressor_protocol’
defined in the ‘regression_protocols’ library and learns a Bayesian
linear model using evidence maximization for the global weight and noise
precisions together with Gamma hyperpriors over both precision terms.

* Menu:

* API documentation: API documentation<36>.
* Loading: Loading<37>.
* Testing: Testing<32>.
* Features: Features<6>.
* Regressor representation::
* Diagnostics syntax::
* Options: Options<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<36>,  Next: Loading<37>,  Up: bayesian_ridge_regression

6.17.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#bayesian_ridge_regression’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<37>,  Next: Testing<32>,  Prev: API documentation<36>,  Up: bayesian_ridge_regression

6.17.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(bayesian_ridge_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<32>,  Next: Features<6>,  Prev: Loading<37>,  Up: bayesian_ridge_regression

6.17.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(bayesian_ridge_regression(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(bayesian_ridge_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<6>,  Next: Regressor representation,  Prev: Testing<32>,  Up: bayesian_ridge_regression

6.17.4 Features
---------------

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes encoded using reference-level dummy coding
     from the declared dataset attribute values.

   - 'Automatic Hyperparameter Tuning': Learns the global coefficient
     precision and observation-noise precision using MacKay-style
     evidence maximization with configurable Gamma hyperpriors instead
     of a user-supplied ridge penalty.

   - 'Posterior Uncertainty': Exposes predictive Gaussian distributions
     using coefficient posterior uncertainty plus observation noise,
     matching the usual scikit-learn BayesianRidge treatment where the
     intercept is not probabilistic.  Posterior coefficient variances
     are also exposed.

   - 'Feature Scaling': Continuous attributes can be standardized using
     z-score scaling before fitting and prediction.

   - 'Stable Posterior Solves': Evidence-maximization updates clamp the
     learned weight and noise precisions to configurable
     ‘precision_bounds(Min, Max)’ to avoid degenerate zero or infinite
     precision estimates.  Posterior solves use Cholesky factorization
     of positive-definite precision matrices, diagnostics report any
     diagonal jitter applied when factorization retries are needed, and
     the evidence-maximization loop computes the effective degrees of
     freedom from a one-time eigenspectrum of the centered Gram
     surrogate while still switching to a sample-space solve when the
     active encoded feature count exceeds the number of training rows.

   - 'Missing Values': Missing numeric and categorical values
     represented using anonymous variables are encoded using explicit
     missing-value indicator features.

   - 'Unknown Values': Prediction requests containing categorical values
     that are not declared by the dataset raise a domain error.

   - 'Zero-Variance Features': Encoded columns with zero variance are
     excluded from posterior updates and assigned zero mean and zero
     posterior variance.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, Cholesky stabilization attempts and
     applied jitter, Gamma hyperpriors for both precision terms,
     effective precision bounds, learned precisions, learned noise
     variance, final log evidence, the full log-evidence score trace,
     active feature count, posterior variances, intercept treatment,
     convergence metric and status, encoded feature count, and effective
     options.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation,  Next: Diagnostics syntax,  Prev: Features<6>,  Up: bayesian_ridge_regression

6.17.5 Regressor representation
-------------------------------

The learned regressor is represented by default as:

   - ‘bayesian_ridge_regressor(Encoders, Bias, Weights, ActiveFlags,
     PosteriorCovariance, NoiseVariance, Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(Encoders, Bias, Weights, ActiveFlags, PosteriorCovariance,
     NoiseVariance, Diagnostics)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax,  Next: Options<6>,  Prev: Regressor representation,  Up: bayesian_ridge_regression

6.17.6 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(bayesian_ridge_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         solver(cholesky_factorization),
         stabilization_attempts(StabilizationAttempts),
         stabilization_jitter(StabilizationJitter),
         precision_bounds(MinimumPrecision, MaximumPrecision),
         weight_precision_hyperprior(gamma(LambdaShape, LambdaRate)),
         noise_precision_hyperprior(gamma(AlphaShape, AlphaRate)),
         weight_precision(Alpha),
         noise_precision(Beta),
         noise_variance(NoiseVariance),
         log_evidence(LogEvidence),
         scores(Scores),
         active_feature_count(ActiveFeatureCount),
         weight_prior(isotropic_zero_mean_gaussian),
         intercept_treatment(non_probabilistic),
         bias_variance(BiasVariance),
         weight_variances(WeightVariances),
         convergence_metric(coefficient_l1),
         convergence(Convergence),
         iterations(Iterations),
         final_delta(FinalDelta),
         encoded_feature_count(FeatureCount)
     ]

The ‘scores/1’ diagnostic is analogous to scikit-learn ‘scores_’: it
stores the log marginal likelihood at the initial hyperparameters
followed by the value after each evidence-maximization update.  The
final element is identical to ‘log_evidence/1’.

The ‘bias_variance/1’ diagnostic is always ‘0.0’ because the intercept
is treated as a deterministic centering adjustment rather than as a
probabilistic parameter.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<6>,  Prev: Diagnostics syntax,  Up: bayesian_ridge_regression

6.17.7 Options
--------------

The ‘learn/3’ predicate accepts the following options:

   - ‘maximum_iterations/1’: Maximum number of evidence-maximization
     updates.  The default is ‘300’.

   - ‘tolerance/1’: Convergence tolerance on the L1 change between
     consecutive active coefficient vectors across evidence-maximization
     updates.  The default is ‘1.0e-6’.

   - ‘initial_weight_precision/1’: Positive initial value for the shared
     coefficient precision.  The default is ‘1.0’.

   - ‘initial_noise_precision/1’: Positive initial value for the
     observation-noise precision or ‘auto’ to derive it from the target
     variance.  The default is ‘auto’.

   - ‘alpha_1/1’: Non-negative shape hyperparameter of the Gamma prior
     over the learned observation-noise precision.  The default is
     ‘1.0e-6’.

   - ‘alpha_2/1’: Non-negative rate hyperparameter of the Gamma prior
     over the learned observation-noise precision.  The default is
     ‘1.0e-6’.

   - ‘lambda_1/1’: Non-negative shape hyperparameter of the Gamma prior
     over the learned coefficient precision.  The default is ‘1.0e-6’.

   - ‘lambda_2/1’: Non-negative rate hyperparameter of the Gamma prior
     over the learned coefficient precision.  The default is ‘1.0e-6’.

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes before training and prediction.  Accepted values are
     ‘true’ and ‘false’.  The default is ‘true’.

   - ‘precision_bounds/2’: Lower and upper positive bounds used to clamp
     the learned weight and noise precisions during evidence
     maximization for numerical stability.  The default is
     ‘precision_bounds(1.0e-12, 1.0e12)’.


File: TheLogtalkHandbook-3.100.1.info,  Node: borda_ranker,  Next: bradley_terry_ranker,  Prev: bayesian_ridge_regression,  Up: Libraries

6.18 ‘borda_ranker’
===================

Borda grouped-ranking ranker.  Ranks each item by summing, across
groups, the number of same-group items with strictly lower relevance.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from grouped relevance judgments, using it to order candidate
items, and exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘ranking_dataset_protocol’ protocol from the ‘ranking_protocols’
library.  See the ‘test_datasets’ directory for examples.  ‘The training
dataset must declare each group once, use only declared groups and items
in relevance judgments, and assign non-negative integer relevance
values.

* Menu:

* API documentation: API documentation<37>.
* Loading: Loading<38>.
* Testing: Testing<33>.
* Features: Features<7>.
* Scoring semantics::
* Usage: Usage<18>.
* Diagnostics syntax: Diagnostics syntax<2>.
* Options: Options<7>.
* Ranker representation::
* References: References<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<37>,  Next: Loading<38>,  Up: borda_ranker

6.18.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#borda_ranker’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<38>,  Next: Testing<33>,  Prev: API documentation<37>,  Up: borda_ranker

6.18.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(borda_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<33>,  Next: Features<7>,  Prev: Loading<38>,  Up: borda_ranker

6.18.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(borda_ranker(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(borda_ranker(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<7>,  Next: Scoring semantics,  Prev: Testing<33>,  Up: borda_ranker

6.18.4 Features
---------------

   - 'Grouped Relevance Learning': Learns one deterministic item score
     from grouped ranking or relevance-judgment datasets.

   - 'Portable Borda Scoring': Computes scores using only non-negative
     integer grouped relevance judgments and standard Logtalk library
     predicates.  Within each group, an item receives one point for
     every same-group item with strictly lower relevance when using
     ‘tie_scoring(standard)’ and the average of the minimum and maximum
     tied positions when using ‘tie_scoring(fractional)’.

   - 'Deterministic Ranking': Orders candidate items by learned score
     with deterministic tie-breaking.  Ranking ties are broken
     deterministically using the standard term order of the item
     identifiers after sorting by descending score.

   - 'Missing relevance semantics': Missing relevance facts are treated
     as zero by default using the ‘missing_relevance(zero)’ option and
     can be rejected using ‘missing_relevance(error)’.

   - 'Strict Dataset Validation': Rejects duplicate groups, duplicate
     items within a group, undeclared groups or items in relevance
     judgments, and non-integer or negative relevance values.

   - 'Explicit Semantics Options': The ‘learn/3’ predicate exposes the
     current tie and missing-relevance policies using the
     ‘tie_scoring/1’ and ‘missing_relevance/1’ options.

   - 'Benchmark Coverage': Includes a dedicated performance suite for a
     large grouped dataset benchmark.

   - 'Training Diagnostics': Learned rankers include dataset summary
     metadata that can be accessed using the ‘diagnostics/2’ predicate.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Ranking Infrastructure': Uses the common
     ‘ranking_protocols’ helper predicates for option processing,
     dataset validation, diagnostics, export, and candidate ranking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoring semantics,  Next: Usage<18>,  Prev: Features<7>,  Up: borda_ranker

6.18.5 Scoring semantics
------------------------

This implementation uses a grouped Borda count variant over the declared
items of each group.  With the default ‘tie_scoring(standard)’ option,
an item receives one point for every same-group item with strictly lower
relevance.  Tied items therefore receive the same per-group
contribution, because equal relevance values do not add or subtract
points.

With the ‘tie_scoring(fractional)’ option, each tied relevance class
receives the average of the minimum and maximum per-group Borda points
available to that tie block.  For example, when two items tie above a
single lower-ranked item, both tied items receive ‘1.5’ points instead
of the ‘1’ point assigned by the default policy.

Missing relevance facts are treated as relevance ‘0’ only for items that
are declared in the group when using the default
‘missing_relevance(zero)’ option.  This allows grouped datasets to omit
explicit zero judgments while keeping the score computation
deterministic.  Use ‘missing_relevance(error)’ to reject grouped
datasets that omit a declared item relevance.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<18>,  Next: Diagnostics syntax<2>,  Prev: Scoring semantics,  Up: borda_ranker

6.18.6 Usage
------------

* Menu:

* Learning a ranker::
* Inspecting diagnostics::
* Ranking candidate items::
* Exporting the ranker::


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker,  Next: Inspecting diagnostics,  Up: Usage<18>

6.18.6.1 Learning a ranker
..........................

     % Learn from a grouped ranking dataset object
     | ?- borda_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with an explicit empty options list
     | ?- borda_ranker::learn(my_dataset, Ranker, []).
     ...

     % Learn while requiring every declared group item to have a relevance fact
     | ?- borda_ranker::learn(my_dataset, Ranker, [missing_relevance(error)]).
     ...

     % Learn using fractional tie scoring for tied relevance levels
     | ?- borda_ranker::learn(my_dataset, Ranker, [tie_scoring(fractional)]).
     ...

The current implementation accepts the ‘missing_relevance/1’ and
‘tie_scoring/1’ options described below.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics,  Next: Ranking candidate items,  Prev: Learning a ranker,  Up: Usage<18>

6.18.6.2 Inspecting diagnostics
...............................

     % Inspect model and dataset summary metadata
     | ?- borda_ranker::learn(my_dataset, Ranker),
          borda_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items,  Next: Exporting the ranker,  Prev: Inspecting diagnostics,  Up: Usage<18>

6.18.6.3 Ranking candidate items
................................

     % Rank a candidate set from most preferred to least preferred
     | ?- borda_ranker::learn(my_dataset, Ranker),
          borda_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker,  Prev: Ranking candidate items,  Up: Usage<18>

6.18.6.4 Exporting the ranker
.............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- borda_ranker::learn(my_dataset, Ranker),
          borda_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(borda_ranker(...))]
     ...

     % Export to a file
     | ?- borda_ranker::learn(my_dataset, Ranker),
          borda_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<2>,  Next: Options<7>,  Prev: Usage<18>,  Up: borda_ranker

6.18.7 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(borda_ranker),
         options(Options),
         dataset_summary(DatasetSummary)
     ]

Where:

   - ‘model(borda_ranker)’ identifies the learning algorithm that
     produced the ranker.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘dataset_summary(DatasetSummary)’ stores a summary list describing
     the validated training dataset.

The current ‘dataset_summary/1’ payload has the form:

     [
         groups(NumberOfGroups),
         items(NumberOfItems),
         relevance_judgments(NumberOfJudgments)
     ]

Use the ‘ranking_protocols’ ‘diagnostic/2’ and ‘ranker_options/2’ helper
predicates when you only need a single metadata term or the effective
options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<7>,  Next: Ranker representation,  Prev: Diagnostics syntax<2>,  Up: borda_ranker

6.18.8 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘missing_relevance(Policy)’: Controls how declared group items
     without an explicit relevance fact are handled.  The supported
     values are ‘zero’ (default) and ‘error’.

   - ‘tie_scoring(Policy)’: Controls the grouped Borda tie semantics.
     The current implementation supports ‘standard’ (minimum tied-block
     score) and ‘fractional’ (average tied-block score).


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation,  Next: References<3>,  Prev: Options<7>,  Up: borda_ranker

6.18.9 Ranker representation
----------------------------

The learned ranker is represented by a compound term of the form:

     borda_ranker(Items, Scores, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Score’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options and dataset summary.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
ranker term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<3>,  Prev: Ranker representation,  Up: borda_ranker

6.18.10 References
------------------

  1. de Borda, J.-C. (1781).  Mémoire sur les élections au scrutin.
     'Histoire de l’Académie Royale des Sciences'.


File: TheLogtalkHandbook-3.100.1.info,  Node: bradley_terry_ranker,  Next: c45_classifier,  Prev: borda_ranker,  Up: Libraries

6.19 ‘bradley_terry_ranker’
===========================

Bradley-Terry pairwise preference ranker.  Uses a deterministic
minorization-maximization update to estimate one relative strength
parameter per item from weighted pairwise wins and losses.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The training dataset must declare each ranked item once,
enumerate positive-weight pairwise preferences between distinct declared
items, induce a connected undirected comparison graph, and induce a
strongly connected directed win graph so that a finite Bradley-Terry
maximum-likelihood estimate exists.

* Menu:

* API documentation: API documentation<38>.
* Loading: Loading<39>.
* Testing: Testing<34>.
* Features: Features<8>.
* Dataset requirements::
* Usage: Usage<19>.
* Diagnostics syntax: Diagnostics syntax<3>.
* Options: Options<8>.
* Ranker representation: Ranker representation<2>.
* References: References<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<38>,  Next: Loading<39>,  Up: bradley_terry_ranker

6.19.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#bradley_terry_ranker’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<39>,  Next: Testing<34>,  Prev: API documentation<38>,  Up: bradley_terry_ranker

6.19.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(bradley_terry_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<34>,  Next: Features<8>,  Prev: Loading<39>,  Up: bradley_terry_ranker

6.19.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(bradley_terry_ranker(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(bradley_terry_ranker(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<8>,  Next: Dataset requirements,  Prev: Testing<34>,  Up: bradley_terry_ranker

6.19.4 Features
---------------

   - 'Pairwise Preference Learning': Learns relative item strengths from
     weighted head-to-head outcomes.

   - 'Original MM Fidelity': Rejects datasets without a finite
     Bradley-Terry maximum-likelihood estimate instead of masking them
     with implicit strength flooring or other hidden regularization.

   - 'Deterministic Ranking': Orders candidate items by learned strength
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, disconnected
     comparison graphs, and pairwise datasets that do not admit a finite
     Bradley-Terry maximum- likelihood estimate.

   - 'Training Diagnostics': Learned rankers include convergence and
     dataset summary metadata that can be accessed using the
     ‘diagnostics/2’ predicate.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Sparse Comparison Processing': Training aggregates weighted
     comparisons into sparse adjacency lists so iteration cost scales
     with observed pairwise comparisons instead of the full dense item
     cross-product.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dataset requirements,  Next: Usage<19>,  Prev: Features<8>,  Up: bradley_terry_ranker

6.19.5 Dataset requirements
---------------------------

This implementation requires more than undirected connectedness.  In
order to admit a finite Bradley-Terry maximum-likelihood estimate, the
directed win graph induced by the preferences must be strongly
connected.  Datasets that leave one or more items isolated, split the
undirected comparison graph into multiple components, or create
dominance partitions with no directed path back to stronger items are
rejected instead of producing degenerate strengths.

For a related MAP formulation that keeps the same pairwise-preference
setting but uses an explicit Gamma prior to admit connected datasets
whose directed win graph is not strongly connected, see the
‘regularized_bradley_terry_ranker’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<19>,  Next: Diagnostics syntax<3>,  Prev: Dataset requirements,  Up: bradley_terry_ranker

6.19.6 Usage
------------

* Menu:

* Learning a ranker: Learning a ranker<2>.
* Inspecting diagnostics: Inspecting diagnostics<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<2>,  Next: Inspecting diagnostics<2>,  Up: Usage<19>

6.19.6.1 Learning a ranker
..........................

     % Learn from a pairwise ranking dataset object
     | ?- bradley_terry_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with custom iteration and convergence options
     | ?- bradley_terry_ranker::learn(my_dataset, Ranker, [maximum_iterations(500), tolerance(1.0e-7)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<2>,  Prev: Learning a ranker<2>,  Up: Usage<19>

6.19.6.2 Inspecting diagnostics
...............................

     % Inspect convergence and dataset summary metadata
     | ?- bradley_terry_ranker::learn(my_dataset, Ranker),
          bradley_terry_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<3>,  Next: Options<8>,  Prev: Usage<19>,  Up: bradley_terry_ranker

6.19.7 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(bradley_terry_ranker),
         options(Options),
         convergence(Status),
         iterations(Iterations),
         final_delta(FinalDelta),
         dataset_summary(DatasetSummary)
     ]

Where:

   - ‘model(bradley_terry_ranker)’ identifies the learning algorithm
     that produced the ranker.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘convergence(Status)’ records the training stop condition.  The
     current values are ‘converged’ and ‘maximum_iterations_exhausted’.

   - ‘iterations(Iterations)’ stores the number of update iterations
     that were executed.

   - ‘final_delta(FinalDelta)’ stores the maximum absolute strength
     update in the last iteration.

   - ‘dataset_summary(DatasetSummary)’ stores a summary list describing
     the validated training dataset.

The current ‘dataset_summary/1’ payload has the form:

     [
         items(NumberOfItems),
         preferences(NumberOfPreferences),
         connected_components(NumberOfComponents),
         isolated_items(IsolatedItems)
     ]

Where ‘IsolatedItems’ is the list of declared items that have no
comparisons.  For valid Bradley-Terry training datasets this list is
expected to be empty, because disconnected datasets are rejected.

For example, learning from the ‘head_to_head’ test dataset currently
returns diagnostics with the structure:

     [
         model(bradley_terry_ranker),
         options([maximum_iterations(5000), tolerance(1.0e-6)]),
         convergence(converged),
         iterations(...),
         final_delta(...),
         dataset_summary([
             items(4),
             preferences(6),
             connected_components(1),
             isolated_items([])
         ])
     ]

Use the ‘ranking_protocols’ ‘diagnostic/2’ and ‘ranker_options/2’ helper
predicates when you only need a single metadata term or the effective
options.

* Menu:

* Ranking candidate items: Ranking candidate items<2>.
* Exporting the ranker: Exporting the ranker<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<2>,  Next: Exporting the ranker<2>,  Up: Diagnostics syntax<3>

6.19.7.1 Ranking candidate items
................................

     % Rank a candidate set from most preferred to least preferred
     | ?- bradley_terry_ranker::learn(my_dataset, Ranker),
          bradley_terry_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<2>,  Prev: Ranking candidate items<2>,  Up: Diagnostics syntax<3>

6.19.7.2 Exporting the ranker
.............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- bradley_terry_ranker::learn(my_dataset, Ranker),
          bradley_terry_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(bt_ranker(...))]
     ...

     % Export to a file
     | ?- bradley_terry_ranker::learn(my_dataset, Ranker),
          bradley_terry_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<8>,  Next: Ranker representation<2>,  Prev: Diagnostics syntax<3>,  Up: bradley_terry_ranker

6.19.8 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘maximum_iterations(MaximumIterations)’: Positive integer iteration
     bound.

   - ‘tolerance(Tolerance)’: Positive convergence tolerance.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<2>,  Next: References<4>,  Prev: Options<8>,  Up: bradley_terry_ranker

6.19.9 Ranker representation
----------------------------

The learned ranker is represented by a compound term of the form:

     bt_ranker(Items, Strengths, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Strength’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, convergence status, iteration count, final update delta,
     and dataset summary.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
ranker term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<4>,  Prev: Ranker representation<2>,  Up: bradley_terry_ranker

6.19.10 References
------------------

  1. Bradley, R. A. and Terry, M. E. (1952).  Rank analysis of
     incomplete block designs: I. The method of paired comparisons.
     'Biometrika', 39(3/4), 324-345.

  2. Hunter, D. R. (2004).  MM algorithms for generalized Bradley-Terry
     models.  'The Annals of Statistics', 32(1), 384-406.


File: TheLogtalkHandbook-3.100.1.info,  Node: c45_classifier,  Next: cartesian_products,  Prev: bradley_terry_ranker,  Up: Libraries

6.20 ‘c45_classifier’
=====================

This library implements the C4.5 decision tree learning algorithm.  C4.5
is an extension of the ID3 algorithm that uses information gain ratio
instead of information gain for attribute selection, which avoids bias
towards attributes with many values (see below for implementation
details).

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a decision tree from a dataset, optionally prune it, using it to make
predictions, and exporting it as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  See ‘test_files’
directory for examples.

* Menu:

* API documentation: API documentation<39>.
* Loading: Loading<40>.
* Testing: Testing<35>.
* Implemented features::
* Learned tree representation::
* Limitations: Limitations<2>.
* References: References<5>.
* Usage: Usage<20>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<39>,  Next: Loading<40>,  Up: c45_classifier

6.20.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#c45_classifier’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<40>,  Next: Testing<35>,  Prev: API documentation<39>,  Up: c45_classifier

6.20.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(c45_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<35>,  Next: Implemented features,  Prev: Loading<40>,  Up: c45_classifier

6.20.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(c45_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Implemented features,  Next: Learned tree representation,  Prev: Testing<35>,  Up: c45_classifier

6.20.4 Implemented features
---------------------------

   - Information gain ratio for attribute selection (avoids bias towards
     attributes with many values)

   - Handling of discrete (categorical) attributes with multi-way splits

   - Handling of continuous (numeric) attributes with binary threshold
     splits (selects the threshold with the highest gain ratio from
     midpoints between consecutive sorted values)

   - Handling of missing attribute values (represented using anonymous
     variables): examples with missing values for an attribute are
     distributed to all branches during tree construction; gain ratio
     computation uses only examples with known values for the attribute
     being evaluated; prediction with missing values uses majority
     voting by exploring all possible branches and selecting the most
     common class

   - Tree pruning using pessimistic error pruning (PEP): estimates error
     rates using the upper confidence bound of the binomial distribution
     (Wilson score interval) with a configurable confidence factor
     (default 0.25) and minimum instances per leaf (default 2); replaces
     subtrees with leaf nodes when doing so would not increase the
     estimated error; helps reduce overfitting and improve
     generalization

   - Export of learned decision trees as predicate clauses

   - Pretty-printing of learned decision trees


File: TheLogtalkHandbook-3.100.1.info,  Node: Learned tree representation,  Next: Limitations<2>,  Prev: Implemented features,  Up: c45_classifier

6.20.5 Learned tree representation
----------------------------------

For discrete attributes, the learned decision tree is represented as
‘leaf(Class)’ for leaf nodes and ‘tree(Attribute, Subtrees)’ for
internal nodes with discrete attributes, where ‘Subtrees’ is a list of
‘Value-Subtree’ pairs.

For continuous (numeric) attributes, the tree uses binary threshold
splits represented as ‘tree(Attribute, threshold(Threshold),
LeftSubtree, RightSubtree)’ where ‘LeftSubtree’ corresponds to values
‘=< Threshold’ and ‘RightSubtree’ to values ‘> Threshold’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Limitations<2>,  Next: References<5>,  Prev: Learned tree representation,  Up: c45_classifier

6.20.6 Limitations
------------------

   - No incremental learning (the tree must be rebuilt from scratch when
     new examples are added)


File: TheLogtalkHandbook-3.100.1.info,  Node: References<5>,  Next: Usage<20>,  Prev: Limitations<2>,  Up: c45_classifier

6.20.7 References
-----------------

   - Quinlan, J.R. (1986).  Induction of Decision Trees.  'Machine
     Learning', 1(1), 81-106.  ‘https://doi.org/10.1007/BF00116251’

   - Quinlan, J.R. (1993).  'C4.5: Programs for Machine Learning'.
     Morgan Kaufmann Publishers.
     ‘https://doi.org/10.1016/C2009-0-27846-9’

   - Mitchell, T.M. (1997).  'Machine Learning'.  McGraw-Hill.  Chapter
     3: Decision Tree Learning.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<20>,  Prev: References<5>,  Up: c45_classifier

6.20.8 Usage
------------

To learn a decision tree from a dataset:

     | ?- c45_classifier::learn(play_tennis, Tree).

To prune a learned tree with the default parameters (confidence factor
0.25, minimum instances per leaf 2):

     | ?- c45_classifier::learn(breast_cancer, Tree),
          c45_classifier::prune(breast_cancer, Tree, PrunedTree).

To prune a learned tree with both custom confidence factor and minimum
instances per leaf:

     | ?- c45_classifier::learn(breast_cancer, Tree),
          c45_classifier::prune(breast_cancer, Tree, 0.1, 3, PrunedTree).

To export the tree as a list of predicate clauses:

     | ?- c45_classifier::learn(play_tennis, Tree),
          c45_classifier::tree_to_clauses(play_tennis, Tree, classify, Clauses).

To export the tree to a file:

     | ?- c45_classifier::learn(play_tennis, Tree),
          c45_classifier::tree_to_file(play_tennis, Tree, classify, 'tree.pl').

To print the tree to the current output:

     | ?- c45_classifier::learn(play_tennis, Tree),
          c45_classifier::print_tree(Tree).

To predict the class for a new instance (as a list of attribute-value
pairs):

     | ?- c45_classifier::learn(play_tennis, Tree),
          c45_classifier::predict(Tree, [outlook-sunny, temperature-hot, humidity-high, wind-weak], Class).


File: TheLogtalkHandbook-3.100.1.info,  Node: cartesian_products,  Next: cbor,  Prev: c45_classifier,  Up: Libraries

6.21 ‘cartesian_products’
=========================

This library provides predicates for generating and querying Cartesian
products over lists.  The following categories of predicates are
provided:

   - 'Generation operations' - Predicates for generating Cartesian
     products and tuples.

   - 'Ordering variants' - Predicates that support an additional order
     argument (‘default’ or ‘lexicographic’) for controlling output
     order.

   - 'Distinct-value generation' - Predicates for generating tuples
     while deduplicating repeated values in factor lists.

   - 'Indexed access' - Predicates for direct access to tuples at
     specific positions.

   - 'Lexicographic stepping' - Predicates for navigating tuples in
     lexicographic order.

   - 'Counting operations' - Predicates for counting tuples without
     generating them.

   - 'Random selection' - Predicates for randomly selecting and sampling
     tuples.

Dedicated ‘arrangements’, ‘permutations’, ‘combinations’, ‘multisets’,
‘derangements’, ‘partitions’, and ‘subsequences’ libraries are also
available for focused APIs on related operations.

* Menu:

* API documentation: API documentation<40>.
* Loading: Loading<41>.
* Testing: Testing<36>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<40>,  Next: Loading<41>,  Up: cartesian_products

6.21.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#cartesian_products’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<41>,  Next: Testing<36>,  Prev: API documentation<40>,  Up: cartesian_products

6.21.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(cartesian_products(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<36>,  Prev: Loading<41>,  Up: cartesian_products

6.21.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(cartesian_products(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: cbor,  Next: character_sets,  Prev: cartesian_products,  Up: Libraries

6.22 ‘cbor’
===========

The ‘cbor’ library implements predicates for importing and exporting
data in the Concise Binary Object Representation (CBOR) format:

   - ‘https://www.rfc-editor.org/rfc/rfc8949.html’

   - ‘http://cbor.io/’

This library is a work-in-progress.  Currently it requires a backend
supporting unbounded integer arithmetic.

* Menu:

* Representation::
* Encoding: Encoding<6>.
* Decoding: Decoding<6>.
* API documentation: API documentation<41>.
* Loading: Loading<42>.
* Testing: Testing<37>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation,  Next: Encoding<6>,  Up: cbor

6.22.1 Representation
---------------------

   - Maps are represented using curly-bracketed terms, ‘{Pairs}’, where
     each pair uses the representation ‘Key-Value’.

   - Arrays are represented using lists.

   - Byte strings uses ‘bytes(List)’ compound terms.

   - Text strings can be represented as atoms, ‘chars(List)’, or
     ‘codes(List)’.  The default when decoding is to use atoms when
     using the ‘cbor’ object.  To decode text strings into lists of
     chars or code, use the ‘cbor/1’ with the parameter bound to ‘chars’
     or ‘codes’.  For example:

          | ?- cbor::parse([0x65,0x68,0x65,0x6c,0x6c,0x6f], Term).
          Term = hello
          yes

          | ?- cbor(atom)::parse([0x65,0x68,0x65,0x6c,0x6c,0x6f], Term).
          Term = hello
          yes

          | ?- cbor(chars)::parse([0x65,0x68,0x65,0x6c,0x6c,0x6f], Term).
          Term = chars([h,e,l,l,o])
          yes

          | ?- cbor(codes)::parse([0x65,0x68,0x65,0x6c,0x6c,0x6f], Term).
          Term = codes([104,101,108,108,111])
          yes

   - Tagged data uses ‘tag(Tag, Data)’ compound terms.

   - Simple values can be represented using ‘simple(Simple)’ compound
     terms.

   - The CBOR elements ‘false’, ‘true’, ‘null’, and ‘undefined’ are
     represented by, respectively, the ‘@false’, ‘@true’, ‘@null’, and
     ‘@undefined’ compound terms.

   - The compound terms ‘@infinity’, ‘@negative_infinity’, and
     ‘@not_a_number’ are used to represent the corresponding CBOR
     elements.

   - Only some backends distinguish between positive zero and negative
     zero.  The compound terms ‘@zero’ and ‘@negative_zero’ can be used
     as an alternative for encoding.  The decoder, however, produces the
     ‘0.0’ and ‘-0.0’ floats.


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding<6>,  Next: Decoding<6>,  Prev: Representation,  Up: cbor

6.22.2 Encoding
---------------

Encoding is accomplished using the ‘generate/2’ predicate.  For example:

     | ?- cbor::generate([a,{b-c}], Encoding).
     Encoding = [0x9f,0x61,0x61,0xbf,0x61,0x62,0x61,0x63,0xff,0xff]
     yes

The encoding of arrays and maps uses indefinite-length encoding.  All
floats are currently encoded using decimal fractions.  Encoding
indicators and big floats are not currently supported.


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding<6>,  Next: API documentation<41>,  Prev: Encoding<6>,  Up: cbor

6.22.3 Decoding
---------------

Decoding is accomplished using the ‘parse/2’ predicate.  For example:

     | ?- cbor::parse([0x9f,0x61,0x61,0xbf,0x61,0x62,0x61,0x63,0xff,0xff], Term).
     Term = [a,{b-c}]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<41>,  Next: Loading<42>,  Prev: Decoding<6>,  Up: cbor

6.22.4 API documentation
------------------------

Open the ‘../../apis/library_index.html#cbor’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<42>,  Next: Testing<37>,  Prev: API documentation<41>,  Up: cbor

6.22.5 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(cbor(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<37>,  Prev: Loading<42>,  Up: cbor

6.22.6 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(cbor(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: character_sets,  Next: ccsds_frames,  Prev: cbor,  Up: Libraries

6.23 ‘character_sets’
=====================

This library provides a ‘character_set_protocol’ protocol plus concrete
objects for converting between lists of character codes and lists of
bytes.  It also provides metadata predicates ‘preferred_mime_name/1’,
‘name/1’, ‘alias/1’, and ‘mibenum/1’ based on the IANA character set
registry:

‘https://www.iana.org/assignments/character-sets/character-sets.xhtml’

The currently provided objects are:

   - ‘us_ascii’

   - ‘iso_8859_1’

   - ‘iso_8859_2’

   - ‘iso_8859_3’

   - ‘iso_8859_4’

   - ‘iso_8859_9’

   - ‘iso_8859_10’

   - ‘iso_8859_13’

   - ‘iso_8859_14’

   - ‘iso_8859_15’

   - ‘iso_8859_16’

   - ‘windows_1250’

   - ‘windows_1251’

   - ‘windows_1252’

   - ‘windows_1253’

   - ‘windows_1254’

   - ‘windows_1257’

   - ‘utf_8’

   - ‘utf_16le’

   - ‘utf_16be’

   - ‘utf_32le’

   - ‘utf_32be’

Object names are derived from the preferred IANA MIME names by
lowercasing them and replacing hyphens with underscores.  When a
registry entry has no distinct preferred MIME alias, the registered IANA
name is used instead.  A compatibility alias object named ‘utf16be’ is
also provided for ‘utf_16be’.

The Unicode character set objects work with Unicode scalar values and do
not emit or consume a byte order mark (BOM).

This library intentionally does not currently provide ‘Shift_JIS’ or
‘GB18030’ objects because portable mapping tables for those multibyte
encodings are not yet included.

No input validation is performed when converting between character codes
and bytes.  When necessary, use the ‘types’ library validation and
checking predicates before calling the ‘codes_to_bytes/2’ and
‘bytes_to_codes/2’ predicates.

* Menu:

* API documentation: API documentation<42>.
* Loading: Loading<43>.
* Testing: Testing<38>.
* Usage: Usage<21>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<42>,  Next: Loading<43>,  Up: character_sets

6.23.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#character_sets’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<43>,  Next: Testing<38>,  Prev: API documentation<42>,  Up: character_sets

6.23.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(character_sets(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<38>,  Next: Usage<21>,  Prev: Loading<43>,  Up: character_sets

6.23.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(character_sets(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<21>,  Prev: Testing<38>,  Up: character_sets

6.23.4 Usage
------------

The UTF, ISO 8859, and Windows character set objects are grouped in
three main files:

   - ‘utf_character_sets.lgt’

   - ‘iso_8859_character_sets.lgt’

   - ‘windows_character_sets.lgt’

This allows some customization of the character set objects loaded by
your application.  Note that the ‘character_set_protocol.lgt’ and
‘character_sets.lgt’ base files must always be loaded (they include the
‘us_ascii’ character set, which is thus always loaded).


File: TheLogtalkHandbook-3.100.1.info,  Node: ccsds_frames,  Next: ccsds_link_profiles,  Prev: character_sets,  Up: Libraries

6.24 ‘ccsds_frames’
===================

The ‘ccsds_frames’ library provides support for CCSDS transfer frames.
The current implementation includes CCSDS telemetry transfer frames and
CCSDS telecommand transfer frames, plus CCSDS advanced orbiting systems
transfer frames, all using fixed frame lengths and optional
mission-profile fields configured at the object level.

* Menu:

* Available entities::
* Representation: Representation<2>.
* Parsing and generating::
* Types::
* Facade helpers::
* API documentation: API documentation<43>.
* Loading: Loading<44>.
* Testing: Testing<39>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Available entities,  Next: Representation<2>,  Up: ccsds_frames

6.24.1 Available entities
-------------------------

   - ‘ccsds_frame_protocol’ Common protocol for transfer frame format
     objects.

   - ‘ccsds_frames’ Facade object for introspecting frame terms and
     bridging raw frame data fields with CCSDS space packets.

   - ‘ccsds_tm_frames(FrameLength, SecondaryHeaderLength, HasFECF)’
     Parametric object implementing parsing, generation, and accessors
     for CCSDS telemetry transfer frames.

   - ‘ccsds_tc_frames(FrameLength, SegmentHeaderLength, HasFECF)’
     Parametric object implementing parsing, generation, and accessors
     for CCSDS telecommand transfer frames.

   - ‘ccsds_aos_frames(FrameLength, InsertZoneLength, HasOCF, HasFECF)’
     Parametric object implementing parsing, generation, and accessors
     for CCSDS advanced orbiting systems transfer frames.

   - ‘ccsds_frames_types’ Type definitions for TM, TC, and AOS transfer
     frame byte encodings and terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<2>,  Next: Parsing and generating,  Prev: Available entities,  Up: ccsds_frames

6.24.2 Representation
---------------------

Telemetry transfer frames are represented using the compound term:

     tm_transfer_frame(
         Version,
         SpacecraftId,
         VirtualChannelId,
         OCFFlag,
         MasterChannelFrameCount,
         VirtualChannelFrameCount,
         SecondaryHeaderFlag,
         SynchronizationFlag,
         PacketOrderFlag,
         SegmentLengthIdentifier,
         FirstHeaderPointer,
         SecondaryHeader,
         DataField,
         OCF,
         FECF
     )

Where:

   - ‘SecondaryHeader’ is either ‘none’ or ‘secondary_header(Bytes)’

   - ‘OCF’ is either ‘none’ or ‘ocf(Bytes)’

   - ‘FECF’ is either ‘none’ or ‘fecf(Bytes)’

Telecommand transfer frames are represented using the compound term:

tc_transfer_frame( Version, BypassFlag, ControlCommandFlag,
SpacecraftId, VirtualChannelId, SequenceNumber, SegmentHeader,
DataField, FECF )

Where:

   - ‘SegmentHeader’ is either ‘none’ or ‘segment_header(Bytes)’

   - ‘FECF’ is either ‘none’ or ‘fecf(Bytes)’

Advanced orbiting systems transfer frames are represented using the
compound term:

aos_transfer_frame( Version, SpacecraftId, VirtualChannelId,
VirtualChannelFrameCount, SignalingField, InsertZone, DataField, OCF,
FECF )

Where:

   - ‘SignalingField’ is ‘signaling_field(ReplayFlag,
     FrameCountUsageFlag, SpacecraftIdExtension, FrameCountCycle)’

   - ‘InsertZone’ is either ‘none’ or ‘insert_zone(Bytes)’

   - ‘OCF’ is either ‘none’ or ‘ocf(Bytes)’

   - ‘FECF’ is either ‘none’ or ‘fecf(Bytes)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing and generating,  Next: Types,  Prev: Representation<2>,  Up: ccsds_frames

6.24.3 Parsing and generating
-----------------------------

To parse a fixed 16-octet telemetry transfer frame without a telemetry
transfer frame secondary header and without a frame error control field:

     | ?- ccsds_tm_frames(16, 0, false)::parse(bytes([0x02, 0xA7, 0x10, 0x20, 0x18, 0x00, 1, 2, 3, 4, 5, 6, 0xDE, 0xAD, 0xBE, 0xEF]), Frames).

To generate the original byte sequence from the parsed term:

     | ?- ccsds_tm_frames(16, 0, false)::generate(bytes(Bytes), Frames).

To parse a fixed 10-octet telecommand transfer frame without a segment
header:

| ?- ccsds_tc_frames(10, 0, true)::parse(bytes([0x20, 0x2A, 0x0C, 0x09,
0x07, 1, 2, 3, 0x44, 0x6D]), Frames).

To generate the original byte sequence from the parsed term:

| ?- ccsds_tc_frames(10, 0, true)::generate(bytes(Bytes), Frames).

When FECF support is enabled for a frame object, parsing verifies the
incoming FECF, ‘valid/1’ checks that it matches the remaining frame
fields, and ‘generate/2-3’ recomputes it from the remaining frame
content.  The parametric frame objects also provide ‘update_fecf/2’ and
‘verify_fecf/1’ for explicit integrity handling:

| ?- ccsds_tc_frames(10, 0, true)::update_fecf(tc_transfer_frame(0, 1,
0, 42, 3, 7, none, [1,2,3], none), Frame).

| ?- ccsds_tc_frames(10, 0, true)::verify_fecf(Frame).

To parse a fixed 12-octet AOS transfer frame without an insert zone,
OCF, or FECF:

| ?- ccsds_aos_frames(12, 0, false, false)::parse(bytes([0x4A, 0x83,
0x12, 0x34, 0x56, 0x80, 1, 2, 3, 4, 5, 6]), Frames).

To generate the original byte sequence from the parsed term:

| ?- ccsds_aos_frames(12, 0, false, false)::generate(bytes(Bytes),
Frames).


File: TheLogtalkHandbook-3.100.1.info,  Node: Types,  Next: Facade helpers,  Prev: Parsing and generating,  Up: ccsds_frames

6.24.4 Types
------------

The ‘ccsds_frames_types’ category defines the following types:

   - ‘ccsds_tm_frame(FrameLength, SecondaryHeaderLength, HasFECF)’ for
     byte encodings

   - ‘ccsds_tm_frame_term(FrameLength, SecondaryHeaderLength, HasFECF)’
     for frame terms

   - ‘ccsds_tc_frame(FrameLength, SegmentHeaderLength, HasFECF)’ for
     byte encodings

   - ‘ccsds_tc_frame_term(FrameLength, SegmentHeaderLength, HasFECF)’
     for frame terms

   - ‘ccsds_aos_frame(FrameLength, InsertZoneLength, HasOCF, HasFECF)’
     for byte encodings

   - ‘ccsds_aos_frame_term(FrameLength, InsertZoneLength, HasOCF,
     HasFECF)’ for frame terms

For example:

     | ?- type::check(ccsds_tm_frame(16, 0, false), [0x02, 0xA7, 0x10, 0x20, 0x18, 0x00, 1, 2, 3, 4, 5, 6, 0xDE, 0xAD, 0xBE, 0xEF]).

     | ?- type::check(ccsds_tm_frame_term(16, 0, false), tm_transfer_frame(0, 42, 3, 1, 16, 32, 0, 0, 0, 3, 0, none, [1,2,3,4,5,6], ocf([0xDE,0xAD,0xBE,0xEF]), none)).

     | ?- type::check(ccsds_tc_frame(10, 0, true), [0x20, 0x2A, 0x0C, 0x09, 0x07, 1, 2, 3, 0x44, 0x6D]).

     | ?- type::check(ccsds_tc_frame_term(10, 0, true), tc_transfer_frame(0, 1, 0, 42, 3, 7, none, [1,2,3], fecf([0x44,0x6D]))).

     | ?- type::check(ccsds_aos_frame(12, 0, false, false), [0x4A, 0x83, 0x12, 0x34, 0x56, 0x80, 1, 2, 3, 4, 5, 6]).

     | ?- type::check(ccsds_aos_frame_term(12, 0, false, false), aos_transfer_frame(1, 42, 3, 0x123456, signaling_field(1, 0, 0, 0), none, [1,2,3,4,5,6], none, none)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Facade helpers,  Next: API documentation<43>,  Prev: Types,  Up: ccsds_frames

6.24.5 Facade helpers
---------------------

The ‘ccsds_frames’ facade object provides generic accessors that work
across TM, TC, and AOS frame terms:

   - ‘frame_type/2’

   - ‘version/2’

   - ‘spacecraft_id/2’

   - ‘virtual_channel_id/2’

   - ‘data_field/2’

   - ‘ocf/2’

   - ‘fecf/2’

   - ‘update_fecf/2’

   - ‘verify_fecf/1’

It also provides raw payload bridge helpers for CCSDS space packets:

   - ‘extract_packets(Frame, SecondaryHeaderLength, Packets)’ parses the
     frame data field bytes using
     ‘ccsds_packets(SecondaryHeaderLength)’.

   - ‘insert_packets(Packets, SecondaryHeaderLength, Frame,
     UpdatedFrame)’ generates packet bytes using
     ‘ccsds_packets(SecondaryHeaderLength)’ and replaces the frame data
     field while leaving the remaining frame fields unchanged.

For example:

     | ?- ccsds_frames::extract_packets(tm_transfer_frame(0, 42, 3, 0, 16, 32, 0, 0, 0, 3, 0, none, [0x08,0x01,0xC0,0x00,0x00,0x03,0xDE,0xAD,0xBE,0xEF], none, none), 0, Packets).

     | ?- ccsds_frames::insert_packets([ccsds_packet(0, 0, 1, 1, 3, 0, none, [0xDE,0xAD,0xBE,0xEF])], 0, tm_transfer_frame(0, 42, 3, 0, 16, 32, 0, 0, 0, 3, 0, none, [], none, none), UpdatedFrame).

| ?- ccsds_frames::update_fecf(tc_transfer_frame(0, 1, 0, 42, 3, 7,
none, [1,2,3], fecf([0x00,0x00])), UpdatedFrame).

| ?- ccsds_frames::verify_fecf(UpdatedFrame).


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<43>,  Next: Loading<44>,  Prev: Facade helpers,  Up: ccsds_frames

6.24.6 API documentation
------------------------

Open the ‘../../apis/library_index.html#ccsds_frames’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<44>,  Next: Testing<39>,  Prev: API documentation<43>,  Up: ccsds_frames

6.24.7 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ccsds_frames(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<39>,  Prev: Loading<44>,  Up: ccsds_frames

6.24.8 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ccsds_frames(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: ccsds_link_profiles,  Next: ccsds_packet_services,  Prev: ccsds_frames,  Up: Libraries

6.25 ‘ccsds_link_profiles’
==========================

The ‘ccsds_link_profiles’ library provides an ergonomic wrapper layer
over the existing parametric CCSDS frame objects.

Instead of selecting one of the raw ‘ccsds_tm_frames(...)’,
‘ccsds_tc_frames(...)’, or ‘ccsds_aos_frames(...)’ objects directly at
each call site, callers can work with explicit profile terms and generic
wrapper predicates.

* Menu:

* Representation: Representation<3>.
* Public API::
* Parsing and generating: Parsing and generating<2>.
* Packet helpers::
* API documentation: API documentation<44>.
* Loading: Loading<45>.
* Testing: Testing<40>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<3>,  Next: Public API,  Up: ccsds_link_profiles

6.25.1 Representation
---------------------

Link profiles are represented using the compound terms:

     tm_profile(FrameLength, SecondaryHeaderLength, HasFECF)
     tc_profile(FrameLength, SegmentHeaderLength, HasFECF)
     aos_profile(FrameLength, InsertZoneLength, HasOCF, HasFECF)

Where:

   - ‘FrameLength’ is the fixed frame length in octets

   - ‘SecondaryHeaderLength’, ‘SegmentHeaderLength’, and
     ‘InsertZoneLength’ are the mission-profile field lengths in octets

   - ‘HasOCF’ and ‘HasFECF’ are the atoms ‘true’ or ‘false’


File: TheLogtalkHandbook-3.100.1.info,  Node: Public API,  Next: Parsing and generating<2>,  Prev: Representation<3>,  Up: ccsds_link_profiles

6.25.2 Public API
-----------------

The current implementation provides the predicates:

   - ‘valid_profile/1’

   - ‘parse_frame/3’

   - ‘parse_frames/3’

   - ‘generate_frame/3’

   - ‘generate_frames/3’

   - ‘valid_reassembly_state/1’

   - ‘initial_reassembly_state/1’

   - ‘pending_fragments/2’

   - ‘valid_discontinuity_policy/1’

   - ‘extract_packets/4’

   - ‘insert_packets/5’

   - ‘reassemble_packets/6-8’

   - ‘reassemble_frames/6-8’


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing and generating<2>,  Next: Packet helpers,  Prev: Public API,  Up: ccsds_link_profiles

6.25.3 Parsing and generating
-----------------------------

To parse exactly one telemetry transfer frame using a profile term:

     | ?- ccsds_link_profiles::parse_frame(bytes([0x02, 0xA7, 0x10, 0x20, 0x18, 0x00, 1, 2, 3, 4, 5, 6, 0xDE, 0xAD, 0xBE, 0xEF]), tm_profile(16, 0, false), Frame).

To generate a telecommand transfer frame using a profile term:

     | ?- ccsds_link_profiles::generate_frame(bytes(Bytes), tc_profile(10, 0, true), tc_transfer_frame(0, 1, 0, 42, 3, 7, none, [1,2,3], fecf([0x44,0x6D]))).

‘parse_frame/3’ expects the source to contain exactly one frame.  If the
source contains zero frames or more than one frame, the predicate throws
a ‘domain_error(ccsds_single_frame_source, Source)’ exception.

Parsing and generation inherit FECF verification and regeneration from
the underlying TM, TC, and AOS frame objects selected by the profile.

To parse or generate multi-frame sources and sinks, use ‘parse_frames/3’
and ‘generate_frames/3’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Packet helpers,  Next: API documentation<44>,  Prev: Parsing and generating<2>,  Up: ccsds_link_profiles

6.25.4 Packet helpers
---------------------

Packet extraction and insertion are provided for TM and AOS profiles
using the high-level packet-zone semantics from ‘ccsds_packet_services’:

     | ?- ccsds_link_profiles::extract_packets(tm_profile(18, 0, false), 0, tm_transfer_frame(0, 42, 3, 0, 16, 32, 0, 0, 0, 3, 2, none, [0xAA,0xBB,0x08,0x01,0xC0,0x00,0x00,0x03,0xDE,0xAD,0xBE,0xEF], none, none), PacketZone).

     | ?- ccsds_link_profiles::insert_packets(aos_profile(20, 0, false, false), 0, packet_zone([0xAA,0xBB], [ccsds_packet(0, 0, 1, 1, 3, 0, none, [0xDE,0xAD,0xBE,0xEF])], []), aos_transfer_frame(1, 42, 3, 0x123456, signaling_field(1, 0, 0, 0), none, [0,0,0,0,0,0,0,0,0,0,0,0,0,0], none, none), UpdatedFrame).

For cross-frame TM and AOS packet reconstruction, initialize a
reassembly state and call the generic profile wrapper predicates:

     | ?- ccsds_link_profiles::initial_reassembly_state(State), ccsds_link_profiles::reassemble_frames(tm_profile(16, 0, false), 0, Frames, resynchronize, State, Packets, UpdatedState).

Telecommand profiles are intentionally rejected by ‘extract_packets/4’
and ‘insert_packets/5’, ‘reassemble_packets/6-8’, and
‘reassemble_frames/6-8’, which throw a
‘domain_error(ccsds_packet_link_profile, tc_profile(...))’ exception.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<44>,  Next: Loading<45>,  Prev: Packet helpers,  Up: ccsds_link_profiles

6.25.5 API documentation
------------------------

Open the ‘../../apis/library_index.html#ccsds_link_profiles’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<45>,  Next: Testing<40>,  Prev: API documentation<44>,  Up: ccsds_link_profiles

6.25.6 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ccsds_link_profiles(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<40>,  Prev: Loading<45>,  Up: ccsds_link_profiles

6.25.7 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ccsds_link_profiles(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: ccsds_packet_services,  Next: ccsds_packetization,  Prev: ccsds_link_profiles,  Up: Libraries

6.26 ‘ccsds_packet_services’
============================

The ‘ccsds_packet_services’ library provides service-aware helpers that
sit above the raw ‘ccsds_packets’ and ‘ccsds_frames’ codec libraries.

The current implementation supports telemetry and advanced orbiting
systems packet-zone handling above the raw ‘ccsds_frames’ payload
bridge:

   - splitting a packet-zone byte sequence using a TM transfer frame
     first header pointer

   - parsing the complete packets that start in that zone

   - preserving any leading continuation bytes and trailing incomplete
     bytes

   - rebuilding a packet zone and reinserting it into a TM transfer
     frame

   - splitting an AOS M_PDU packet-service data field into its
     first-header-pointer header and packet zone

   - representing AOS idle-only packet zones distinctly from AOS
     no-start packet zones using the same ‘packet_zone/3’ term

   - rebuilding an AOS M_PDU packet-service data field and reinserting
     it into an AOS transfer frame

   - carrying trailing packet fragments across multiple TM or AOS frames
     using an explicit packet reassembly state term

   - reassembling complete packets across frame sequences while
     preserving any still-incomplete trailing fragment for the next
     batch

   - tracking TM and AOS reassembly state per frame type, spacecraft
     identifier, and virtual channel identifier

   - detecting dropped or out-of-order TM and AOS frames by checking the
     expected virtual-channel frame counts during reassembly

   - applying configurable discontinuity recovery policies at the frame
     level, choosing between throwing an error, dropping the
     discontinuous frame, or resynchronizing on the current frame

   - returning explicit recovery event streams from the richer frame
     reassembly predicates so callers can observe dropped fragments,
     skipped frames, and resynchronization points

* Menu:

* Representation: Representation<4>.
* Packet-zone helpers::
* Telemetry transfer frame helpers::
* Advanced orbiting systems helpers::
* Cross-frame packet reassembly::
* Scope::
* API documentation: API documentation<45>.
* Loading: Loading<46>.
* Testing: Testing<41>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<4>,  Next: Packet-zone helpers,  Up: ccsds_packet_services

6.26.1 Representation
---------------------

Packet zones are represented using the compound term:

     packet_zone(PrefixData, Packets, SuffixData)

Where:

   - ‘PrefixData’ is a list of bytes preceding the first complete packet

   - ‘Packets’ is a list of complete ‘ccsds_packet(...)’ terms

   - ‘SuffixData’ is a list of bytes trailing the last complete packet

When a telemetry transfer frame first header pointer indicates that no
packet starts in the frame data field, the full data field is
represented as:

     packet_zone(DataField, [], [])

For AOS packet service data fields, the same term is used after decoding
the two-octet M_PDU first header pointer:

   - ‘packet_zone(PrefixData, [], [])’ corresponds to first header
     pointer ‘2047’ and means that no packet starts in this frame packet
     zone

   - ‘packet_zone([], [], SuffixData)’ corresponds to first header
     pointer ‘2046’ and means that the packet zone contains idle data
     only

Cross-frame packet reassembly state is represented using the compound
term:

     packet_reassembly_state(PendingData)

Where ‘PendingData’ is a list of bytes belonging to an incomplete packet
whose header started in an earlier frame and whose remaining bytes are
expected in a later frame.

Frame-channel reassembly state is represented using the compound term:

     channel_reassembly_state(Channels)

Where ‘Channels’ is a list of terms of the form:

     reassembly_channel(FrameType, SpacecraftId, VirtualChannelId, CounterModulus, ExpectedFrameCount, PendingData)

The ‘FrameType’ argument is either ‘tm’ or ‘aos’.  The keyed state is
used by the frame-level reassembly predicates so that interleaved
virtual channels and TM versus AOS streams do not collide.

Discontinuity recovery policies are represented by the atoms:

     throw
     drop
     resynchronize

The policies have the following meaning when a frame-count discontinuity
is detected for a keyed channel:

   - ‘throw’: raise a ‘domain_error/2’ exception and leave recovery to
     the caller

   - ‘drop’: discard any buffered fragment for that keyed channel and
     skip the discontinuous frame payload entirely

   - ‘resynchronize’: discard any buffered fragment for that keyed
     channel but still process the current frame, ignoring any
     pre-pointer continuation bytes

Recovery event streams are returned by the seven-argument TM and AOS
frame reassembly predicates as lists of terms of the form:

     dropped_fragment(FrameType, SpacecraftId, VirtualChannelId, Reason, PendingData)
     skipped_frame(FrameType, SpacecraftId, VirtualChannelId, Discontinuity)
     resynchronized(FrameType, SpacecraftId, VirtualChannelId, Discontinuity)

Where ‘Reason’ is either:

   - ‘discontinuity(StoredCounterModulus, CounterModulus,
     ExpectedFrameCount, VirtualChannelFrameCount)’

   - ‘idle_only(VirtualChannelFrameCount)’ for AOS idle-only M_PDUs that
     clear a buffered fragment


File: TheLogtalkHandbook-3.100.1.info,  Node: Packet-zone helpers,  Next: Telemetry transfer frame helpers,  Prev: Representation<4>,  Up: ccsds_packet_services

6.26.2 Packet-zone helpers
--------------------------

To split a packet zone using a first header pointer and parse the
complete packets that start there:

     | ?- ccsds_packet_services::split_packet_zone([0xAA,0xBB,0x00,0x00,0xC0,0x00,0x00,0x00,0x42,0xCC], 2, 0, PacketZone).

To rebuild a packet zone and recover the corresponding first header
pointer:

     | ?- ccsds_packet_services::join_packet_zone(packet_zone([0xAA,0xBB], [ccsds_packet(0,0,0,0,3,0,none,[0x42])], [0xCC]), 0, Bytes, FirstHeaderPointer).


File: TheLogtalkHandbook-3.100.1.info,  Node: Telemetry transfer frame helpers,  Next: Advanced orbiting systems helpers,  Prev: Packet-zone helpers,  Up: ccsds_packet_services

6.26.3 Telemetry transfer frame helpers
---------------------------------------

To extract a packet zone from a telemetry transfer frame term:

     | ?- ccsds_packet_services::extract_tm_packets(tm_transfer_frame(0, 42, 3, 0, 16, 32, 0, 0, 0, 3, 2, none, [0xAA,0xBB,0x00,0x00,0xC0,0x00,0x00,0x00,0x42,0xCC], none, none), 0, PacketZone).

To update a telemetry transfer frame from a packet zone term:

     | ?- ccsds_packet_services::insert_tm_packets(packet_zone([0xAA,0xBB], [ccsds_packet(0,0,0,0,3,0,none,[0x42])], [0xCC]), 0, tm_transfer_frame(0, 42, 3, 0, 16, 32, 0, 0, 0, 3, 0, none, [], none, none), UpdatedFrame).

If the input TM frame already carries a ‘fecf/1’ term,
‘insert_tm_packets/4’ refreshes it from the updated frame bytes.  Frames
with ‘none’ keep ‘none’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Advanced orbiting systems helpers,  Next: Cross-frame packet reassembly,  Prev: Telemetry transfer frame helpers,  Up: ccsds_packet_services

6.26.4 Advanced orbiting systems helpers
----------------------------------------

To split an AOS M_PDU packet-service data field:

     | ?- ccsds_packet_services::split_aos_packet_zone([0x00,0x02,0xAA,0xBB,0x00,0x00,0xC0,0x00,0x00,0x00,0x42,0xCC], 0, PacketZone).

To rebuild an AOS M_PDU packet-service data field from a packet zone
term:

     | ?- ccsds_packet_services::join_aos_packet_zone(packet_zone([0xAA,0xBB], [ccsds_packet(0,0,0,0,3,0,none,[0x42])], [0xCC]), 0, Bytes).

To extract a packet zone from an AOS transfer frame term:

     | ?- ccsds_packet_services::extract_aos_packets(aos_transfer_frame(1, 42, 3, 16, signaling_field(0,0,0,0), none, [0x00,0x02,0xAA,0xBB,0x00,0x00,0xC0,0x00,0x00,0x00,0x42,0xCC], none, none), 0, PacketZone).

To update an AOS transfer frame from a packet zone term:

     | ?- ccsds_packet_services::insert_aos_packets(packet_zone([0xAA,0xBB], [ccsds_packet(0,0,0,0,3,0,none,[0x42])], [0xCC]), 0, aos_transfer_frame(1, 42, 3, 16, signaling_field(0,0,0,0), none, [], none, none), UpdatedFrame).

If the input AOS frame already carries a ‘fecf/1’ term,
‘insert_aos_packets/4’ refreshes it from the updated frame bytes.
Frames with ‘none’ keep ‘none’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Cross-frame packet reassembly,  Next: Scope,  Prev: Advanced orbiting systems helpers,  Up: ccsds_packet_services

6.26.5 Cross-frame packet reassembly
------------------------------------

To get the initial low-level packet reassembly state:

     | ?- ccsds_packet_services::initial_reassembly_state(State).

To get the initial keyed frame-channel reassembly state:

     | ?- ccsds_packet_services::initial_channel_reassembly_state(State).

To reassemble a packet zone against a prior trailing fragment:

     | ?- ccsds_packet_services::reassemble_packet_zone(packet_zone([0x00,0x00,0x42], [ccsds_packet(0,0,0,0,3,1,none,[0x43])], []), 0, packet_reassembly_state([0x00,0x00,0xC0,0x00]), Packets, UpdatedState).

To reassemble complete packets across a sequence of telemetry transfer
frames:

     | ?- ccsds_packet_services::reassemble_tm_frames([tm_transfer_frame(0, 42, 3, 0, 16, 32, 0, 0, 0, 3, 0, none, [0x00,0x00,0xC0,0x00], none, none), tm_transfer_frame(0, 42, 3, 0, 16, 33, 0, 0, 0, 3, 3, none, [0x00,0x00,0x42,0x00,0x00,0xC0,0x01,0x00,0x00,0x43], none, none)], 0, channel_reassembly_state([]), Packets, UpdatedState).

To reassemble telemetry transfer frames while resynchronizing
automatically on a detected discontinuity:

     | ?- ccsds_packet_services::reassemble_tm_packets(tm_transfer_frame(0, 42, 3, 0, 16, 34, 0, 0, 0, 3, 3, none, [0x00,0x00,0x42,0x00,0x00,0xC0,0x02,0x00,0x00,0x44], none, none), 0, resynchronize, channel_reassembly_state([reassembly_channel(tm,42,3,256,33,[0x00,0x00,0xC0,0x00])]), Packets, UpdatedState).

To reassemble a telemetry transfer frame and also receive explicit
recovery events:

     | ?- ccsds_packet_services::reassemble_tm_packets(tm_transfer_frame(0, 42, 3, 0, 16, 34, 0, 0, 0, 3, 3, none, [0x00,0x00,0x42,0x00,0x00,0xC0,0x02,0x00,0x00,0x44], none, none), 0, resynchronize, channel_reassembly_state([reassembly_channel(tm,42,3,256,33,[0x00,0x00,0xC0,0x00])]), Packets, UpdatedState, Events).

To reassemble complete packets across a sequence of AOS transfer frames:

     | ?- ccsds_packet_services::reassemble_aos_frames([aos_transfer_frame(1, 42, 3, 16, signaling_field(0,0,0,0), none, [0x00,0x00,0x00,0x00,0xC0,0x00], none, none), aos_transfer_frame(1, 42, 3, 17, signaling_field(0,0,0,0), none, [0x00,0x03,0x00,0x00,0x42,0x00,0x00,0xC0,0x01,0x00,0x00,0x43], none, none)], 0, channel_reassembly_state([]), Packets, UpdatedState).

To reassemble AOS transfer frames while dropping a discontinuous frame
and resetting the keyed buffered fragment:

     | ?- ccsds_packet_services::reassemble_aos_packets(aos_transfer_frame(1, 42, 3, 18, signaling_field(0,0,0,0), none, [0x00,0x03,0x00,0x00,0x42,0x00,0x00,0xC0,0x02,0x00,0x00,0x44], none, none), 0, drop, channel_reassembly_state([reassembly_channel(aos,42,3,16777216,17,[0x00,0x00,0xC0,0x00])]), Packets, UpdatedState).

To reassemble AOS transfer frames and receive explicit recovery events
across a frame sequence:

     | ?- ccsds_packet_services::reassemble_aos_frames([aos_transfer_frame(1, 42, 3, 16, signaling_field(0,0,0,0), none, [0x00,0x00,0x00,0x00,0xC0,0x00], none, none), aos_transfer_frame(1, 42, 3, 18, signaling_field(0,0,0,0), none, [0x00,0x03,0x00,0x00,0x42,0x00,0x00,0xC0,0x02,0x00,0x00,0x44], none, none)], 0, drop, channel_reassembly_state([]), Packets, UpdatedState, Events).

To inspect the currently buffered keyed pending fragments:

     | ?- ccsds_packet_services::pending_fragments(channel_reassembly_state([reassembly_channel(tm,42,3,256,33,[0x00,0x00,0xC0,0x00])]), PendingFragments).

For AOS packet service, idle-only M_PDUs clear any pending fragment
state.  This matches the packet-zone interpretation where first header
pointer ‘2046’ denotes idle data rather than continuation bytes.

If a TM or AOS frame arrives with a virtual-channel frame count
different from the keyed state expected count, the frame-level
reassembly predicates apply the selected discontinuity recovery policy.
The five-argument variants default to the ‘throw’ policy.  The
seven-argument variants additionally report the recovery decisions as an
explicit event stream.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scope,  Next: API documentation<45>,  Prev: Cross-frame packet reassembly,  Up: ccsds_packet_services

6.26.6 Scope
------------

This milestone covers TM transfer frame packet zones, AOS packet-service
M_PDUs, low-level packet-fragment stitching, and keyed TM/AOS
cross-frame packet reassembly with continuity checks and configurable
discontinuity recovery.  Future milestones can extend the same library
with segmentation policies, idle packet generation, richer per-channel
recovery controls, and higher level packetization policies.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<45>,  Next: Loading<46>,  Prev: Scope,  Up: ccsds_packet_services

6.26.7 API documentation
------------------------

Open the ‘../../apis/library_index.html#ccsds_packet_services’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<46>,  Next: Testing<41>,  Prev: API documentation<45>,  Up: ccsds_packet_services

6.26.8 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ccsds_packet_services(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<41>,  Prev: Loading<46>,  Up: ccsds_packet_services

6.26.9 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ccsds_packet_services(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: ccsds_packetization,  Next: ccsds_packets,  Prev: ccsds_packet_services,  Up: Libraries

6.27 ‘ccsds_packetization’
==========================

The ‘ccsds_packetization’ library provides the inverse service-layer
helpers to the existing ‘ccsds_packet_services’ library.

This first implementation slice covers:

   - fitting packet streams into TM and AOS packet-service regions

   - preserving partially emitted packet bytes across frame boundaries

   - tracking queued packets per frame type, spacecraft identifier, and
     virtual channel identifier

   - generating idle packets deliberately when there is remaining frame
     capacity

   - reporting explicit packetization events for buffered fragments and
     generated idle packets

* Menu:

* Representation: Representation<5>.
* Packetization::
* Events::
* Idle packets::
* API documentation: API documentation<46>.
* Loading: Loading<47>.
* Testing: Testing<42>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<5>,  Next: Packetization,  Up: ccsds_packetization

6.27.1 Representation
---------------------

Packetizer state is represented using the compound term:

     packetizer_state(Channels)

Where ‘Channels’ is a list of terms of the form:

     packetizer_channel(FrameType, SpacecraftId, VirtualChannelId, PendingBytes, QueuedPackets)

Where:

   - ‘FrameType’ is either ‘tm’ or ‘aos’

   - ‘SpacecraftId’ is the keyed spacecraft identifier

   - ‘VirtualChannelId’ is the keyed virtual channel identifier

   - ‘PendingBytes’ is a list of packet bytes already started in an
     earlier frame but not yet fully emitted

   - ‘QueuedPackets’ is a list of complete ‘ccsds_packet(...)’ terms
     waiting to be packetized for that keyed channel

Idle packets are generated as telemetry packets using APID ‘2047’,
standalone sequence flags, the requested sequence count, a zero-filled
secondary header of the requested length, and zero-filled user data.


File: TheLogtalkHandbook-3.100.1.info,  Node: Packetization,  Next: Events,  Prev: Representation<5>,  Up: ccsds_packetization

6.27.2 Packetization
--------------------

To get the initial packetizer state:

     | ?- ccsds_packetization::initial_state(State).

To inspect the currently buffered pending bytes and queued packets:

     | ?- ccsds_packetization::pending_packets(packetizer_state([packetizer_channel(tm, 42, 3, [0x22,0x33], [ccsds_packet(0,0,0,1,3,7,none,[0x44])])]), PendingPackets).

To packetize packets into a TM transfer frame:

     | ?- ccsds_packetization::packetize_tm_packets(tm_transfer_frame(0, 42, 3, 0, 16, 32, 0, 0, 0, 3, 2047, none, [0,0,0,0,0,0,0], none, none), 0, packetizer_state([]), [ccsds_packet(0, 0, 0, 0, 3, 0, none, [0x42])], UpdatedFrame, UpdatedState).

When the input TM frame already carries a ‘fecf/1’ term,
‘packetize_tm_packets/6-7’ refresh it from the updated frame bytes.
Frames with ‘none’ keep ‘none’.

To packetize packets into an AOS transfer frame:

     | ?- ccsds_packetization::packetize_aos_packets(aos_transfer_frame(1, 42, 3, 16, signaling_field(0,0,0,0), none, [0,0,0,0,0,0,0,0,0], none, none), 0, packetizer_state([]), [ccsds_packet(0, 0, 0, 0, 3, 0, none, [0x42])], UpdatedFrame, UpdatedState).

When the input AOS frame already carries a ‘fecf/1’ term,
‘packetize_aos_packets/6-7’ refresh it from the updated frame bytes.
Frames with ‘none’ keep ‘none’.

To packetize packets across a sequence of TM transfer frames:

     | ?- ccsds_packetization::packetize_tm_frames([Frame1, Frame2], 0, packetizer_state([]), Packets, UpdatedFrames, RemainingPackets, UpdatedState).


File: TheLogtalkHandbook-3.100.1.info,  Node: Events,  Next: Idle packets,  Prev: Packetization,  Up: ccsds_packetization

6.27.3 Events
-------------

The richer single-frame and multi-frame packetization predicates return
event lists using the terms:

     buffered_packet_fragment(FrameType, SpacecraftId, VirtualChannelId, PendingBytes)
     generated_idle_packet(FrameType, SpacecraftId, VirtualChannelId, Packet)

Where:

   - ‘buffered_packet_fragment/4’ reports trailing packet bytes buffered
     for the next frame

   - ‘generated_idle_packet/4’ reports an idle packet synthesized to
     consume remaining frame capacity


File: TheLogtalkHandbook-3.100.1.info,  Node: Idle packets,  Next: API documentation<46>,  Prev: Events,  Up: ccsds_packetization

6.27.4 Idle packets
-------------------

To generate a telemetry idle packet with APID ‘2047’:

     | ?- ccsds_packetization::generate_idle_packet(0, 7, 2, Packet).


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<46>,  Next: Loading<47>,  Prev: Idle packets,  Up: ccsds_packetization

6.27.5 API documentation
------------------------

Open the ‘../../apis/library_index.html#ccsds_packetization’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<47>,  Next: Testing<42>,  Prev: API documentation<46>,  Up: ccsds_packetization

6.27.6 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ccsds_packetization(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<42>,  Prev: Loading<47>,  Up: ccsds_packetization

6.27.7 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ccsds_packetization(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: ccsds_packets,  Next: ccsds_tc_services,  Prev: ccsds_packetization,  Up: Libraries

6.28 ‘ccsds_packets’
====================

The ‘ccsds_packets’ library implements predicates for parsing and
generating CCSDS (Consultative Committee for Space Data Systems) Space
Packets following the CCSDS 133.0-B-2 standard (Space Packet Protocol).

Reference documentation:

   - ‘https://public.ccsds.org/Pubs/133x0b2e1.pdf’

   - 
     ‘https://jastoolbox.sandia.gov/topic/communication-specification/jas-packets/ccsds-telecommand-and-telemetry-format-packet-standard/’

* Menu:

* Packet Structure::
* Representation: Representation<6>.
* Parsing::
* Generating::
* Accessor Predicates::
* Types and arbitrary generators::
* API documentation: API documentation<47>.
* Loading: Loading<48>.
* Testing: Testing<43>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Packet Structure,  Next: Representation<6>,  Up: ccsds_packets

6.28.1 Packet Structure
-----------------------

A CCSDS Space Packet consists of:

  1. 'Primary Header (6 bytes)':

        - Version Number (3 bits) - Always 000 for Space Packets

        - Packet Type (1 bit) - 0=Telemetry, 1=Telecommand

        - Secondary Header Flag (1 bit) - 0=absent, 1=present

        - Application Process ID (APID) (11 bits) - 0-2047

        - Sequence Flags (2 bits) - 00=continuation, 01=first, 10=last,
          11=standalone

        - Packet Sequence Count (14 bits) - 0-16383

        - Packet Data Length (16 bits) - Number of octets in data field
          minus 1

  2. 'User Data Field' - Variable length payload


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<6>,  Next: Parsing,  Prev: Packet Structure,  Up: ccsds_packets

6.28.2 Representation
---------------------

Packets are represented using the compound term:

     ccsds_packet(Version, Type, SecHeaderFlag, APID, SeqFlags, SeqCount, SecHeader, UserData)

Where:

   - ‘Version’ is an integer (0-7, typically 0)

   - ‘Type’ is an integer (0=telemetry, 1=telecommand)

   - ‘SecHeaderFlag’ is an integer (0 or 1)

   - ‘APID’ is an integer (0-2047)

   - ‘SeqFlags’ is an integer (0-3)

   - ‘SeqCount’ is an integer (0-16383)

   - ‘SecHeader’ is either ‘none’ or ‘secondary_header(Bytes)’ where
     ‘Bytes’ is a list of bytes

   - ‘UserData’ is a list of bytes

Note that the ‘DataLength’ field from the wire format is not stored in
the term representation as it can be computed from ‘SecHeader’ and
‘UserData’.  The ‘data_length/2’ accessor predicate computes and returns
this value when needed.


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing,  Next: Generating,  Prev: Representation<6>,  Up: ccsds_packets

6.28.3 Parsing
--------------

The ‘parse/2’ predicate accepts a source term as its first argument.
The source can be ‘file(File)’, ‘stream(Stream)’, or ‘bytes(Bytes)’.
All source types return a list of packets for uniformity.

To parse packets from a list of bytes:

     | ?- ccsds_packets::parse(bytes([0x08, 0x01, 0xC0, 0x00, 0x00, 0x03, 0xDE, 0xAD, 0xBE, 0xEF]), Packets).
     Packets = [ccsds_packet(0, 0, 1, 1, 3, 0, none, [222, 173, 190, 239])]
     yes

To parse packets from a binary file:

     | ?- ccsds_packets::parse(file('telemetry.bin'), Packets).

To parse packets from a binary stream:

     | ?- ccsds_packets::parse(stream(Stream), Packets).

When the packets include a secondary header, the secondary header length
must be known.  In this case, use the
‘ccsds_packets(SecondaryHeaderLength)’ object instead of the
‘ccsds_packets’ object.  For example, to parse packets with a secondary
header of 6 bytes:

     | ?- ccsds_packets(6)::parse(bytes([0x08, 0x01, 0xC0, 0x00, 0x00, 0x07, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0xAA, 0xBB]), Packets).


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating,  Next: Accessor Predicates,  Prev: Parsing,  Up: ccsds_packets

6.28.4 Generating
-----------------

The ‘generate/2’ predicate accepts a sink term as its first argument and
a list of packet terms as the second argument.  The sink can be
‘file(File)’, ‘stream(Stream)’, or ‘bytes(Bytes)’.

To generate bytes from a list of packet terms:

     | ?- ccsds_packets::generate(bytes(Bytes), [ccsds_packet(0, 0, 1, 1, 3, 0, none, [0xDE, 0xAD, 0xBE, 0xEF])]).
     Bytes = [8, 1, 192, 0, 0, 3, 222, 173, 190, 239]
     yes

To write the bytes generated from a list of packet terms to a binary
file:

     | ?- ccsds_packets::generate(file('output.bin'), Packets).

To write the bytes generated from a list of packet terms to a binary
stream:

     | ?- ccsds_packets::generate(stream(Stream), Packets).


File: TheLogtalkHandbook-3.100.1.info,  Node: Accessor Predicates,  Next: Types and arbitrary generators,  Prev: Generating,  Up: ccsds_packets

6.28.5 Accessor Predicates
--------------------------

The library provides convenient accessor predicates for extracting
packet fields:

     | ?- ccsds_packets::apid(Packet, APID).

     % Returns telemetry or telecommand
     | ?- ccsds_packets::type(Packet, Type).

     % Returns continuation, first, last, or standalone
     | ?- ccsds_packets::sequence_flags(Packet, Flags).

     % Returns the secondary header as a list of bytes or none
     | ?- ccsds_packets::secondary_header(Packet, SecHeader).

     % Parses a self-describing secondary-header time field when Descriptor is a variable.
     | ?- ccsds_packets(7)::secondary_header_time(Packet, Descriptor, Time).

     % Parses raw secondary-header T-field bytes using an explicit descriptor term.
     | ?- ccsds_packets(10)::secondary_header_time(Packet, cuc_descriptor(5, 5, ccsds_epoch), Time).

     | ?- ccsds_packets::user_data(Packet, Data).

     % Returns the packet data length (computed from secondary header and user data)
     | ?- ccsds_packets::data_length(Packet, Length).


File: TheLogtalkHandbook-3.100.1.info,  Node: Types and arbitrary generators,  Next: API documentation<47>,  Prev: Accessor Predicates,  Up: ccsds_packets

6.28.6 Types and arbitrary generators
-------------------------------------

The library includes a ‘ccsds_packets_types’ category that provides
‘ccsds_packet’ and ‘ccsds_packet(SecondaryHeaderLength)’ types and
arbitrary generators for CCSDS packets.  For example:

     | ?- type::check(ccsds_packet, Bytes).

     | ?- type::arbitrary(ccsds_packet(42), Bytes).

It also provides a ‘ccsds_packets(N)’ and
‘ccsds_packets(SecondaryHeaderLength, N)’ types for generating a list
with ‘N’ packets.  For example:

     | ?- type::arbitrary(ccsds_packets(10), Bytes).

     | ?- type::check(ccsds_packets(42, 10), Bytes).

For a term representation of a packet, use the ‘ccsds_packet_term’ and
‘ccsds_packet_term(SecondaryHeaderLength)’ types and arbitrary
generators.  For example:

     | ?- type::check(ccsds_packet_term, Packet).

     | ?- type::arbitrary(ccsds_packet_term(42), Packet).


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<47>,  Next: Loading<48>,  Prev: Types and arbitrary generators,  Up: ccsds_packets

6.28.7 API documentation
------------------------

Open the ‘../../apis/library_index.html#ccsds_packets’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<48>,  Next: Testing<43>,  Prev: API documentation<47>,  Up: ccsds_packets

6.28.8 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ccsds_packets(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<43>,  Prev: Loading<48>,  Up: ccsds_packets

6.28.9 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ccsds_packets(tester)).

To test the performance of the library parsing predicates, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(ccsds_packets(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: ccsds_tc_services,  Next: ccsds_time_codes,  Prev: ccsds_packets,  Up: Libraries

6.29 ‘ccsds_tc_services’
========================

The ‘ccsds_tc_services’ library provides service-aware helpers that sit
above raw ‘ccsds_frames’ telecommand transfer frame terms.

This first implementation slice covers:

   - extracting telecommand segments from CCSDS telecommand transfer
     frames

   - encoding telecommand segments back into telecommand transfer frames

   - tracking segmented telecommand reassembly state per spacecraft
     identifier and virtual channel identifier

   - keeping pending segmented data separately per MAP identifier inside
     each virtual channel

   - detecting telecommand frame-sequence discontinuities during
     reassembly

   - applying configurable discontinuity recovery policies during
     reassembly

   - returning explicit recovery event streams from the richer frame
     reassembly predicates

   - returning provenance-aware reassembled service-unit terms that
     preserve the ordered per-frame mission-specific segment-header
     suffixes contributing to a complete telecommand service unit

   - grouping complete telecommand service units into MAP-aware dispatch
     buckets so callers can route them by MAP identifier without
     rebuilding that bookkeeping

* Menu:

* Representation: Representation<7>.
* Scope: Scope<2>.
* Examples: Examples<166>.
* API documentation: API documentation<48>.
* Loading: Loading<49>.
* Testing: Testing<44>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<7>,  Next: Scope<2>,  Up: ccsds_tc_services

6.29.1 Representation
---------------------

Telecommand segments extracted by this library are represented using the
compound term:

     tc_segment(SequenceFlags, MapId, HeaderSuffix, Data)

Where:

   - ‘SequenceFlags’ is one of ‘continuation’, ‘first’, ‘last’, or
     ‘unsegmented’

   - ‘MapId’ is the multiplexer access point identifier in the range
     0-63

   - ‘HeaderSuffix’ is the list of mission-specific segment-header
     octets that follow the standard first octet

   - ‘Data’ is the segment data as a list of bytes

The compact term ‘tc_segment(SequenceFlags, MapId, Data)’ is also
accepted by predicates such as ‘valid_segment/1’ and
‘insert_tc_segment/3’ as shorthand for an empty header suffix.

Reassembled service units that are reconstructed from multiple transfer
frames use the empty list as ‘HeaderSuffix’, as there is no single
mission-specific suffix value that unambiguously represents the merged
result.

When callers need that provenance instead of the compact compatibility
view, the companion reassembly predicates return terms of the form:

     tc_reassembled_segment(MapId, HeaderSuffixes, Data)

Where ‘HeaderSuffixes’ is the ordered list of the per-frame
mission-specific segment-header suffixes that contributed to the
complete service unit.

MAP-aware dispatch helpers group complete telecommand service units into
terms of the form:

     map_dispatch(MapId, ServiceUnits)

Where ‘ServiceUnits’ is a list of complete telecommand service-unit
terms for a single ‘MapId’, preserving the original service-unit order
inside each bucket and the first-seen order of the MAP buckets.

Telecommand reassembly state is represented using the compound term:

     tc_reassembly_state(Channels)

Where ‘Channels’ is a list of terms of the form:

     tc_reassembly_channel(SpacecraftId, VirtualChannelId, ExpectedSequenceNumber, PendingSegments)

The ‘PendingSegments’ list stores the currently buffered segmented data
by MAP identifier using terms of the form:

     tc_pending_segment(MapId, PendingData)

Pending buffered fragments can be queried using ‘pending_fragments/2’,
which returns flattened terms of the form:

     pending_fragment(SpacecraftId, VirtualChannelId, MapId, PendingData)

Discontinuity recovery policies are represented by the atoms:

     throw
     drop
     resynchronize

The policies have the following meaning when a frame sequence
discontinuity is found for a telecommand virtual channel:

   - ‘throw’: raise a ‘domain_error/2’ exception

   - ‘drop’: discard all pending MAP fragments for that virtual channel
     and skip the discontinuous frame payload

   - ‘resynchronize’: discard all pending MAP fragments for that virtual
     channel and still process the current frame payload

Recovery event streams are returned by ‘reassemble_tc_frame/6’ and
‘reassemble_tc_frames/6’ as lists of terms of the form:

     dropped_fragment(SpacecraftId, VirtualChannelId, MapId, Reason, PendingData)
     skipped_frame(SpacecraftId, VirtualChannelId, Discontinuity)
     resynchronized(SpacecraftId, VirtualChannelId, Discontinuity)

Where ‘Discontinuity’ is represented by:

     discontinuity(ExpectedSequenceNumber, SequenceNumber)

Provenance-aware reassembly is provided by the companion predicates
‘reassemble_tc_frame_with_provenance/5-6’ and
‘reassemble_tc_frames_with_provenance/5-6’.

MAP-aware dispatch is provided by ‘dispatch_service_units_by_map/2-3’,
which accept both compact telecommand segment terms and provenance-aware
reassembled telecommand service-unit terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scope<2>,  Next: Examples<166>,  Prev: Representation<7>,  Up: ccsds_tc_services

6.29.2 Scope
------------

This first milestone interprets the standard telecommand MAP and
sequence semantics from the first segment-header octet, where the high
two bits encode the sequence flags and the low six bits encode the MAP
identifier.  Transfer frames with longer mission-specific segment
headers are also supported: additional segment-header octets are exposed
in extracted segment terms as the ‘HeaderSuffix’ component and are
preserved when updating frames.


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<166>,  Next: API documentation<48>,  Prev: Scope<2>,  Up: ccsds_tc_services

6.29.3 Examples
---------------

To extract a telecommand segment from a telecommand transfer frame term:

     | ?- ccsds_tc_services::extract_tc_segment(tc_transfer_frame(0, 1, 0, 42, 3, 7, segment_header([0xC5]), [1,2,3], none), Segment).

To update a telecommand transfer frame from a telecommand segment term:

     | ?- ccsds_tc_services::insert_tc_segment(tc_segment(first, 42, [1,2,3]), tc_transfer_frame(0, 1, 0, 42, 3, 7, none, [], none), UpdatedFrame).

To inspect the mission-specific segment-header suffix from an extracted
telecommand segment term:

     | ?- ccsds_tc_services::segment_header_suffix(tc_segment(first, 5, [0xAA,0xBB], [1,2,3]), HeaderSuffix).

Mission-specific segment-header suffix octets are preserved when present
in the input frame term:

     | ?- ccsds_tc_services::insert_tc_segment(tc_segment(first, 42, [1,2,3]), tc_transfer_frame(0, 1, 0, 42, 3, 7, segment_header([0x00,0xAA,0xBB]), [], none), UpdatedFrame).

To reassemble a segmented telecommand service unit across a sequence of
frames:

     | ?- ccsds_tc_services::reassemble_tc_frames([tc_transfer_frame(0, 1, 0, 42, 3, 7, segment_header([0x45]), [1,2], none), tc_transfer_frame(0, 1, 0, 42, 3, 8, segment_header([0x85]), [3,4], none)], tc_reassembly_state([]), Segments, UpdatedState).

To reassemble a segmented telecommand service unit across a sequence of
frames and preserve the ordered per-frame mission-specific header-suffix
provenance:

     | ?- ccsds_tc_services::reassemble_tc_frames_with_provenance([tc_transfer_frame(0, 1, 0, 42, 3, 7, segment_header([0x45,0xAA]), [1,2], none), tc_transfer_frame(0, 1, 0, 42, 3, 8, segment_header([0x85,0xBB]), [3,4], none)], tc_reassembly_state([]), ReassembledSegments, UpdatedState, Events).

To group complete telecommand service units into MAP-aware dispatch
buckets:

     | ?- ccsds_tc_services::dispatch_service_units_by_map([tc_segment(unsegmented, 7, [], [0x01]), tc_reassembled_segment(6, [[0xBB]], [0x03]), tc_reassembled_segment(7, [[0xAA]], [0x02])], Dispatches).

To resynchronize on a discontinuous telecommand frame while receiving
explicit recovery events:

     | ?- ccsds_tc_services::reassemble_tc_frame(tc_transfer_frame(0, 1, 0, 42, 3, 9, segment_header([0xC6]), [9], none), resynchronize, tc_reassembly_state([tc_reassembly_channel(42, 3, 8, [tc_pending_segment(5, [1])])]), Segments, UpdatedState, Events).


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<48>,  Next: Loading<49>,  Prev: Examples<166>,  Up: ccsds_tc_services

6.29.4 API documentation
------------------------

Open the ‘../../apis/library_index.html#ccsds_tc_services’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<49>,  Next: Testing<44>,  Prev: API documentation<48>,  Up: ccsds_tc_services

6.29.5 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ccsds_tc_services(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<44>,  Prev: Loading<49>,  Up: ccsds_tc_services

6.29.6 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ccsds_tc_services(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: ccsds_time_codes,  Next: ccsds_time_fields,  Prev: ccsds_tc_services,  Up: Libraries

6.30 ‘ccsds_time_codes’
=======================

The ‘ccsds_time_codes’ library provides support for CCSDS time codes.
The current implementation includes CCSDS Unsegmented Time Code (CUC)
and CCSDS Day Segmented Time Code (CDS), and CCSDS Calendar Segmented
Time Code (CCS), keeping the package small and reusable by the existing
‘ccsds_packets’ packet library and by future frame-level libraries.

* Menu:

* Available entities: Available entities<2>.
* Representation: Representation<8>.
* Parsing and generating: Parsing and generating<3>.
* Unix time conversion::
* Types and arbitrary generators: Types and arbitrary generators<2>.
* API documentation: API documentation<49>.
* Loading: Loading<50>.
* Testing: Testing<45>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Available entities<2>,  Next: Representation<8>,  Up: ccsds_time_codes

6.30.1 Available entities
-------------------------

   - ‘ccsds_time_code_protocol’ Common protocol for time code format
     objects.

   - ‘ccsds_time_codes’ Facade object for introspecting time code terms.

   - ‘ccsds_cuc(CoarseOctets, FineOctets, Epoch)’ Parametric object
     implementing parsing, generation, and conversion for CUC time
     codes.

   - ‘ccsds_cds(DaySegmentOctets, SubmillisecondOctets, Epoch)’
     Parametric object implementing parsing, generation, and conversion
     for CDS time codes.

   - ‘ccsds_ccs(CalendarVariant, FractionOctets)’ Parametric object
     implementing parsing, generation, and conversion for CCS time
     codes.

   - ‘ccsds_time_codes_types’ Type definitions and arbitrary generators
     for CUC terms and byte encodings.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<8>,  Next: Parsing and generating<3>,  Prev: Available entities<2>,  Up: ccsds_time_codes

6.30.2 Representation
---------------------

CUC values are represented using the compound term:

     cuc_time(Coarse, Fine)

Where:

   - ‘Coarse’ is the integer value stored in the coarse time octets

   - ‘Fine’ is the integer value stored in the fine time octets

The number of octets used for each field is selected by the parametric
object.

CDS values are represented using the compound terms:

     cds_time(Days, Milliseconds)
     cds_time(Days, Milliseconds, Submilliseconds)

Where:

   - ‘Days’ is the integer value stored in the day segment

   - ‘Milliseconds’ is the millisecond-of-day value

   - ‘Submilliseconds’ is the optional submillisecond value when the
     object uses a submillisecond segment; 2-octet objects store
     microseconds and 4-octet objects store picoseconds within the
     millisecond

CCS values are represented using the compound terms:

     ccs_calendar_time(Year, Month, Day, Hour, Minute, Second, Fraction)
     ccs_ordinal_time(Year, DayOfYear, Hour, Minute, Second, Fraction)

Where:

   - ‘Year’ is the four-digit BCD year

   - ‘Month’ and ‘Day’ are used by the ‘calendar’ variant

   - ‘DayOfYear’ is used by the ‘day_of_year’ variant

   - ‘Fraction’ stores the optional BCD fractional digits encoded by the
     object


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing and generating<3>,  Next: Unix time conversion,  Prev: Representation<8>,  Up: ccsds_time_codes

6.30.3 Parsing and generating
-----------------------------

To parse a 4-octet coarse and 2-octet fine CUC value using the CCSDS
epoch:

     | ?- ccsds_cuc(4, 2, ccsds_epoch)::parse(bytes([0x00, 0x00, 0x01, 0x00, 0x00, 0x80]), TimeCode).
     TimeCode = cuc_time(256, 128)
     yes

To generate the corresponding byte sequence:

     | ?- ccsds_cuc(4, 2, ccsds_epoch)::generate(bytes(Bytes), cuc_time(256, 128)).
     Bytes = [0, 0, 1, 0, 0, 128]
     yes

To parse a 16-bit day-segment CDS value without the optional
submillisecond segment:

     | ?- ccsds_cds(2, 0, ccsds_epoch)::parse(bytes([0x00, 0x01, 0x00, 0x00, 0x07, 0xD0]), TimeCode).
     TimeCode = cds_time(1, 2000)
     yes

To parse a CDS value with a 16-bit submillisecond segment:

     | ?- ccsds_cds(2, 2, unix_epoch)::parse(bytes([0x00, 0x01, 0x00, 0x00, 0x07, 0xD0, 0x01, 0xF4]), TimeCode).
     TimeCode = cds_time(1, 2000, 500)
     yes

To parse a CDS value with a 32-bit submillisecond segment:

     | ?- ccsds_cds(3, 4, unix_epoch)::parse(bytes([0x00, 0x00, 0x01, 0x00, 0x00, 0x07, 0xD0, 0x1D, 0xCD, 0x65, 0x00]), TimeCode).
     TimeCode = cds_time(1, 2000, 500000000)
     yes

To parse a CCS calendar-segmented value without fractional digits:

     | ?- ccsds_ccs(calendar, 0)::parse(bytes([0x20, 0x26, 0x05, 0x08, 0x14, 0x30, 0x45]), TimeCode).
     TimeCode = ccs_calendar_time(2026, 5, 8, 14, 30, 45, 0)
     yes

To parse an ordinal CCS value with one fractional BCD octet:

     | ?- ccsds_ccs(day_of_year, 1)::parse(bytes([0x20, 0x26, 0x01, 0x28, 0x14, 0x30, 0x45, 0x67]), TimeCode).
     TimeCode = ccs_ordinal_time(2026, 128, 14, 30, 45, 67)
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Unix time conversion,  Next: Types and arbitrary generators<2>,  Prev: Parsing and generating<3>,  Up: ccsds_time_codes

6.30.4 Unix time conversion
---------------------------

To convert a CUC value that uses the Unix epoch into Unix seconds:

     | ?- ccsds_cuc(4, 2, unix_epoch)::unix_seconds(cuc_time(1, 32768), Seconds).
     Seconds = 1.5
     yes

To convert Unix seconds back into a CUC value:

     | ?- ccsds_cuc(4, 2, unix_epoch)::from_unix_seconds(1.5, TimeCode).
     TimeCode = cuc_time(1, 32768)
     yes

To convert a CDS value that uses the Unix epoch into Unix seconds:

     | ?- ccsds_cds(2, 2, unix_epoch)::unix_seconds(cds_time(1, 2000, 500), Seconds).
     Seconds = 86402.0005
     yes

To convert Unix seconds back into a CDS value:

     | ?- ccsds_cds(2, 2, unix_epoch)::from_unix_seconds(86402.0005, TimeCode).
     TimeCode = cds_time(1, 2000, 500)
     yes

To convert a CCS calendar value into Unix seconds:

     | ?- ccsds_ccs(calendar, 0)::unix_seconds(ccs_calendar_time(1970, 1, 1, 0, 0, 0, 0), Seconds).
     Seconds = 0
     yes

To convert Unix seconds back into an ordinal CCS value:

     | ?- ccsds_ccs(day_of_year, 1)::from_unix_seconds(1.5, TimeCode).
     TimeCode = ccs_ordinal_time(1970, 1, 0, 0, 1, 50)
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Types and arbitrary generators<2>,  Next: API documentation<49>,  Prev: Unix time conversion,  Up: ccsds_time_codes

6.30.5 Types and arbitrary generators
-------------------------------------

The ‘ccsds_time_codes_types’ category defines the following types:

   - ‘ccsds_cuc(CoarseOctets, FineOctets, Epoch)’ for byte encodings

   - ‘ccsds_cuc_time(CoarseOctets, FineOctets)’ for ‘cuc_time/2’ terms

   - ‘ccsds_cds(DaySegmentOctets, SubmillisecondOctets, Epoch)’ for byte
     encodings

   - ‘ccsds_cds_time(DaySegmentOctets, SubmillisecondOctets)’ for CDS
     terms

   - ‘ccsds_ccs(CalendarVariant, FractionOctets)’ for byte encodings

   - ‘ccsds_ccs_time(CalendarVariant, FractionOctets)’ for CCS terms

For example:

     | ?- type::check(ccsds_cuc(4, 2, ccsds_epoch), [0, 0, 1, 0, 0, 128]).

     | ?- type::check(ccsds_cuc_time(4, 2), cuc_time(256, 128)).

     | ?- type::check(ccsds_cds(2, 0, ccsds_epoch), [0, 1, 0, 0, 7, 208]).

     | ?- type::check(ccsds_cds_time(2, 2), cds_time(1, 2000, 500)).

     | ?- type::check(ccsds_ccs(calendar, 0), [0x20, 0x26, 0x05, 0x08, 0x14, 0x30, 0x45]).

     | ?- type::check(ccsds_ccs_time(day_of_year, 1), ccs_ordinal_time(2026, 128, 14, 30, 45, 67)).


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<49>,  Next: Loading<50>,  Prev: Types and arbitrary generators<2>,  Up: ccsds_time_codes

6.30.6 API documentation
------------------------

Open the ‘../../apis/library_index.html#ccsds_time_codes’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<50>,  Next: Testing<45>,  Prev: API documentation<49>,  Up: ccsds_time_codes

6.30.7 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ccsds_time_codes(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<45>,  Prev: Loading<50>,  Up: ccsds_time_codes

6.30.8 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ccsds_time_codes(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: ccsds_time_fields,  Next: classification_protocols,  Prev: ccsds_time_codes,  Up: Libraries

6.31 ‘ccsds_time_fields’
========================

The ‘ccsds_time_fields’ library adds the self-describing time-field
layer that is missing between raw embedded time bytes and the
format-specific objects in ‘ccsds_time_codes’.

This library covers CCSDS binary P-fields for:

   - CUC time fields using 1 to 7 coarse octets and 0 to 10 fine octets,
     including the two-octet extended P-field encoding

   - CDS time fields using 16-bit or 24-bit day segments and either no
     submillisecond segment, a 16-bit microsecond segment, or a 32-bit
     picosecond segment

   - CCS time fields using either calendar or day-of-year encoding and
     up to 6 BCD fraction octets

* Menu:

* Representation: Representation<9>.
* Parsing and generating: Parsing and generating<4>.
* Descriptor helpers::
* API documentation: API documentation<50>.
* Loading: Loading<51>.
* Testing: Testing<46>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<9>,  Next: Parsing and generating<4>,  Up: ccsds_time_fields

6.31.1 Representation
---------------------

Descriptors are represented using the compound terms:

     cuc_descriptor(CoarseOctets, FineOctets, Epoch)
     cds_descriptor(DaySegmentOctets, SubmillisecondOctets, Epoch)
     ccs_descriptor(CalendarVariant, FractionOctets)

Where:

   - ‘Epoch’ is either ‘ccsds_epoch’ or ‘unix_epoch’

   - ‘CalendarVariant’ is either ‘calendar’ or ‘day_of_year’

This library uses the existing ‘ccsds_time_codes’ objects to parse and
generate the T-field bytes once the descriptor has been decoded.

For the current scope, the agency-defined epoch bit in CUC and CDS
descriptors is mapped to the existing ‘unix_epoch’ atom so callers can
keep using the same time-code objects and terms already provided by
‘ccsds_time_codes’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing and generating<4>,  Next: Descriptor helpers,  Prev: Representation<9>,  Up: ccsds_time_fields

6.31.2 Parsing and generating
-----------------------------

To parse a self-describing CUC time field:

     | ?- ccsds_time_fields::parse(bytes([0x1E, 0x00, 0x00, 0x01, 0x00, 0x00, 0x80]), Descriptor, TimeCode).

To parse a self-describing extended CUC time field:

     | ?- ccsds_time_fields::parse(bytes([0x9F, 0x28, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80]), Descriptor, TimeCode).

To generate the same time field from a descriptor and a time-code term:

     | ?- ccsds_time_fields::generate(bytes(Bytes), cuc_descriptor(4, 2, ccsds_epoch), cuc_time(256, 128)).

To parse a self-describing CDS time field:

     | ?- ccsds_time_fields::parse(bytes([0x40, 0x00, 0x01, 0x00, 0x00, 0x07, 0xD0]), Descriptor, TimeCode).

To parse a self-describing CDS time field with a 32-bit submillisecond
segment:

     | ?- ccsds_time_fields::parse(bytes([0x4E, 0x00, 0x00, 0x01, 0x00, 0x00, 0x07, 0xD0, 0x1D, 0xCD, 0x65, 0x00]), Descriptor, TimeCode).

To generate a self-describing CCS day-of-year time field:

     | ?- ccsds_time_fields::generate(bytes(Bytes), ccs_descriptor(day_of_year, 1), ccs_ordinal_time(2026, 128, 14, 30, 45, 67)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Descriptor helpers,  Next: API documentation<50>,  Prev: Parsing and generating<4>,  Up: ccsds_time_fields

6.31.3 Descriptor helpers
-------------------------

The library also provides helper predicates for descriptor
introspection:

   - ‘valid_descriptor/1’

   - ‘format/2’

   - ‘epoch/2’

For example:

     | ?- ccsds_time_fields::format(cds_descriptor(3, 4, unix_epoch), Format).

     | ?- ccsds_time_fields::epoch(ccs_descriptor(calendar, 1), Epoch).


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<50>,  Next: Loading<51>,  Prev: Descriptor helpers,  Up: ccsds_time_fields

6.31.4 API documentation
------------------------

Open the ‘../../apis/library_index.html#ccsds_time_fields’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<51>,  Next: Testing<46>,  Prev: API documentation<50>,  Up: ccsds_time_fields

6.31.5 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ccsds_time_fields(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<46>,  Prev: Loading<51>,  Up: ccsds_time_fields

6.31.6 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ccsds_time_fields(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: classification_protocols,  Next: clo_span_pattern_miner,  Prev: ccsds_time_fields,  Up: Libraries

6.32 ‘classification_protocols’
===============================

This library provides protocols used in the implementation of machine
learning classifier algorithms.  Datasets are represented as objects
implementing the ‘dataset_protocol’ protocol.  Classifiers are
represented as objects implementing the ‘classifier_protocol’ protocol.

This library also provides reusable shared categories, smoke tests, and
test datasets.  See below for details.

Logtalk currently provides several classifiers including
‘c45_classifier’, ‘knn_classifier’, ‘linear_svm_classifier’,
‘logistic_regression_classifier’, ‘naive_bayes_classifier’,
‘nearest_centroid_classifier’, and ‘random_forest_classifier’.  See
these libraries documentation for details.

* Menu:

* Shared category::
* Diagnostics: Diagnostics<2>.
* Export header format: Export header format<2>.
* API documentation: API documentation<51>.
* Loading: Loading<52>.
* Testing: Testing<47>.
* Test datasets: Test datasets<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Shared category,  Next: Diagnostics<2>,  Up: classification_protocols

6.32.1 Shared category
----------------------

The library includes one reusable category intended to be imported by
classifier algorithm implementations:

   - ‘classifier_common’ — shared diagnostics accessors and classifier
     export helpers.

This category keeps diagnostics access and file export behavior separate
from the algorithm-specific learning, prediction, and pretty-printing
code.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<2>,  Next: Export header format<2>,  Prev: Shared category,  Up: classification_protocols

6.32.2 Diagnostics
------------------

The ‘classifier_common’ category provides shared accessor predicates
such as ‘diagnostics/2’, ‘diagnostic/2’, and ‘classifier_options/2’.
These predicates make it possible to inspect learned-classifier metadata
without depending on the exact term representation used by a particular
classifier implementation.

The detailed contents of the diagnostics data are classifier-dependent.
For example, some classifiers report effective training options, while
others report structural metadata such as attribute names, feature
types, or the number of training examples or models.


File: TheLogtalkHandbook-3.100.1.info,  Node: Export header format<2>,  Next: API documentation<51>,  Prev: Diagnostics<2>,  Up: classification_protocols

6.32.3 Export header format
---------------------------

The shared classifier exporter in the ‘classifier_common’ category
writes a header before the exported clauses in the following format:

     % exported classifier predicate: Functor/Arity
     % training dataset: Dataset
     % dataset prediction schema: Functor(Attribute1, ..., AttributeN, Class)
     % diagnostics: Diagnostics
     % Functor(Classifier)
     Functor(Classifier)

The ‘dataset prediction schema’ line always uses an ASCII-only title
case conversion for the attribute names and class.  This line documents
the dataset-level prediction interface for readability, even when the
exported clauses serialize a model term instead of an executable
predictor relation.

When exporting a serialized classifier term, using a noun such as
‘classifier/1’ or ‘model/1’ is recommended.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<51>,  Next: Loading<52>,  Prev: Export header format<2>,  Up: classification_protocols

6.32.4 API documentation
------------------------

Open the ‘../../apis/library_index.html#classification_protocols’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<52>,  Next: Testing<47>,  Prev: API documentation<51>,  Up: classification_protocols

6.32.5 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

| ?- logtalk_load(classification_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<47>,  Next: Test datasets<2>,  Prev: Loading<52>,  Up: classification_protocols

6.32.6 Testing
--------------

To test this library predicates, shared categories, and datasets, load
the ‘tester.lgt’ file:

| ?- logtalk_load(classification_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test datasets<2>,  Prev: Testing<47>,  Up: classification_protocols

6.32.7 Test datasets
--------------------

Several sample datasets are included in the ‘test_datasets’ directory:

   - ‘play_tennis.lgt’ — The classic weather/tennis dataset with 14
     examples and 4 discrete attributes (outlook, temperature, humidity,
     wind).  Originally from Quinlan (1986) and widely used in machine
     learning textbooks including Mitchell (1997).  Also available from
     the UCI Machine Learning Repository:
     ‘https://archive.ics.uci.edu/dataset/349/tennis+major+tournament+match+statistics’

   - ‘contact_lenses.lgt’ — A dataset with 24 examples and 4 discrete
     attributes (age, spectacle prescription, astigmatism, tear
     production rate) for deciding the type of contact lenses to
     prescribe.  Originally from Cendrowska, J. (1987).  PRISM: An
     algorithm for inducing modular rules.  'International Journal of
     Man-Machine Studies', 27(4), 349-370.  Available from the UCI
     Machine Learning Repository:
     ‘https://archive.ics.uci.edu/dataset/58/lenses’

   - ‘iris.lgt’ — The classic Iris flower dataset with 150 examples and
     4 continuous attributes (sepal length, sepal width, petal length,
     petal width) for classifying iris species (setosa, versicolor,
     virginica).  Originally from Fisher, R.A. (1936).  The use of
     multiple measurements in taxonomic problems.  'Annals of Eugenics',
     7(2), 179-188.  Available from the UCI Machine Learning Repository:
     ‘https://archive.ics.uci.edu/dataset/53/iris’

   - ‘breast_cancer.lgt’ — A dataset with 286 examples and 9 discrete
     attributes (age, menopause, tumor size, inv-nodes, node-caps,
     degree of malignancy, breast, breast quadrant, irradiation) for
     predicting breast cancer recurrence events.  Contains missing
     values (9 examples with missing values in the node-caps and
     breast-quad attributes, represented using anonymous variables).
     Originally from the Institute of Oncology, University Medical
     Centre, Ljubljana, Yugoslavia.  Donors: Ming Tan and Jeff
     Schlimmer.  Available from the UCI Machine Learning Repository:
     ‘https://archive.ics.uci.edu/dataset/14/breast+cancer’


File: TheLogtalkHandbook-3.100.1.info,  Node: clo_span_pattern_miner,  Next: clustering_protocols,  Prev: classification_protocols,  Up: Libraries

6.33 ‘clo_span_pattern_miner’
=============================

CloSpan closed sequential pattern miner for sequence datasets.  The
library depends on the ‘sequential_pattern_mining_protocols’ support
library, implements the generic ‘pattern_miner_protocol’ defined in the
‘pattern_mining_protocols’ core library, and mines closed frequent
sequential patterns directly using closure-aware projected-database
search with explicit projected-database-equivalence backward pruning
that skips equivalent branches before recursion, together with a
same-support closed frontier that merges branch results during the
search without a final post-filter.

Requires a dataset implementing ‘sequence_dataset_protocol’ with
sequences represented as ordered lists of canonical sorted itemsets over
a declared item domain.

* Menu:

* API documentation: API documentation<52>.
* Loading: Loading<53>.
* Testing: Testing<48>.
* Features: Features<9>.
* Options: Options<9>.
* Pattern miner representation: Pattern miner representation<2>.
* References: References<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<52>,  Next: Loading<53>,  Up: clo_span_pattern_miner

6.33.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#clo_span_pattern_miner’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<53>,  Next: Testing<48>,  Prev: API documentation<52>,  Up: clo_span_pattern_miner

6.33.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(clo_span_pattern_miner(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<48>,  Next: Features<9>,  Prev: Loading<53>,  Up: clo_span_pattern_miner

6.33.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(clo_span_pattern_miner(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<9>,  Next: Options<9>,  Prev: Testing<48>,  Up: clo_span_pattern_miner

6.33.4 Features
---------------

   - 'Closed Pattern Mining': Retains only frequent sequential patterns
     that have no superpattern with the same support.

   - 'Backward and Closure Pruning': Uses projected-database equivalence
     to skip equivalent backward-growth branches before recursion, then
     maintains a same-support closed frontier to suppress dominated
     patterns during the search instead of post-filtering another miner
     output.

   - 'Canonical Sequences': Uses the shared sequential validation logic
     from the support library.

   - 'Flexible Support Thresholds': Supports relative minimum support
     and absolute minimum support count.  When both are given, the
     absolute-count threshold takes precedence.

   - 'Model Export': Closed pattern collections can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<9>,  Next: Pattern miner representation<2>,  Prev: Features<9>,  Up: clo_span_pattern_miner

6.33.5 Options
--------------

The ‘mine/3’ predicate accepts the following options:

   - ‘minimum_support/1’: Relative minimum support threshold in the
     interval ‘]0.0, 1.0]’.  The default is ‘0.5’.

   - ‘minimum_support_count/1’: Absolute minimum support count.  When
     both support options are provided, this option takes precedence.

   - ‘maximum_pattern_length/1’: Maximum total number of items in a
     mined sequential pattern.  The default is ‘1000’, effectively
     capped by the longest sequence in the dataset.

   - ‘minimum_pattern_length/1’: Minimum total number of items retained
     in the mined result.  The default is ‘1’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pattern miner representation<2>,  Next: References<6>,  Prev: Options<9>,  Up: clo_span_pattern_miner

6.33.6 Pattern miner representation
-----------------------------------

The mined pattern miner result is represented by a compound term with
the functor chosen by the implementation and arity 3.  For example:

     clo_span_pattern_miner(ItemDomain, Patterns, Options)

Where:

   - ‘ItemDomain’: Canonical sorted list of declared dataset items.

   - ‘Patterns’: List of ‘sequence_pattern(Pattern, SupportCount)’ terms
     ordered first by total item count and then lexicographically.

   - ‘Options’: Effective mining options used to mine the closed
     sequential patterns.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<6>,  Prev: Pattern miner representation<2>,  Up: clo_span_pattern_miner

6.33.7 References
-----------------

  1. Yan, X., Han, J., and Afshar, R. (2003) - “CloSpan: Mining closed
     sequential patterns in large datasets”.


File: TheLogtalkHandbook-3.100.1.info,  Node: clustering_protocols,  Next: colley_ranker,  Prev: clo_span_pattern_miner,  Up: Libraries

6.34 ‘clustering_protocols’
===========================

This library provides protocols used in the implementation of machine
learning clustering algorithms.  Datasets are represented as objects
implementing the ‘clustering_dataset_protocol’ protocol.  Clusterers are
represented as objects implementing the ‘clusterer_protocol’ protocol.

This library also provides test datasets and a small smoke-test suite.
The shared test suite also includes cross-library comparison tests for
clusterers that implement the same protocols, allowing common datasets
and validation failures to be checked in one place.

Concrete clustering algorithms are intentionally out of scope for this
package.  The goal is to provide a portable foundation for future
libraries such as ‘kmeans_clusterer’.

* Menu:

* API documentation: API documentation<53>.
* Loading: Loading<54>.
* Testing: Testing<49>.
* Test datasets: Test datasets<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<53>,  Next: Loading<54>,  Up: clustering_protocols

6.34.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#clustering_protocols’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<54>,  Next: Testing<49>,  Prev: API documentation<53>,  Up: clustering_protocols

6.34.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(clustering_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<49>,  Next: Test datasets<3>,  Prev: Loading<54>,  Up: clustering_protocols

6.34.3 Testing
--------------

To run the library smoke tests and shared comparison tests, load the
‘tester.lgt’ file:

     | ?- logtalk_load(clustering_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test datasets<3>,  Prev: Testing<49>,  Up: clustering_protocols

6.34.4 Test datasets
--------------------

Several sample datasets are included in the ‘test_datasets’ directory:

   - ‘all_noise.lgt’ — A synthetic 2D continuous dataset with 4 examples
     and 2 continuous attributes (‘x’, ‘y’).  The examples are well
     separated, making the dataset useful for all-noise tests where a
     density-based clusterer should reject every point under a small
     epsilon radius.

   - ‘bridge_noise.lgt’ — A synthetic 2D continuous dataset with 10
     examples and 2 continuous attributes (‘x’, ‘y’).  The examples form
     two dense blobs connected by two sparse bridge points, making the
     dataset suitable for testing density-based algorithms that should
     keep the blobs separate while treating the bridge as noise.

   - ‘dead_component_blobs.lgt’ — A synthetic 2D continuous dataset with
     6 examples and 2 continuous attributes (‘x’, ‘y’).  The examples
     form two tiny ordered blobs sized so an over-specified Gaussian
     mixture with ‘first_k’ initialization can drive one component fully
     dead, making the dataset useful for dead-component policy
     regression tests.

   - ‘duplicate_points.lgt’ — A synthetic 2D continuous dataset with 6
     examples and 2 continuous attributes (‘x’, ‘y’).  The examples
     include repeated coordinates forming a dense local cluster plus one
     isolated outlier, making the dataset useful for duplicate-point and
     density-threshold tests.

   - ‘imbalanced_three_modes.lgt’ — A synthetic 2D continuous dataset
     with 9 examples and 2 continuous attributes (‘x’, ‘y’).  The
     examples form one dense blob plus two much sparser distant modes,
     making the dataset useful for imbalanced-cluster and Gaussian
     mixture stress tests.

   - ‘iris_unlabeled.lgt’ — A compact Iris-derived dataset with 9
     examples and 4 continuous attributes (‘sepal_length’,
     ‘sepal_width’, ‘petal_length’, ‘petal_width’).  It is derived from
     the classic Iris dataset but intentionally omits species labels so
     it can be used with unsupervised algorithms.

   - ‘large_two_blobs.lgt’ — A synthetic 2D continuous dataset with 100
     examples and 2 continuous attributes (‘x’, ‘y’).  The examples form
     two dense 5x10 grids that are well separated, making the dataset
     useful for performance benchmarks that need a larger deterministic
     density-based clustering workload than the small smoke-test
     datasets.

   - ‘mixed_profiles.lgt’ — A mixed-feature dataset with 6 examples, 2
     continuous attributes (‘age’, ‘income’), and 2 discrete attributes
     (‘channel’, ‘region’).  This dataset is intended for clustering
     algorithms that support both numeric and categorical features.

   - ‘scaling_bands.lgt’ — A synthetic 2D continuous dataset with 6
     examples and 2 continuous attributes (‘x’, ‘y’).  The examples form
     two horizontal bands with large variation along ‘x’, making the
     dataset useful for tests that compare clustering behavior with
     feature scaling turned on versus off.

   - ‘shopping_profiles.lgt’ — A categorical dataset with 6 examples and
     4 discrete attributes (‘channel’, ‘region’, ‘loyalty’, ‘device’).
     The examples form two clear shopping-profile segments suitable for
     categorical clustering smoke tests.

   - ‘single_blob.lgt’ — A synthetic 2D continuous dataset with 6
     examples and 2 continuous attributes (‘x’, ‘y’).  The examples form
     a single compact blob suitable for one-cluster smoke tests.

   - ‘two_blobs.lgt’ — A synthetic 2D continuous dataset with 8 examples
     and 2 continuous attributes (‘x’, ‘y’).  The examples form two
     compact, well-separated blobs suitable for deterministic clustering
     smoke tests.


File: TheLogtalkHandbook-3.100.1.info,  Node: colley_ranker,  Next: combinations,  Prev: clustering_protocols,  Up: Libraries

6.35 ‘colley_ranker’
====================

Colley pairwise preference ranker.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  Requires well-formed connected pairwise datasets so that the
learned rankings remain globally comparable across all ranked items.

* Menu:

* API documentation: API documentation<54>.
* Loading: Loading<55>.
* Testing: Testing<50>.
* Features: Features<10>.
* Scoring semantics: Scoring semantics<2>.
* Usage: Usage<22>.
* Diagnostics syntax: Diagnostics syntax<4>.
* Ranker representation: Ranker representation<3>.
* References: References<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<54>,  Next: Loading<55>,  Up: colley_ranker

6.35.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#colley_ranker’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<55>,  Next: Testing<50>,  Prev: API documentation<54>,  Up: colley_ranker

6.35.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(colley_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<50>,  Next: Features<10>,  Prev: Loading<55>,  Up: colley_ranker

6.35.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(colley_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<10>,  Next: Scoring semantics<2>,  Prev: Testing<50>,  Up: colley_ranker

6.35.4 Features
---------------

   - 'Pairwise Preference Learning': Learns one deterministic rating per
     item from aggregated pairwise outcomes.

   - 'Colley Matrix Fidelity': Solves the standard Colley linear system
     with diagonal regularization ‘2 + games_i’ and off-diagonal entries
     ‘-games_ij’.

   - 'Numerically Hardened Solver': Uses Gaussian elimination with
     partial pivoting plus residual checks before accepting the learned
     ratings.

   - 'Conservative Ratings': Produces ratings in the interval ‘[0,1]’
     with the neutral prior centered at ‘0.5’.

   - 'Deterministic Ranking': Orders candidate items by learned rating
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     comparison graphs.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Ranking Infrastructure': Reuses the ‘ranking_protocols’
     helpers for dataset validation, diagnostics, export, and candidate
     ranking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoring semantics<2>,  Next: Usage<22>,  Prev: Features<10>,  Up: colley_ranker

6.35.5 Scoring semantics
------------------------

This implementation aggregates pairwise preferences into matchup totals
and then solves the Colley system

     C r = b

where ‘C_ii = 2 + games_i’, ‘C_ij = -games_ij’ for ‘i \= j’, and ‘b_i =
1 + (wins_i - losses_i) / 2’.

The linear system is solved using deterministic Gaussian elimination
with partial pivoting.  The implementation also verifies that the
recovered solution has a small residual and only clamps negligible
floating-point boundary noise at ‘0.0’ or ‘1.0’; materially invalid
out-of-range values are rejected instead of being silently accepted.

The resulting ratings remain close to ‘0.5’ when evidence is weak and
move toward ‘1.0’ or ‘0.0’ only when repeated pairwise results justify
doing so.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<22>,  Next: Diagnostics syntax<4>,  Prev: Scoring semantics<2>,  Up: colley_ranker

6.35.6 Usage
------------

* Menu:

* Learning a ranker: Learning a ranker<3>.
* Inspecting diagnostics: Inspecting diagnostics<3>.
* Ranking candidate items: Ranking candidate items<3>.
* Exporting the ranker: Exporting the ranker<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<3>,  Next: Inspecting diagnostics<3>,  Up: Usage<22>

6.35.6.1 Learning a ranker
..........................

     % Learn from a pairwise ranking dataset object
     | ?- colley_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with an explicit empty options list
     | ?- colley_ranker::learn(my_dataset, Ranker, []).
     ...

The current implementation accepts only the empty options list ‘[]’.
Any non-empty options list is rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<3>,  Next: Ranking candidate items<3>,  Prev: Learning a ranker<3>,  Up: Usage<22>

6.35.6.2 Inspecting diagnostics
...............................

     % Inspect model and dataset summary metadata
     | ?- colley_ranker::learn(my_dataset, Ranker),
          colley_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<3>,  Next: Exporting the ranker<3>,  Prev: Inspecting diagnostics<3>,  Up: Usage<22>

6.35.6.3 Ranking candidate items
................................

     % Rank a candidate set from most preferred to least preferred
     | ?- colley_ranker::learn(my_dataset, Ranker),
          colley_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<3>,  Prev: Ranking candidate items<3>,  Up: Usage<22>

6.35.6.4 Exporting the ranker
.............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- colley_ranker::learn(my_dataset, Ranker),
          colley_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(colley_ranker(...))]
     ...

     % Export to a file
     | ?- colley_ranker::learn(my_dataset, Ranker),
          colley_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<4>,  Next: Ranker representation<3>,  Prev: Usage<22>,  Up: colley_ranker

6.35.7 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(colley_ranker),
         options(Options),
         dataset_summary(DatasetSummary)
     ]


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<3>,  Next: References<7>,  Prev: Diagnostics syntax<4>,  Up: colley_ranker

6.35.8 Ranker representation
----------------------------

The learned ranker is represented by a compound term of the form:

     colley_ranker(Items, Ratings, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Rating’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options and dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<7>,  Prev: Ranker representation<3>,  Up: colley_ranker

6.35.9 References
-----------------

  1. Colley, W. N. (2002).  'Colley’s bias free college football ranking
     method: The Colley Matrix explained'.


File: TheLogtalkHandbook-3.100.1.info,  Node: combinations,  Next: command_line_options,  Prev: colley_ranker,  Up: Libraries

6.36 ‘combinations’
===================

This library provides predicates for generating and querying
combinations over lists.  The following categories of predicates are
provided:

   - 'Generation operations' - Predicates for generating combinations.

   - 'Ordering variants' - Predicates that support an additional order
     argument (‘default’, ‘lexicographic’, or ‘shortlex’) for
     controlling output order.

   - 'Distinct-value generation' - Predicates for generating
     combinations while deduplicating equal-valued results.

   - 'Indexed access' - Predicates for direct access to combinations at
     specific positions, including distinct combinations.

   - 'Counting operations' - Predicates for counting combinations and
     distinct combinations.

   - 'Random selection' - Predicates for randomly selecting and sampling
     combinations and distinct combinations.

   - 'Stepping operations' - Predicates for moving to the next or
     previous combination in lexicographic order.

Dedicated ‘arrangements’, ‘cartesian_products’, ‘multisets’,
‘permutations’, ‘derangements’, ‘partitions’, and ‘subsequences’
libraries are also available for focused APIs on related operations.
The ‘multisets’ library is the repetition-allowed counterpart to this
library.

* Menu:

* API documentation: API documentation<55>.
* Loading: Loading<56>.
* Testing: Testing<51>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<55>,  Next: Loading<56>,  Up: combinations

6.36.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#combinations’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<56>,  Next: Testing<51>,  Prev: API documentation<55>,  Up: combinations

6.36.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(combinations(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<51>,  Prev: Loading<56>,  Up: combinations

6.36.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(combinations(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: command_line_options,  Next: core,  Prev: combinations,  Up: Libraries

6.37 ‘command_line_options’
===========================

This library provides command-line parsing predicates where command-line
options are defined as objects that import the ‘command_line_option’
category.  Predicates are also provided for generating help text.

Parsed options are returned by default as a list of ‘Name(Value)’ terms.
A parser option, ‘output_functor(Functor)’, allows returning options as
‘Functor(Key, Value)’ terms instead.

Adapted with significant changes from the SWI-Prolog ‘optparse’ library
by Marcus Uneson.  Most documentation, parsing options, and help options
retained from the original library.  Command line options specification
changed to an object-based representation.  Parsing simplified, no
longer using DCGs.  Comprehensive set of tests added, based on
documentation examples.  Full portability to all supported backends.

* Menu:

* API documentation: API documentation<56>.
* Loading: Loading<57>.
* Testing: Testing<52>.
* Terminology::
* Defining option objects::
* Validating option definitions::
* Example option objects::
* Parsing command-line arguments::
* Generating help text::
* Help options::
* Parse options::
* Notes and tips::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<56>,  Next: Loading<57>,  Up: command_line_options

6.37.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#command_line_options’ file in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<57>,  Next: Testing<52>,  Prev: API documentation<56>,  Up: command_line_options

6.37.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(command_line_options(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<52>,  Next: Terminology,  Prev: Loading<57>,  Up: command_line_options

6.37.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(command_line_options(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Terminology,  Next: Defining option objects,  Prev: Testing<52>,  Up: command_line_options

6.37.4 Terminology
------------------

The terminology is partly borrowed from Python (see
‘http://docs.python.org/library/optparse.html#terminology’).
'Arguments' are what you provide on the command line and for many Prolog
systems show up as a list of atoms ‘Args’ in ‘current_prolog_flag(argv,
Args)’.  They can be divided into:

   - 'Runtime arguments', which control the Prolog runtime;
     conventionally terminated by ‘--’.

   - 'Options', which are key-value pairs (with a boolean value possibly
     implicit) intended to control your program.

   - 'Positional arguments', which are what remains after all runtime
     arguments and options have been removed (with implicit arguments
     ‘true’/‘false’ for booleans filled in).

Positional arguments are used for mandatory arguments without sensible
defaults (e.g., input file names).  Options offer flexibility by letting
you change a default setting.  This library has no notion of mandatory
or required options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining option objects,  Next: Validating option definitions,  Prev: Terminology,  Up: command_line_options

6.37.5 Defining option objects
------------------------------

Define command-line options by creating objects that import the
‘command_line_option’ category.  Each object represents one command-line
option and overrides the predicates to specify its properties.

Create an object that imports ‘command_line_option’ and override the
following predicates:

   - ‘key/1’: The key used to identify this option in the result.  This
     predicate must be overridden.

   - ‘short_flags/1’: List of single-character short flags (e.g., ‘[v]’
     for ‘-v’).  Default: ‘[]’.

   - ‘long_flags/1’: List of long flags (e.g., ‘[verbose]’ for
     ‘--verbose’).  Default: ‘[]’.

   - ‘type/1’: Option value type.  One of ‘boolean’, ‘atom’, ‘integer’,
     ‘float’, or ‘term’.  Default: ‘term’.

   - ‘default/1’: Default value.  Optional.

   - ‘meta/1’: Metasyntactic variable name for help text.  Default:
     ‘''’.

   - ‘help/1’: Help text (atom or list of atoms for pre-broken lines).
     Default: ‘''’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Validating option definitions,  Next: Example option objects,  Prev: Defining option objects,  Up: command_line_options

6.37.6 Validating option definitions
------------------------------------

Option objects provide two predicates for validating their definitions:

   - ‘check/0’: Validates the option definition, throwing an error if
     invalid.  The validation checks:

        - The ‘key/1’ predicate is defined (not just using the default).

        - All short flags are single characters.

        - The type is a known type (supported by the ‘type’ library).

        - If a default value is defined and the type is not ‘term’, the
          default value matches the declared type.

   - ‘valid/0’: Succeeds deterministically if the option definition is
     valid, fails otherwise.  This is useful when you want to check
     validity without handling exceptions.

The ‘parse/4-5’ and ‘help/2-3’ predicates automatically call ‘check/0’
on all option objects before processing, ensuring invalid definitions
are caught early with clear error messages.

Example:

     | ?- verbose_option::check.
     yes

     | ?- verbose_option::valid.
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Example option objects,  Next: Parsing command-line arguments,  Prev: Validating option definitions,  Up: command_line_options

6.37.7 Example option objects
-----------------------------

     :- object(verbose_option,
         imports(command_line_option)).

         key(verbose).
         short_flags([v]).
         long_flags([verbosity]).
         type(integer).
         default(2).
         meta('V').
         help('verbosity level, 1 <= V <= 3').

     :- end_object.


     :- object(mode_option,
         imports(command_line_option)).

         key(mode).
         short_flags([m]).
         long_flags([mode]).
         type(atom).
         default('SCAN').
         help(['data gathering mode, one of',
               '  SCAN: do this',
               '  READ: do that',
               '  MAKE: fabricate numbers',
               '  WAIT: do nothing']).

     :- end_object.


     :- object(cache_option,
         imports(command_line_option)).

         key(cache).
         short_flags([r]).
         long_flags(['rebuild-cache']).
         type(boolean).
         default(true).
         help('rebuild cache in each iteration').

     :- end_object.


     :- object(outfile_option,
         imports(command_line_option)).

         key(outfile).
         short_flags([o]).
         long_flags(['output-file']).
         type(atom).
         meta('FILE').
         help('write output to FILE').

     :- end_object.


     % Configuration parameter without command-line flags
     :- object(path_option,
         imports(command_line_option)).

         key(path).
         default('/some/file/path/').

     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing command-line arguments,  Next: Generating help text,  Prev: Example option objects,  Up: command_line_options

6.37.8 Parsing command-line arguments
-------------------------------------

Use the ‘command_line_options’ object ‘parse/4-5’ predicates:

     | ?- command_line_options::parse(
              [verbose_option, mode_option, cache_option, outfile_option],
              ['-v', '5', '-m', 'READ', '-ooutput.txt', 'input.txt'],
              Options,
              PositionalArguments
          ).

     Options = [verbose(5), mode('READ'), cache(true), outfile('output.txt')],
     PositionalArguments = ['input.txt'].


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating help text,  Next: Help options,  Prev: Parsing command-line arguments,  Up: command_line_options

6.37.9 Generating help text
---------------------------

Use the ‘command_line_options::help/2’ predicate for default formatting:

     | ?- command_line_options::help([verbose_option, mode_option, cache_option], Help).

Or use ‘command_line_options::help/3’ with custom help options:

     | ?- command_line_options::help([verbose_option, mode_option], Help, [line_width(100)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Help options,  Next: Parse options,  Prev: Generating help text,  Up: command_line_options

6.37.10 Help options
--------------------

The ‘help/3’ predicate supports the following help options:

   - ‘line_width(Width)’: Maximum line width for help text.  Default:
     ‘80’.

   - ‘min_help_width(Width)’: Minimum width for help text column.
     Default: ‘40’.

   - ‘break_long_flags(Boolean)’: If ‘true’, break long flags across
     multiple lines.  Default: ‘false’.

   - ‘suppress_empty_meta(Boolean)’: If ‘true’ (default), suppress empty
     metasyntactic variables in help output.


File: TheLogtalkHandbook-3.100.1.info,  Node: Parse options,  Next: Notes and tips,  Prev: Help options,  Up: command_line_options

6.37.11 Parse options
---------------------

The ‘parse/5’ predicate supports the following parse options:

   - ‘output_functor(Functor)’: When defined, options are returned as
     ‘Functor(Key, Value)’ terms instead of ‘Key(Value)’ terms.  No
     default.

   - ‘duplicated_flags(Keep)’: How to handle duplicate options.  One of
     ‘keepfirst’, ‘keeplast’, ‘keepall’.  Default: ‘keeplast’.

   - ‘allow_empty_flag_spec(Boolean)’: If ‘true’ (default), options
     without flags are allowed (useful for configuration parameters).
     Set to ‘false’ to raise errors on empty flags.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes and tips,  Prev: Parse options,  Up: command_line_options

6.37.12 Notes and tips
----------------------

   - The default type is ‘term’, which subsumes ‘integer’, ‘float’, and
     ‘atom’.  However, always specifying types is recommended for
     reliable parsing and clear error messages.

   - ‘-sbar’ is taken as ‘-s bar’, not as ‘-s -b -a -r’ (no clustering).

   - ‘-s=foo’ is disallowed.

   - Duplicate flags default to ‘keeplast’ (controllable via the
     ‘duplicated_flags’ parse option).

   - Unknown flags (not in the specification) will raise errors.


File: TheLogtalkHandbook-3.100.1.info,  Node: core,  Next: copeland_ranker,  Prev: command_line_options,  Up: Libraries

6.38 ‘core’
===========

This library consists of built-in entities.

* Menu:

* API documentation: API documentation<57>.
* Loading: Loading<58>.
* Testing: Testing<53>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<57>,  Next: Loading<58>,  Up: core

6.38.1 API documentation
------------------------

See this Handbook “Objects”, “Protocols”, and “Categories” sections.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<58>,  Next: Testing<53>,  Prev: API documentation<57>,  Up: core

6.38.2 Loading
--------------

All entities in this library are automatically loaded at Logtalk
startup.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<53>,  Prev: Loading<58>,  Up: core

6.38.3 Testing
--------------

Tests for this library can be found in the ‘tests/logtalk/entities’
directory.


File: TheLogtalkHandbook-3.100.1.info,  Node: copeland_ranker,  Next: coroutining,  Prev: core,  Up: Libraries

6.39 ‘copeland_ranker’
======================

Copeland pairwise preference ranker.  Ranks each item by its number of
matchup wins minus losses after aggregating weighted pairwise
preferences per observed opponent pair.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preference judgments, using it to order candidate
items, and exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The training dataset must declare each ranked item once, use
only declared items in preferences, assign positive weights to
preferences between distinct items, and induce a connected undirected
comparison graph.

* Menu:

* API documentation: API documentation<58>.
* Loading: Loading<59>.
* Testing: Testing<54>.
* Features: Features<11>.
* Scoring semantics: Scoring semantics<3>.
* Usage: Usage<23>.
* Diagnostics syntax: Diagnostics syntax<5>.
* Options: Options<10>.
* Ranker representation: Ranker representation<4>.
* References: References<8>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<58>,  Next: Loading<59>,  Up: copeland_ranker

6.39.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#copeland_ranker’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<59>,  Next: Testing<54>,  Prev: API documentation<58>,  Up: copeland_ranker

6.39.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(copeland_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<54>,  Next: Features<11>,  Prev: Loading<59>,  Up: copeland_ranker

6.39.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(copeland_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<11>,  Next: Scoring semantics<3>,  Prev: Testing<54>,  Up: copeland_ranker

6.39.4 Features
---------------

   - 'Pairwise Preference Learning': Learns one deterministic score per
     item from pairwise preference datasets.

   - 'Portable Copeland Scoring': Computes Copeland scores from
     aggregated head-to-head outcomes using only standard Logtalk
     library predicates.

   - 'Integer Score Semantics': Learned scores are restricted to
     integers, because each observed aggregated matchup contributes
     exactly ‘+1’, ‘-1’, or ‘0’ to an item’s total score.

   - 'Deterministic Ranking': Orders candidate items by learned score
     with deterministic tie-breaking using the standard term order of
     the item identifiers after sorting by descending score.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items in preferences, self-preferences, non-positive weights, and
     disconnected comparison graphs.

   - 'Training Diagnostics': Learned rankers include dataset summary
     metadata that can be accessed using the ‘diagnostics/2’ predicate.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Ranking Infrastructure': Uses the common
     ‘ranking_protocols’ helper predicates for option processing,
     dataset validation, diagnostics, export, and candidate ranking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoring semantics<3>,  Next: Usage<23>,  Prev: Features<11>,  Up: copeland_ranker

6.39.5 Scoring semantics
------------------------

This implementation uses a Copeland score defined over aggregated
observed matchups.  For each unordered pair of observed opponents, the
preference data is aggregated into total wins for the left and right
item.  The item with the higher aggregated total receives ‘+1’ for that
matchup, the item with the lower total receives ‘-1’, and both receive
‘0’ when the aggregated totals tie.

Only observed opponent pairs contribute to the learned scores.
Unobserved pairs are ignored rather than treated as implicit ties.  This
makes the implementation a sparse-data Copeland variant suitable for
incomplete pairwise datasets.

Because each observed matchup contributes only ‘+1’, ‘-1’, or ‘0’, every
learned Copeland score is an integer.  The ranker validation logic
enforces this invariant when consuming serialized or exported ranker
terms so that malformed non-integer score payloads are rejected instead
of silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<23>,  Next: Diagnostics syntax<5>,  Prev: Scoring semantics<3>,  Up: copeland_ranker

6.39.6 Usage
------------

* Menu:

* Learning a ranker: Learning a ranker<4>.
* Inspecting diagnostics: Inspecting diagnostics<4>.
* Ranking candidate items: Ranking candidate items<4>.
* Exporting the ranker: Exporting the ranker<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<4>,  Next: Inspecting diagnostics<4>,  Up: Usage<23>

6.39.6.1 Learning a ranker
..........................

     % Learn from a pairwise ranking dataset object
     | ?- copeland_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with an explicit empty options list
     | ?- copeland_ranker::learn(my_dataset, Ranker, []).
     ...

The current implementation accepts only the empty options list ‘[]’.
Any non-empty options list is rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<4>,  Next: Ranking candidate items<4>,  Prev: Learning a ranker<4>,  Up: Usage<23>

6.39.6.2 Inspecting diagnostics
...............................

     % Inspect model and dataset summary metadata
     | ?- copeland_ranker::learn(my_dataset, Ranker),
          copeland_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<4>,  Next: Exporting the ranker<4>,  Prev: Inspecting diagnostics<4>,  Up: Usage<23>

6.39.6.3 Ranking candidate items
................................

     % Rank a candidate set from most preferred to least preferred
     | ?- copeland_ranker::learn(my_dataset, Ranker),
          copeland_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<4>,  Prev: Ranking candidate items<4>,  Up: Usage<23>

6.39.6.4 Exporting the ranker
.............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- copeland_ranker::learn(my_dataset, Ranker),
          copeland_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(copeland_ranker(...))]
     ...

     % Export to a file
     | ?- copeland_ranker::learn(my_dataset, Ranker),
          copeland_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<5>,  Next: Options<10>,  Prev: Usage<23>,  Up: copeland_ranker

6.39.7 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(copeland_ranker),
         options(Options),
         dataset_summary(DatasetSummary)
     ]

Where:

   - ‘model(copeland_ranker)’ identifies the learning algorithm that
     produced the ranker.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘dataset_summary(DatasetSummary)’ stores a summary list describing
     the validated training dataset.

The current ‘dataset_summary/1’ payload has the form:

     [
         items(NumberOfItems),
         preferences(NumberOfPreferences),
         connected_components(NumberOfComponents),
         isolated_items(IsolatedItems)
     ]

Use the ‘ranking_protocols’ ‘diagnostic/2’ and ‘ranker_options/2’ helper
predicates when you only need a single metadata term or the effective
options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<10>,  Next: Ranker representation<4>,  Prev: Diagnostics syntax<5>,  Up: copeland_ranker

6.39.8 Options
--------------

The current ‘learn/3’ implementation does not define any user options
beyond the default empty list.  Non-empty options lists are rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<4>,  Next: References<8>,  Prev: Options<10>,  Up: copeland_ranker

6.39.9 Ranker representation
----------------------------

The learned ranker is represented by a compound term of the form:

     copeland_ranker(Items, Scores, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Score’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options and dataset summary.

The ‘Scores’ payload is expected to contain integer Copeland scores
only.  This restriction is not just an implementation preference but a
direct consequence of the scoring semantics: each observed aggregated
matchup changes an item’s score by one of the three integer values ‘+1’,
‘-1’, or ‘0’.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
ranker term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<8>,  Prev: Ranker representation<4>,  Up: copeland_ranker

6.39.10 References
------------------

  1. Copeland, A. H. (1951).  A reasonable social welfare function.
     'Seminar on Mathematics in the Social Sciences, University of
     Michigan'.


File: TheLogtalkHandbook-3.100.1.info,  Node: coroutining,  Next: crs_projections,  Prev: copeland_ranker,  Up: Libraries

6.40 ‘coroutining’
==================

The ‘coroutining’ object provides a portable abstraction over how common
coroutining predicates are made available by the supported backend
Prolog systems (ECLiPSe, SICStus Prolog, SWI-Prolog, Trealla Prolog,
XVM, and YAP) that provide them.  Partial support for XSB is provided
(the predicate ‘frozen/2’ is not available and calls to it fail).

Calls to the library predicates are inlined when compiled with the
‘optimize’ flag turned on.  In this case, there is no overhead compared
with calling the abstracted predicates directly.

See also the ‘dif’ library.

* Menu:

* API documentation: API documentation<59>.
* Loading: Loading<60>.
* Testing: Testing<55>.
* Usage: Usage<24>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<59>,  Next: Loading<60>,  Up: coroutining

6.40.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#coroutining’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<60>,  Next: Testing<55>,  Prev: API documentation<59>,  Up: coroutining

6.40.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(coroutining(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<55>,  Next: Usage<24>,  Prev: Loading<60>,  Up: coroutining

6.40.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(coroutining(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<24>,  Prev: Testing<55>,  Up: coroutining

6.40.4 Usage
------------

Load this library from your application loader file.  To call the
coroutining predicates using implicit message-sending, add the following
directive to any object or category calling the predicates (adjust the
list to the predicates actually called):

     :- uses(coroutining, [
         dif/2, dif/1, freeze/2, frozen/2, when/2
     ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: crs_projections,  Next: csv,  Prev: coroutining,  Up: Libraries

6.41 ‘crs_projections’
======================

This library provides a ‘crs_projections_protocol’ protocol and a
‘crs_projections’ object for working with a small set of common
coordinate reference systems and transforming coordinates between them.

Both 2D and explicit 3D WGS84 geodetic coordinates are supported.

* Menu:

* API documentation: API documentation<60>.
* Loading: Loading<61>.
* Testing: Testing<56>.
* Supported coordinate reference systems::
* Usage: Usage<25>.
* Notes::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<60>,  Next: Loading<61>,  Up: crs_projections

6.41.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#crs_projections’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<61>,  Next: Testing<56>,  Prev: API documentation<60>,  Up: crs_projections

6.41.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(crs_projections(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<56>,  Next: Supported coordinate reference systems,  Prev: Loading<61>,  Up: crs_projections

6.41.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(crs_projections(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported coordinate reference systems,  Next: Usage<25>,  Prev: Testing<56>,  Up: crs_projections

6.41.4 Supported coordinate reference systems
---------------------------------------------

The library currently supports:

   - ‘wgs84’ geographic coordinates represented as
     ‘geographic(Latitude,Longitude)’ in degrees

   - ‘wgs84_3d’ geographic coordinates represented as
     ‘geographic(Latitude,Longitude,EllipsoidalHeight)’ in degrees and
     meters

   - ‘web_mercator’ projected coordinates represented as
     ‘projected(X,Y)’ in meters

   - ‘world_mercator’ projected coordinates represented as
     ‘projected(X,Y)’ in meters

   - ‘ecef’ geocentric coordinates represented as ‘ecef(X,Y,Z)’ in
     meters

   - ‘enu(OriginCoordinate)’ local tangent-plane coordinates represented
     as ‘enu(East,North,Up)’ in meters

   - ‘lambert_azimuthal_equal_area(OriginCoordinate)’ equal-area
     projected coordinates represented as ‘projected(X,Y)’ in meters

   - ‘utm(Zone,Hemisphere)’ projected coordinates represented as
     ‘grid(Easting,Northing)’ in meters

EPSG helpers are available for these reference systems:

   - ‘4326’ for ‘wgs84’

   - ‘4979’ for ‘wgs84_3d’

   - ‘3857’ for ‘web_mercator’

   - ‘3395’ for ‘world_mercator’

   - ‘4978’ for ‘ecef’

   - ‘32601’-‘32660’ for northern-hemisphere UTM zones

   - ‘32701’-‘32760’ for southern-hemisphere UTM zones

Additional metadata helpers are provided for querying CRS names, kinds,
coordinate units, and dimensions.

Additional projection helpers are provided for working directly with
local ENU tangent-plane coordinates and Lambert azimuthal equal-area
coordinates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<25>,  Next: Notes,  Prev: Supported coordinate reference systems,  Up: crs_projections

6.41.5 Usage
------------

Load the library:

     | ?- logtalk_load(crs_projections(loader)).

Validate CRS terms and look up EPSG codes:

     | ?- crs_projections::valid_crs(utm(29, north)).
     | ?- crs_projections::crs_name(wgs84_3d, Name).
     | ?- crs_projections::crs_name(ecef, Name).
     | ?- crs_projections::crs_kind(world_mercator, Kind).
     | ?- crs_projections::crs_units(wgs84, Units).
     | ?- crs_projections::crs_units(wgs84_3d, Units).
     | ?- crs_projections::crs_dimensions(ecef, Dimensions).
     | ?- crs_projections::crs_dimensions(wgs84_3d, Dimensions).
     | ?- crs_projections::crs_epsg(web_mercator, EPSG).
     | ?- crs_projections::crs_epsg(wgs84_3d, EPSG).
     | ?- crs_projections::epsg_crs(32629, CRS).
     | ?- crs_projections::epsg_crs(4979, CRS).
     | ?- crs_projections::valid_crs(enu(geographic(38.7223, -9.1393))).
     | ?- crs_projections::valid_crs(lambert_azimuthal_equal_area(geographic(38.7223, -9.1393))).

Infer the native UTM CRS for a WGS84 coordinate:

     | ?- crs_projections::utm_zone(geographic(38.7223, -9.1393), Zone).
     | ?- crs_projections::utm_crs(geographic(38.7223, -9.1393), CRS).

Transform WGS84 coordinates to projected systems and back:

     | ?- crs_projections::transform(wgs84, web_mercator, geographic(38.7223, -9.1393), Projected).
     | ?- crs_projections::transform(wgs84, wgs84_3d, geographic(38.7223, -9.1393), Geodetic3D).
     | ?- crs_projections::transform(wgs84_3d, ecef, geographic(38.7223, -9.1393, 123.45), Geocentric3D).
     | ?- crs_projections::transform(ecef, wgs84_3d, Geocentric3D, Geodetic3D).
     | ?- crs_projections::transform(web_mercator, wgs84, Projected, Coordinate).
     | ?- crs_projections::transform(wgs84, world_mercator, geographic(38.7223, -9.1393), Mercator).
     | ?- crs_projections::transform(wgs84, ecef, geographic(38.7223, -9.1393), Geocentric).
     | ?- crs_projections::transform(wgs84_3d, enu(geographic(38.7223, -9.1393, 100.0)), geographic(38.7223, -9.1393, 125.0), Local3D).
     | ?- crs_projections::transform(enu(geographic(38.7223, -9.1393, 100.0)), wgs84_3d, Local3D, Geodetic3D).
     | ?- crs_projections::transform(wgs84, enu(geographic(38.7223, -9.1393)), geographic(38.7233, -9.1383), Local).
     | ?- crs_projections::transform(wgs84, lambert_azimuthal_equal_area(geographic(38.7223, -9.1393)), geographic(38.7233, -9.1383), EqualArea).
     | ?- crs_projections::transform(wgs84, utm(29, north), geographic(38.7223, -9.1393), UTM).
     | ?- crs_projections::transform(utm(29, north), wgs84, UTM, Coordinate).

Use direct helper predicates for local tangent-plane and equal-area
workflows:

     | ?- crs_projections::local_tangent_plane(geographic(38.7223, -9.1393), geographic(38.7233, -9.1383), Local).
     | ?- crs_projections::local_tangent_plane_inverse(geographic(38.7223, -9.1393), Local, Coordinate).
     | ?- crs_projections::lambert_azimuthal_equal_area(geographic(38.7223, -9.1393), geographic(38.7233, -9.1383), EqualArea).
     | ?- crs_projections::lambert_azimuthal_equal_area_inverse(geographic(38.7223, -9.1393), EqualArea, Coordinate).


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes,  Prev: Usage<25>,  Up: crs_projections

6.41.6 Notes
------------

The ‘utm_zone/2’, ‘utm_crs/2’, and UTM transformation predicates only
succeed for latitudes in the ‘[-80.0,84.0[’ range, matching the standard
UTM coverage.

Transformations between projected coordinate reference systems are
implemented by converting through ‘wgs84’.

When converting from ‘wgs84’ to ‘wgs84_3d’, the ellipsoidal height
defaults to ‘0.0’.  When converting from 2D projected or geographic
coordinate reference systems to ‘wgs84_3d’, the resulting ellipsoidal
height is also ‘0.0’ because the source coordinate reference system does
not carry height information.

Transforms between ‘ecef’ and projected coordinate reference systems are
also implemented through ‘wgs84’.

Transforms involving ‘enu(OriginCoordinate)’ preserve the local ‘Up’
component when converting directly to or from ‘ecef’ and ‘wgs84_3d’.


File: TheLogtalkHandbook-3.100.1.info,  Node: csv,  Next: cuid2,  Prev: crs_projections,  Up: Libraries

6.42 ‘csv’
==========

The ‘csv’ library provides predicates for reading and writing CSV files
and streams:

‘https://www.rfc-editor.org/rfc/rfc4180.txt’

The main object, ‘csv/4’, is a parametric object allowing passing
options for the handling of the header of the file, the fields
separator, the handling of double-quoted fields, and comments handling.
When comments handling is ‘true’, lines starting with the ‘#’ character
are skipped when reading files and streams.

The ‘csv/3’ parametric object is kept for backward compatibility and
extends ‘csv/4’ by setting the comments option to ‘false’.  The ‘csv’
object extends the ‘csv/4’ parametric object using default option
values.

The library also includes predicates to guess the separator and guess
the number of columns in a given CSV file.

Files and streams can be read into a list of rows (with each row being
represented by a list of fields) or asserted using a user-defined
dynamic predicate.  Reading can be done by first loading the whole file
(using the ‘read_file/2-3’ predicates) into memory or line by line
(using the ‘read_file_by_line/2-3’ predicates).  Reading line by line is
usually the best option for parsing large CSV files.

Data can be saved to a CSV file or stream by providing the object and
predicate for accessing the data plus the name of the destination file
or the stream handle or alias.

* Menu:

* API documentation: API documentation<61>.
* Loading: Loading<62>.
* Testing: Testing<57>.
* Usage: Usage<26>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<61>,  Next: Loading<62>,  Up: csv

6.42.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#csv’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<62>,  Next: Testing<57>,  Prev: API documentation<61>,  Up: csv

6.42.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(csv(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<57>,  Next: Usage<26>,  Prev: Loading<62>,  Up: csv

6.42.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(csv(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<26>,  Prev: Testing<57>,  Up: csv

6.42.4 Usage
------------

The ‘csv(Header, Separator, IgnoreQuotes, Comments)’ parametric object
allows passing the following options:

  1. ‘Header’: possible values are ‘missing’, ‘skip’, and ‘keep’.

  2. ‘Separator’: possible values are ‘comma’, ‘tab’, ‘semicolon’, and
     ‘colon’.

  3. ‘IgnoreQuotes’: possible values are ‘true’ to ignore double quotes
     surrounding field data and ‘false’ to preserve the double quotes.

  4. ‘Comments’: possible values are ‘false’ (default) and ‘true’ to
     skip lines starting with ‘#’.

The ‘csv’ object uses the default values ‘keep’, ‘comma’, ‘false’, and
‘false’.

When writing CSV files or streams, set the quoted fields option to
‘false’ to write all non-numeric fields double-quoted (i.e., escaped).

The library objects can also be used to guess the separator used in a
CSV file if necessary.  For example:

     | ?- csv::guess_separator('test_files/crlf_ending.csv', Separator).
     Is this the proper reading of a line of this file (y/n)? [aaa,bb,ccc]
     |> y.

     Separator = comma ?

This information can then be used to read the CSV file returning a list
of rows:

     | ?- csv(keep, comma, true)::read_file('test_files/crlf_ending.csv', Rows).

     Rows = [[aaa,bbb,ccc],[zzz,yyy,xxx]] ?

     | ?- csv(keep, comma, true, true)::read_file('test_files/comments.csv', Rows).

     Rows = [[aaa,bbb,ccc],[zzz,yyy,xxx]] ?

Alternatively, the CSV data can be saved using a public and dynamic
object predicate (that must be previously declared).  For example:

     | ?- assertz(p(_,_,_)), retractall(p(_,_,_)).
     yes

     | ?- csv(keep, comma, true)::read_file('test_files/crlf_ending.csv', user, p/3).
     yes

     | ?-  p(A,B,C).

     A = aaa
     B = bbb
     C = ccc ? ;

     A = zzz
     B = yyy
     C = xxx

Given a predicate representing a table, the predicate data can be
written to a file or stream.  For example:

     | ?- csv(keep, comma, true)::write_file('output.csv', user, p/3).
     yes

leaving the content just as the original file thanks to the use of
‘true’ for the ‘IgnoreQuotes’ option:

     aaa,bbb,ccc
     zzz,yyy,xxx

Otherwise:

     | ?- csv(keep, comma, false)::write_file('output.csv', user, p/3).
     yes

results in the following file content:

     "aaa","bbb","ccc"
     "zzz","yyy","xxx"

The ‘guess_arity/2’ method, to identify the arity, i.  e.  the number of
fields or columns per record in a given CSV file, for example:

     | ?- csv(keep, comma, false)::guess_arity('test_files/crlf_ending.csv', Arity).
     Is this the proper reading of a line of this file (y/n)? [aaa,bbb,ccc]
     |> y.

     Arity = 3


File: TheLogtalkHandbook-3.100.1.info,  Node: cuid2,  Next: cusum_anomaly_detector,  Prev: csv,  Up: Libraries

6.43 ‘cuid2’
============

This library generates random Cuid2 identifiers:

‘https://github.com/paralleldrive/cuid2’

By default, identifiers are represented as atoms with 24 symbols and use
a lowercase alphanumeric alphabet:

     abcdefghijklmnopqrstuvwxyz0123456789

Custom size, alphabet, and representation (atoms, lists of characters,
or lists of character codes) are supported using a parametric object.

The generation of random identifiers uses the ‘/dev/urandom’ random
number generator when available.  This includes macOS, Linux, *BSD, and
other POSIX operating systems.  On Windows, a pseudo-random generator is
used, randomized using the current wall time.

See also the ‘ids’, ‘nanoid’, ‘ksuid’, ‘snowflakeid’, ‘uuid’, and ‘ulid’
libraries.

* Menu:

* API documentation: API documentation<62>.
* Loading: Loading<63>.
* Testing: Testing<58>.
* Usage: Usage<27>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<62>,  Next: Loading<63>,  Up: cuid2

6.43.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#cuid2’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<63>,  Next: Testing<58>,  Prev: API documentation<62>,  Up: cuid2

6.43.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(cuid2(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<58>,  Next: Usage<27>,  Prev: Loading<63>,  Up: cuid2

6.43.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(cuid2(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<27>,  Prev: Testing<58>,  Up: cuid2

6.43.4 Usage
------------

To generate an identifier using the default configuration:

     | ?- cuid2::generate(Cuid2).
     Cuid2 = 'k4f9mdd51t2r9y53i8h4j1bz'
     yes

To generate a 10-symbol identifier represented as a list of characters:

     | ?- cuid2(chars, 10, 'abcdef012345')::generate(Cuid2).
     Cuid2 = ['a','2','f','e','5','c','1','d','0','b']
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: cusum_anomaly_detector,  Next: datalog,  Prev: cuid2,  Up: Libraries

6.44 ‘cusum_anomaly_detector’
=============================

CUSUM (Cumulative Sum Control Chart) anomaly detector for continuous
sequence-like datasets.  This is a statistical anomaly-detection method
based on a two-sided CUSUM control chart.  Declared continuous
attributes are interpreted as ordered monitoring steps.

The library implements the ‘anomaly_detector_protocol’ defined in the
‘anomaly_detection_protocols’ library.  It learns a detector from a
continuous dataset, computes anomaly scores for new instances, predicts
‘normal’ or ‘anomaly’, and exports learned detectors as clauses or
files.

Datasets are represented as objects implementing the
‘anomaly_dataset_protocol’ protocol from the
‘anomaly_detection_protocols’ library.  Declared continuous attributes
are interpreted as ordered monitoring steps in a sequence.  See the
‘cusum_anomaly_detector/tests.lgt’ file for example datasets.

* Menu:

* API documentation: API documentation<63>.
* Loading: Loading<64>.
* Testing: Testing<59>.
* Features: Features<12>.
* Options: Options<11>.
* Detector representation::
* Notes: Notes<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<63>,  Next: Loading<64>,  Up: cusum_anomaly_detector

6.44.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#cusum_anomaly_detector’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<64>,  Next: Testing<59>,  Prev: API documentation<63>,  Up: cusum_anomaly_detector

6.44.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(cusum_anomaly_detector(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<59>,  Next: Features<12>,  Prev: Loading<64>,  Up: cusum_anomaly_detector

6.44.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(cusum_anomaly_detector(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<12>,  Next: Options<11>,  Prev: Testing<59>,  Up: cusum_anomaly_detector

6.44.4 Features
---------------

   - 'Statistical method': implements anomaly detection based on a
     two-sided CUSUM control chart, using learned per-step population
     means and standard deviations for continuous attributes.

   - 'Ordered sequence interpretation': declared continuous attributes
     are treated as ordered monitoring steps.  For each known step value
     ‘x_t’, the library computes ‘z_t = (x_t - mu_t) / sigma_t’ and
     updates the positive and negative CUSUM recurrences along that
     attribute order.  The learned detector stores a precomputed
     attribute schema so that this ordering does not need to be rebuilt
     for every scoring call.

   - 'CUSUM recurrences': the positive and negative cumulative sums are
     updated as ‘C+_t = max(0, C+_(t-1) + z_t - k)’ and ‘C-_t = max(0,
     C-_(t-1) - z_t - k)’, where ‘k’ is the learn-time allowance.  The
     raw anomaly score is the maximum excursion over all positive and
     negative cumulative sums.

   - 'Continuous features only': accepts datasets whose declared
     attributes are all ‘continuous’.

   - 'Baseline training selection': supports learn-time
     ‘baseline_class_values(ClassValues)’ and
     ‘baseline_selection_policy(Policy)’ options.  The default baseline
     class values are ‘[normal]’.  The default ‘reject’ policy throws an
     error if any non-baseline training example is found.  The ‘filter’
     policy removes non-baseline examples before fitting the baseline
     statistics.

   - 'Missing-value tolerant': ignores missing values when fitting
     per-step statistics and skips them during scoring.  Queries must
     still provide at least one known value.

   - 'Bounded scoring': maps the raw CUSUM excursion to ‘[0.0, 1.0)’
     using ‘Score = Raw / (1 + Raw)’.

   - 'CUSUM control parameters': supports learn-time ‘allowance/1’ and
     ‘decision_interval/1’ options.  The default ‘allowance(0.5)’ and
     ‘decision_interval(5.0)’ correspond to a common standardized CUSUM
     setup.

   - 'Default threshold': the default
     ‘anomaly_threshold(0.8333333333333334)’ corresponds to the default
     raw decision interval ‘5.0’.  If a custom ‘decision_interval/1’ is
     passed to ‘learn/3’ without an explicit ‘anomaly_threshold/1’, the
     stored anomaly threshold is derived automatically as ‘H / (1 + H)’.

   - 'Learn-time control parameters': ‘allowance/1’ and
     ‘decision_interval/1’ are recorded in the learned detector and
     reused for subsequent scoring and prediction.  Passing them to
     ‘predict/4’ does not override the learned values.  Only
     ‘anomaly_threshold/1’ can be overridden at predict time.

   - 'All-missing queries rejected': scoring and prediction throw a
     ‘domain_error(non_empty_known_values, AttributeNames)’ exception
     when every declared step is missing in the query.

   - 'Featureless datasets rejected': datasets must declare at least one
     continuous feature; otherwise ‘learn/2-3’ throws a
     ‘domain_error(non_empty_features, Dataset)’ exception.

   - 'Detector export': learned detectors can be exported as predicate
     clauses.

   - 'Explicit validation and diagnostics': supports the shared
     ‘check_anomaly_detector/1’, ‘valid_anomaly_detector/1’,
     ‘diagnostics/2’, ‘diagnostic/2’, and ‘anomaly_detector_options/2’
     predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<11>,  Next: Detector representation,  Prev: Features<12>,  Up: cusum_anomaly_detector

6.44.5 Options
--------------

The following options are supported by the public API:

   - ‘anomaly_threshold(Threshold)’: Threshold for ‘predict/3-4’
     (default: ‘0.8333333333333334’)

   - ‘allowance(Allowance)’: Learn-time CUSUM allowance ‘k’ (default:
     ‘0.5’)

   - ‘baseline_class_values(ClassValues)’: Learn-time class labels that
     are admissible for baseline fitting (default: ‘[normal]’)

   - ‘baseline_selection_policy(Policy)’: Learn-time handling of
     examples whose class is not listed in ‘baseline_class_values/1’.
     Supported values are ‘reject’ and ‘filter’ (default: ‘reject’)

   - ‘decision_interval(DecisionInterval)’: Learn-time raw decision
     interval ‘H’ (default: ‘5.0’).  If no explicit
     ‘anomaly_threshold/1’ is passed to ‘learn/3’, the stored threshold
     is derived from this value as ‘H / (1 + H)’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Detector representation,  Next: Notes<2>,  Prev: Options<11>,  Up: cusum_anomaly_detector

6.44.6 Detector representation
------------------------------

The learned detector is represented by default as:

     cusum_detector(TrainingDataset, AttributeSchema, Encoders, Diagnostics)

Where:

   - ‘TrainingDataset’: training dataset object identifier

   - ‘AttributeSchema’: precomputed attribute ordering metadata used to
     validate and reorder query step values efficiently during scoring

   - ‘Encoders’: list of ‘cusum_encoder(Attribute, Mean, Scale)’ records

   - ‘Diagnostics’: learned metadata terms including ‘model/1’,
     ‘training_dataset/1’, ‘attribute_names/1’, ‘feature_count/1’,
     ‘example_count/1’, and ‘options/1’.  The ‘example_count/1’ value is
     the effective number of training examples after applying the
     selected baseline selection policy.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
detector term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<2>,  Prev: Detector representation,  Up: cusum_anomaly_detector

6.44.7 Notes
------------

Scoring has three stages.  First, the detector computes one standardized
deviation ‘z_t = (x_t - mu_t) / sigma_t’ for each known monitoring step.
Second, those deviations are processed sequentially using the positive
and negative CUSUM recurrences with the learned ‘allowance/1’ value.
Third, the maximum raw excursion is mapped to the interval ‘[0.0, 1.0)’
using ‘Score = Raw / (1 + Raw)’.

The ‘allowance/1’ option changes the CUSUM update rule itself by
controlling how much drift must accumulate before the chart grows.
Larger values make the detector less sensitive to small shifts.  The
‘decision_interval/1’ option does not change scoring; it only affects
the default threshold stored when learning a detector.

The ‘baseline_class_values/1’ option declares which dataset class labels
are admissible for baseline fitting.  The ‘baseline_selection_policy/1’
option then controls what happens when other labels are present in the
training data.  The default ‘reject’ policy raises a
‘domain_error(baseline_only_training_data, Dataset)’ exception when any
non-baseline example is found.  The ‘filter’ policy removes non-baseline
examples before fitting and raises a
‘domain_error(non_empty_baseline_training_data, Dataset)’ exception if
no training examples remain after filtering.

Attributes with zero observed dispersion are assigned a fallback scale
of ‘1.0’.  This keeps the detector well-defined for singleton datasets
or constant steps while still yielding zero score for matching values
and positive scores for deviating values.


File: TheLogtalkHandbook-3.100.1.info,  Node: datalog,  Next: dates,  Prev: cusum_anomaly_detector,  Up: Libraries

6.45 ‘datalog’
==============

This library provides a portable Datalog and incremental rule engine for
educational purposes and non-demanding applications.  This library is
work-in-progress and changes, possibly breaking backwards compatibility,
are to be expected.

* Menu:

* API documentation: API documentation<64>.
* Loading: Loading<65>.
* Testing: Testing<60>.
* Scope: Scope<3>.
* Public API overview::
* Basic usage::
* Limitations: Limitations<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<64>,  Next: Loading<65>,  Up: datalog

6.45.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#datalog’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<65>,  Next: Testing<60>,  Prev: API documentation<64>,  Up: datalog

6.45.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(datalog(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<60>,  Next: Scope<3>,  Prev: Loading<65>,  Up: datalog

6.45.3 Testing
--------------

To run the library unit tests, load the ‘tester.lgt’ file:

     | ?- logtalk_load(datalog(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Scope<3>,  Next: Public API overview,  Prev: Testing<60>,  Up: datalog

6.45.4 Scope
------------

   - positive and stratified negation rules (‘neg/1’ body literals)

   - conservative aggregates (‘agg(Op, Template, Goals, Result)’) with
     lower-strata dependencies (‘Op’ in ‘count’, ‘sum’, ‘min’, ‘max’)

   - safe rules (‘Head’ and negated literal variables must appear in
     positive ‘Body’ literals)

   - fixpoint materialization

   - incremental updates using support-count based propagation

   - simple explanations for derived facts

   - rule management (‘add_rule/3’, ‘remove_rule/1’)

   - transaction support (‘begin/0’, ‘commit/0’, ‘rollback/0’)

   - stratum introspection (‘predicate_stratum/3’, ‘strata/1’)

   - rule body normalization (positive ground literals first, then
     positive non-ground, then aggregates, then negation)


File: TheLogtalkHandbook-3.100.1.info,  Node: Public API overview,  Next: Basic usage,  Prev: Scope<3>,  Up: datalog

6.45.5 Public API overview
--------------------------

   - lifecycle: ‘clear/0’, ‘load_program/1’, ‘materialize/0’

   - rule management: ‘add_rule/3’, ‘remove_rule/1’, ‘rules/1’

   - fact management: ‘assert_fact/1’, ‘retract_fact/1’, ‘facts/1’

   - querying and explanations: ‘query/1’, ‘query/2’, ‘explain/2’

   - updates: ‘update/3’

   - transactions: ‘begin/0’, ‘commit/0’, ‘rollback/0’

   - stratification introspection: ‘predicate_stratum/3’, ‘strata/1’

Rules and facts are represented as terms:

   - ‘rule(Id, Head, Body)’ where ‘Body’ is a list of ‘Literal’ terms:

        - positive literal: ‘Term’

        - negative literal: ‘neg(Term)’

        - aggregate literal: ‘agg(Op, Template, Goals, Result)’ where
          ‘Op’ is one of ‘count’, ‘sum’, ‘min’, ‘max’

   - ‘fact(Fact)’ for extensional database (EDB) facts

Aggregate notes:

   - Aggregate dependencies are required to be in lower strata.

   - ‘min’ and ‘max’ require at least one matching value; otherwise no
     fact is derived.

   - Incremental updates involving negation or aggregates currently
     fallback to full rematerialization for correctness.


File: TheLogtalkHandbook-3.100.1.info,  Node: Basic usage,  Next: Limitations<3>,  Prev: Public API overview,  Up: datalog

6.45.6 Basic usage
------------------

     | ?- logtalk_load(datalog(loader)).
     ...

     | ?- Program = [
             rule(path_base, path(X,Y), [edge(X,Y)]),
             rule(path_rec, path(X,Z), [edge(X,Y), path(Y,Z)]),
             fact(edge(a,b)),
             fact(edge(b,c))
         ],
         datalog::load_program(Program),
         datalog::query(path(a,c)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Limitations<3>,  Prev: Basic usage,  Up: datalog

6.45.7 Limitations
------------------

This first version intentionally keeps the implementation simple and
portable.  Negation support is currently limited to stratified programs.
Aggregates and cost-based optimization are planned future enhancements.
Aggregate support is currently limited to ‘count’, ‘sum’, ‘min’, and
‘max’.


File: TheLogtalkHandbook-3.100.1.info,  Node: dates,  Next: dates_tz,  Prev: datalog,  Up: Libraries

6.46 ‘dates’
============

The ‘date’ object implements some useful calendar date predicates.

It also provides portable predicates for date-time handling, including:

   - Unix epoch conversions (‘date_time_to_unix/2’,
     ‘unix_to_date_time/2’)

   - date-time arithmetic with durations (‘add_duration/3’,
     ‘subtract_duration/3’, ‘duration_between/3’)

   - UTC/local conversion using explicit offsets (‘utc_to_local/3’,
     ‘local_to_utc/3’)

   - date-time formatting with explicit offsets (‘format_date_time/4’)

   - calendar utilities (‘day_of_year/2’, ‘week_of_year_iso/2’,
     ‘weekday/2’)

   - reverse and positional calendar utilities (‘day_of_year_date/3’,
     ‘month_weekday_date/5’)

   - date-time normalization and validation (‘normalize_date_time/2’,
     ‘valid_date_time/1’)

   - date-time comparison (‘before/2’, ‘after/2’, ‘same_instant/2’,
     ‘compare_date_time/3’)

The duration predicates accept two duration representations:

   - ‘duration(Days, Hours, Minutes, Seconds)’ — a fixed-length duration
     converted to seconds

   - ‘duration(Years, Months, Days, Hours, Minutes, Seconds)’ — a
     calendar-aware period where the year and month delta is applied
     first using calendar arithmetic, clamping the day to the last valid
     day of the resulting month when necessary (e.g.  adding one month
     to January 31 gives February 28 or 29 depending on the year), with
     the remaining day and time delta applied via fixed-length
     arithmetic.  The ‘duration_between/3’ predicate returns this form
     when called with a 6-arity skeleton such as ‘duration(Yr, Mo, Da,
     Hr, Mi, Se)’.

Date-time values are represented using the ‘date_time/6’ compound term:

   - ‘date_time(Year, Month, Day, Hours, Minutes, Seconds)’

The ‘format_date_time/4’ predicate currently supports the named formats
‘rfc3339’, ‘iso8601’, ‘atom’, ‘rfc2822’, ‘rfc5322’, ‘rss’, ‘http_date’,
‘rfc1123’, ‘unix_date’, ‘common_log’, ‘date_short’, ‘date_medium’,
‘date_long’, ‘date_full’, ‘time_short’, ‘time_medium’, ‘time_long’,
‘time_full’, ‘date_time_short’, ‘date_time_medium’, ‘date_time_long’,
and ‘date_time_full’.

The explicit offset argument is given in seconds.  Formats that include
numeric offsets require offsets representable in whole minutes.  The
‘http_date’ and ‘rfc1123’ formats always normalize the output to ‘GMT’.

The style presets are currently English-only presentation formats:

   - ‘date_short’ -> ‘2026-04-08’

   - ‘date_medium’ -> ‘8 Apr 2026’

   - ‘date_long’ -> ‘April 8, 2026’

   - ‘date_full’ -> ‘Tuesday, April 8, 2026’

   - ‘time_short’ -> ‘13:45’

   - ‘time_medium’ -> ‘13:45:30’

   - ‘time_long’ -> ‘13:45:30 +01:00’

   - ‘time_full’ -> ‘1:45:30 PM +01:00’

   - ‘date_time_short’ -> ‘2026-04-08 13:45’

   - ‘date_time_medium’ -> ‘8 Apr 2026 13:45:30’

   - ‘date_time_long’ -> ‘April 8, 2026 1:45:30 PM +01:00’

   - ‘date_time_full’ -> ‘Tuesday, April 8, 2026 1:45:30 PM +01:00’

The ‘time’ object implements some useful time predicates.

Please note that the functionality of these objects depends on the
chosen Prolog support for accessing the operating system time and date.

* Menu:

* API documentation: API documentation<65>.
* Loading: Loading<66>.
* Testing: Testing<61>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<65>,  Next: Loading<66>,  Up: dates

6.46.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#dates’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<66>,  Next: Testing<61>,  Prev: API documentation<65>,  Up: dates

6.46.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(dates(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<61>,  Prev: Loading<66>,  Up: dates

6.46.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(dates(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: dates_tz,  Next: dbscan_clusterer,  Prev: dates,  Up: Libraries

6.47 ‘dates_tz’
===============

Bridge library linking the ‘dates’ and ‘tzif’ libraries for zone-aware
date-time conversions.  Provides predicates that convert UTC date-times
to civil local date-times and vice-versa, handling DST transitions
including ambiguous (fold) and non-existent (gap) times.  Also provides
cross-zone conversion that routes through UTC as an intermediate
representation.

This library requires unbounded integer arithmetic support from the
backend Prolog compiler (as does the ‘tzif’ library it depends on).  It
is not available on backends where the ‘bounded’ Prolog flag is ‘true’.

* Menu:

* API documentation: API documentation<66>.
* Loading: Loading<67>.
* Testing: Testing<62>.
* Usage: Usage<28>.
* Examples: Examples<167>.
* Notes: Notes<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<66>,  Next: Loading<67>,  Up: dates_tz

6.47.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#dates_tz’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<67>,  Next: Testing<62>,  Prev: API documentation<66>,  Up: dates_tz

6.47.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(dates_tz(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<62>,  Next: Usage<28>,  Prev: Loading<67>,  Up: dates_tz

6.47.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(dates_tz(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<28>,  Next: Examples<167>,  Prev: Testing<62>,  Up: dates_tz

6.47.4 Usage
------------

Zone data must be loaded separately into the ‘tzif’ cache before calling
any ‘dates_tz’ predicates.  For example:

     :- initialization((
         logtalk_load(dates_tz(loader)),
         tzif::load(file('/usr/share/zoneinfo/America/New_York', 'America/New_York')),
         tzif::load(directory('/usr/share/zoneinfo'))
     )).


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<167>,  Next: Notes<3>,  Prev: Usage<28>,  Up: dates_tz

6.47.5 Examples
---------------

Convert a UTC ‘date_time/6’ compound to the civil local date-time in the
named IANA zone.  The UTC instant always has exactly one local
representation.

     |?- dates_tz::utc_to_local_tz(date_time(2024,1,15,12,0,0), 'America/New_York', Local).
     Local = date_time(2024,1,15,7,0,0).

Convert a civil local ‘date_time/6’ compound in the named zone to UTC
using strict interpretation.  Fails silently if the local time falls in
a DST gap (non-existent) or a DST fold (ambiguous).  Throws an error if
the zone is not cached.

     | ?- dates_tz::local_to_utc_tz(date_time(2024,1,15,7,0,0), 'America/New_York', UTC).
     UTC = date_time(2024,1,15,12,0,0).

Convert a civil local date-time to UTC with an explicit resolution mode.
The mode can be:

   - ‘strict’ — fail unless exactly one interpretation exists

   - ‘first’ — prefer the earliest valid interpretation (earliest UTC
     instant)

   - ‘second’ — prefer the latest valid interpretation (latest UTC
     instant)

   - ‘all’ — enumerate all valid interpretations in chronological order
     (non-deterministic)

Fall-back fold in New York: 2024-11-03 01:30 occurs twice:

     | ?- dates_tz::local_to_utc_tz_with_resolution(
          date_time(2024,11,3,1,30,0), 'America/New_York', first, UTC).
     UTC = date_time(2024,11,3,5,30,0).  % EDT interpretation

     | ?- dates_tz::local_to_utc_tz_with_resolution(
          date_time(2024,11,3,1,30,0), 'America/New_York', second, UTC).
     UTC = date_time(2024,11,3,6,30,0).  % EST interpretation

Convert a civil local date-time from one IANA zone to another, routing
through UTC. Uses strict interpretation for the source zone: fails if
the source local time is ambiguous or non-existent.  Requires both zones
to be cached.

     | ?- dates_tz::convert_zones(
          date_time(2024,1,15,7,0,0), 'America/New_York', 'Asia/Kathmandu', Result).
     Result = date_time(2024,1,15,17,45,0).

Convert a civil local date-time between zones with an explicit
resolution mode applied to the source zone.  Useful when the source
local time may be ambiguous due to a DST transition.

     | ?- dates_tz::convert_zones_with_resolution(
          date_time(2024,11,3,1,30,0), 'America/New_York', first, 'Asia/Kathmandu', Result).
     Result = date_time(2024,11,3,11,15,0).


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<3>,  Prev: Examples<167>,  Up: dates_tz

6.47.6 Notes
------------

   - Date-time values are represented as ‘date_time(Year, Month, Day,
     Hour, Minute, Second)’ compounds, consistent with the ‘dates’
     library.

   - UTC offset arithmetic is performed via integer seconds using
     ‘date::add_duration/3’ and ‘date::subtract_duration/3’.

   - This library does not provide a system clock or current-time
     predicate.  Use the ‘dates’ library’s ‘date::now/6’ or equivalent
     for the current time.

   - For performance when converting many instants in the same zone,
     load all required zones once at startup and keep them in the ‘tzif’
     cache.


File: TheLogtalkHandbook-3.100.1.info,  Node: dbscan_clusterer,  Next: dependents,  Prev: dates_tz,  Up: Libraries

6.48 ‘dbscan_clusterer’
=======================

DBSCAN clusterer.  Uses deterministic density-based clustering based on
epsilon neighborhoods and minimum point counts.  Supports continuous
attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<67>.
* Loading: Loading<68>.
* Testing: Testing<63>.
* Features: Features<13>.
* Options: Options<12>.
* Clusterer representation: Clusterer representation<2>.
* References: References<9>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<67>,  Next: Loading<68>,  Up: dbscan_clusterer

6.48.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#dbscan_clusterer’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<68>,  Next: Testing<63>,  Prev: API documentation<67>,  Up: dbscan_clusterer

6.48.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(dbscan_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<63>,  Next: Features<13>,  Prev: Loading<68>,  Up: dbscan_clusterer

6.48.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(dbscan_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(dbscan_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<13>,  Next: Options<12>,  Prev: Testing<63>,  Up: dbscan_clusterer

6.48.4 Features
---------------

   - 'Density-Based Clustering': Learns density-connected clusters using
     epsilon neighborhoods and minimum point counts.

   - 'Adaptive Neighborhood Indexing': Builds a low-dimensional
     epsilon-grid index when it is likely to be cheaper and otherwise
     falls back to a deterministic metric tree.  The metric-tree path
     uses adaptive leaf sizing, balanced tie-aware subtree splits,
     selectable exact or heuristic pivot scoring, and lower-allocation
     range-query traversal.

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Distance Metrics': Supports ‘euclidean’ and ‘manhattan’ distances.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Reachable-Core Prediction': New instances are assigned to the
     cluster of the nearest reachable core point within the learned
     epsilon radius; otherwise the atom ‘noise’ is returned.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<12>,  Next: Clusterer representation<2>,  Prev: Features<13>,  Up: dbscan_clusterer

6.48.5 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘epsilon(Epsilon)’: Neighborhood radius used to determine density
     connectivity.  Default is ‘1.0’.

   - ‘minimum_points(MinimumPoints)’: Minimum number of points in an
     epsilon neighborhood for a core point.  Default is ‘2’.

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default) or ‘manhattan’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.

   - ‘pivot_scoring(PivotScoring)’: Metric-tree pivot scoring strategy.
     Options: ‘heuristic’ (default, single-pass dispersion scoring with
     one final sort) or ‘exact’ (more expensive gap-and-range scoring
     that sorts each candidate profile).


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<2>,  Next: References<9>,  Prev: Options<12>,  Up: dbscan_clusterer

6.48.6 Clusterer representation
-------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     dbscan_clusterer(Encoders, Clusters, Noise, Options)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Clusters’: List of ‘cluster(Id, CorePoints, BorderPoints)’ terms
     in cluster-id order.

   - ‘Noise’: List of encoded training points classified as noise.

   - ‘Options’: Effective training options used to learn the clusterer.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<9>,  Prev: Clusterer representation<2>,  Up: dbscan_clusterer

6.48.7 References
-----------------

  1. Ester, Kriegel, Sander, and Xu (1996) - “A Density-Based Algorithm
     for Discovering Clusters in Large Spatial Databases with Noise”.
     KDD, 226-231.


File: TheLogtalkHandbook-3.100.1.info,  Node: dependents,  Next: deques,  Prev: dbscan_clusterer,  Up: Libraries

6.49 ‘dependents’
=================

The ‘observer’ and ‘subject’ categories implement the Smalltalk
dependents handling mechanism.  This mechanism can be used as an
alternative to Logtalk system-wide support for event-driven programming.

* Menu:

* API documentation: API documentation<68>.
* Loading: Loading<69>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<68>,  Next: Loading<69>,  Up: dependents

6.49.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#dependents’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<69>,  Prev: API documentation<68>,  Up: dependents

6.49.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(dependents(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: deques,  Next: derangements,  Prev: dependents,  Up: Libraries

6.50 ‘deques’
=============

This library implements double-ended queues, deques.  The queue
representation should be regarded as an opaque term and only accessed
using this library predicates.

* Menu:

* API documentation: API documentation<69>.
* Loading: Loading<70>.
* Testing: Testing<64>.
* Usage: Usage<29>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<69>,  Next: Loading<70>,  Up: deques

6.50.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#deques’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<70>,  Next: Testing<64>,  Prev: API documentation<69>,  Up: deques

6.50.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(deques(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<64>,  Next: Usage<29>,  Prev: Loading<70>,  Up: deques

6.50.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(deques(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<29>,  Prev: Testing<64>,  Up: deques

6.50.4 Usage
------------

To create a new deque, use the ‘new/1’ predicate:

     | ?- deque::new(Deque).
     Deque = ...
     yes

Elements can be added and removed both at the front and at the back of
the deque using the ‘push_front/3’, ‘push_back/3’, ‘pop_front/3’, and
‘pop_back/3’, predicates.  For example:

     | ?- deque::(as_deque([1,2,3], Deque0), push_front(0, Deque0, Deque)).
     Deque0 = ...,
     Deque = ...
     yes

We can also peek at the front and back of the deque using the
‘peek_front/2’ and ‘peek_back/2’ predicates.  For example:

     | ?- deque::(as_deque([1,2,3], Deque), peek_back(Deque, Element)).
     Deque = ...,
     Element = 3
     yes

Mapping a closure over all elements of a deque can be done using the
‘map/2’ and ‘map/3’ predicates.  For example:

     | ?- deque::(as_deque([1,2,3], Deque), map(write, Deque)).
     123
     Deque = ...
     yes

For details on these and other provided predicates, consult the library
API documentation.


File: TheLogtalkHandbook-3.100.1.info,  Node: derangements,  Next: dictionaries,  Prev: deques,  Up: Libraries

6.51 ‘derangements’
===================

This library provides predicates for generating and querying
derangements over lists.  Derangements are full-length permutations
where no result element is identical to the input element at the same
position.  The following categories of predicates are provided:

   - 'Generation operations' - Predicates for generating derangements.

   - 'Ordering variants' - Predicates that support an additional order
     argument (‘default’, ‘lexicographic’, or ‘shortlex’) for
     controlling output order.

   - 'Distinct-value generation' - Predicates for generating
     derangements while deduplicating equal-valued results.

   - 'Indexed access' - Predicates for direct access to derangements at
     specific positions, including distinct derangements.

   - 'Lexicographic stepping' - Predicates for navigating derangements
     in lexicographic order.

   - 'Counting operations' - Predicates for counting derangements and
     distinct derangements.

   - 'Random selection' - Predicates for randomly selecting and sampling
     derangements and distinct derangements.

Dedicated ‘permutations’, ‘arrangements’, ‘cartesian_products’,
‘combinations’, ‘multisets’, ‘partitions’, and ‘subsequences’ libraries
are also available for focused APIs on related operations.

* Menu:

* API documentation: API documentation<70>.
* Loading: Loading<71>.
* Testing: Testing<65>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<70>,  Next: Loading<71>,  Up: derangements

6.51.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#derangements’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<71>,  Next: Testing<65>,  Prev: API documentation<70>,  Up: derangements

6.51.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(derangements(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<65>,  Prev: Loading<71>,  Up: derangements

6.51.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(derangements(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: dictionaries,  Next: dif,  Prev: derangements,  Up: Libraries

6.52 ‘dictionaries’
===================

This library provides a dictionary (also known as associative array,
map, or symbol table) protocol and binary tree, AVL tree, Red–Black
tree, splay tree, ad 2-3 tree implementations.  The different
representations of a dictionary should be regarded as opaque terms and
only accessed using the library predicates.

* Menu:

* API documentation: API documentation<71>.
* Loading: Loading<72>.
* Testing: Testing<66>.
* Usage: Usage<30>.
* Credits: Credits<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<71>,  Next: Loading<72>,  Up: dictionaries

6.52.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#dictionaries’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<72>,  Next: Testing<66>,  Prev: API documentation<71>,  Up: dictionaries

6.52.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(dictionaries(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<66>,  Next: Usage<30>,  Prev: Loading<72>,  Up: dictionaries

6.52.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(dictionaries(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<30>,  Next: Credits<2>,  Prev: Testing<66>,  Up: dictionaries

6.52.4 Usage
------------

First, select the dictionary implementation that you want to use.  For
cases where the number of elements is relatively small and performance
is not critical, ‘bintree’ can be a good choice.  For other cases,
‘avltree’, ‘rbtree’, or ‘two3tree’ are likely better choices.  The
‘splaytree’ implementation can be a good choice when recently accessed
elements are likely to be accessed again, as it moves accessed elements
closer to the root.  If you want to compare the performance of the
implementations, either define an object alias or use a ‘uses/2’
directive so that you can switch between implementations by simply
changing the alias definition or the first argument of the directive.
Note that you can switch between implementations at runtime without code
changes by using a parameter variable in the first argument of a
‘uses/2’ directive.

Dictionary keys should preferably be ground terms.  If the keys contain
variables, the user must ensure that any instantiation of those
variables when calling this library predicates will not affect the key
ordering.

To create a new dictionary, you can use the ‘new/1’ predicate.  For
example:

     | ?- avltree::new(Dictionary).
     Dictionary = ...
     yes

You can also create a new dictionary from a list of key-value pairs by
using the ‘as_dictionary/2’ predicate.  For example:

     | ?- avltree::as_dictionary([a-1,c-3,b-2], Dictionary).
     Dictionary = ...
     yes

Several predicates are provided for inserting key-value pairs, lookup
key-value pairs updating the value associated with a key, and deleting
key-value pairs.  For example:

     | ?- avltree::(
             new(Dictionary0),
             insert(Dictionary0, a, 1, Dictionary1),
             update(Dictionary1, a, 2, Dictionary2),
             lookup(a, Value, Dictionary2)
         ).
     Dictionary0 = ...,
     Dictionary1 = ...,
     Dictionary2 = ...,
     Value = 2
     yes

For details on these and other provided predicates, consult the library
API documentation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Credits<2>,  Prev: Usage<30>,  Up: dictionaries

6.52.5 Credits
--------------

The AVL tree implementation is an adaptation to Logtalk of the ‘assoc’
SWI-Prolog library authored by R.A.O’Keefe, L.Damas, V.S.Costa, Glenn
Burgess, Jiri Spitz, and Jan Wielemaker.  Additional predicates authored
by Paulo Moura.

The Red–Black tree implementation is an adaptation to Logtalk of the
‘rbtrees’ Prolog library authored by Vitor Santos Costa.

The 2-3 tree implementation is a contribution by Michael T. Richter.


File: TheLogtalkHandbook-3.100.1.info,  Node: dif,  Next: dimension_reduction_protocols,  Prev: dictionaries,  Up: Libraries

6.53 ‘dif’
==========

The ‘dif’ object provides a portable abstraction over how the ‘dif/2’
predicate is made available by the supported backend Prolog systems that
implement it (B-Prolog, ECLiPSe, SICStus Prolog, SWI-Prolog, Trealla
Prolog, XSB, XVM, and YAP).

Calls to the library predicates are inlined when compiled with the
‘optimize’ flag turned on.  In this case, there is no overhead compared
with calling the abstracted predicate directly.

See also the ‘coroutining’ library.

* Menu:

* API documentation: API documentation<72>.
* Loading: Loading<73>.
* Testing: Testing<67>.
* Usage: Usage<31>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<72>,  Next: Loading<73>,  Up: dif

6.53.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#dif’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<73>,  Next: Testing<67>,  Prev: API documentation<72>,  Up: dif

6.53.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(dif(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<67>,  Next: Usage<31>,  Prev: Loading<73>,  Up: dif

6.53.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(dif(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<31>,  Prev: Testing<67>,  Up: dif

6.53.4 Usage
------------

Load this library from your application loader file.  To call the
‘dif/1-2’ predicates using implicit message-sending, add the following
directive to any object or category calling the predicates:

     :- uses(dif, [
         dif/2, dif/1
     ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: dimension_reduction_protocols,  Next: eclat_pattern_miner,  Prev: dif,  Up: Libraries

6.54 ‘dimension_reduction_protocols’
====================================

This library provides protocols and reusable support predicates used in
the implementation of machine learning dimension reduction algorithms.
Unsupervised datasets are represented as objects implementing the
‘dimension_reduction_dataset_protocol’ protocol.  Labeled datasets for
supervised reducers such as Linear Discriminant Analysis are represented
as objects implementing the
‘supervised_dimension_reduction_dataset_protocol’ protocol.
Target-valued datasets for reducers such as partial least squares
projections are represented as objects implementing the
‘target_supervised_dimension_reduction_dataset_protocol’ protocol.
Dimension reducers are represented as objects importing the
‘dimension_reducer_common’ category.

This library also provides reusable test datasets and a small smoke-test
suite.

Concrete dimension reduction algorithms are intentionally out of scope
for this package.  The goal is to provide a portable foundation for
libraries such as ‘pca_projection’, ‘truncated_svd_projection’,
‘random_projection’, ‘nmf_projection’, ‘lda_projection’, and
‘pls_projection’, including shared reducer helpers for common tasks such
as feature encoding, projection, reducer validation, diagnostics,
export, and pretty-printing.

Exported reducers are serialized protocol-wide as single-argument
predicates such as ‘reducer(Reducer)’, allowing the saved reducer term
to be loaded and passed directly to ‘transform/3’.

All reducers importing the shared category are also expected to record a
diagnostics list containing at least ‘model/1’ and ‘options/1’ terms.
The shared protocol surface exposes this metadata using the
‘diagnostics/2’, ‘diagnostic/2’, and ‘dimension_reducer_options/2’
predicates and validates serialized reducers using
‘check_dimension_reducer/1’.

* Menu:

* API documentation: API documentation<73>.
* Loading: Loading<74>.
* Common options::
* Testing: Testing<68>.
* Test datasets: Test datasets<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<73>,  Next: Loading<74>,  Up: dimension_reduction_protocols

6.54.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#dimension_reduction_protocols’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<74>,  Next: Common options,  Prev: API documentation<73>,  Up: dimension_reduction_protocols

6.54.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(dimension_reduction_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Common options,  Next: Testing<68>,  Prev: Loading<74>,  Up: dimension_reduction_protocols

6.54.3 Common options
---------------------

The ‘dimension_reducer_common’ category supports the ‘feature_scaling/1’
option used by importing reducers to control continuous feature
normalization before projection:

   - ‘feature_scaling(true)’ standardizes each continuous attribute
     using its training-set mean and standard deviation.

   - ‘feature_scaling(false)’ only centers each continuous attribute
     using its training-set mean.

The current ‘pca_projection’, ‘random_projection’, ‘lda_projection’, and
‘pls_projection’ libraries all define ‘feature_scaling(true)’ as their
default.

Reducers can also specialize preprocessing behavior.  For example, the
‘nmf_projection’ library only supports ‘center(false)’ because the
learned feature representation must remain non-negative.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<68>,  Next: Test datasets<4>,  Prev: Common options,  Up: dimension_reduction_protocols

6.54.4 Testing
--------------

To run the library smoke tests, load the ‘tester.lgt’ file:

     | ?- logtalk_load(dimension_reduction_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test datasets<4>,  Prev: Testing<68>,  Up: dimension_reduction_protocols

6.54.5 Test datasets
--------------------

Several sample datasets are included in the ‘test_datasets’ directory:

   - ‘correlated_plane.lgt’ — A compact continuous dataset with 8
     examples and 3 continuous attributes (‘x’, ‘y’, ‘z’) where the
     features are strongly correlated.  It is intended for PCA and
     projection smoke tests.

   - ‘high_dimensional_measurements.lgt’ — A small continuous dataset
     with 10 examples and 6 continuous attributes (‘f1’ through ‘f6’).
     It is intended for testing projected dimensionality and reducer
     output shape.

   - ‘low_rank_rectangular.lgt’ — A compact continuous dataset with 4
     examples and 3 continuous attributes whose third feature is the sum
     of the first two.  It is intended for testing matrix-rank
     truncation and singular-value-based reducers such as
     ‘truncated_svd_projection’.

   - ‘labeled_measurements.lgt’ — A compact labeled continuous dataset
     with 9 examples, 4 continuous attributes (‘length’, ‘width’,
     ‘height’, ‘weight’), and 3 class labels (‘alpha’, ‘beta’, ‘gamma’).
     It is intended for testing supervised reducers such as
     ‘lda_projection’.

   - ‘parts_based_measurements.lgt’ — A compact non-negative continuous
     dataset with 5 examples and 4 continuous attributes (‘f1’ through
     ‘f4’) built from two latent additive parts.  It is intended for
     testing parts-based reducers such as ‘nmf_projection’.

   - ‘target_latent_measurements.lgt’ — A compact target-valued
     continuous dataset with 6 examples, 4 continuous attributes (‘f1’
     through ‘f4’), and a numeric target attribute (‘score’) influenced
     by two latent directions.  It is intended for testing
     target-supervised reducers such as ‘pls_projection’.

   - Target-supervised smoke coverage is currently provided by the
     ‘target_measurements’ object in the library smoke tests, which
     exercises the
     ‘target_supervised_dimension_reduction_dataset_protocol’ contract.


File: TheLogtalkHandbook-3.100.1.info,  Node: eclat_pattern_miner,  Next: edcg,  Prev: dimension_reduction_protocols,  Up: Libraries

6.55 ‘eclat_pattern_miner’
==========================

Eclat frequent itemset miner for transaction datasets.  Normalizes
dataset transaction identifiers to internal ascending ordinals, builds
vertical tidsets for frequent singleton items, and recursively extends
them by lexicographic suffix joins and tidset intersections.

This library depends on the ‘frequent_pattern_mining_protocols’ support
library, implements the generic ‘pattern_miner_protocol’ defined in the
‘pattern_mining_protocols’ core library.

Requires a dataset implementing ‘transaction_dataset_protocol’ with
transactions represented as canonical sorted lists of unique declared
items.  External transaction identifiers are treated as opaque metadata
and normalized to internal ordinals before tidset construction.

* Menu:

* API documentation: API documentation<74>.
* Loading: Loading<75>.
* Testing: Testing<69>.
* Features: Features<14>.
* Options: Options<13>.
* Pattern miner representation: Pattern miner representation<3>.
* References: References<10>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<74>,  Next: Loading<75>,  Up: eclat_pattern_miner

6.55.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#eclat_pattern_miner’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<75>,  Next: Testing<69>,  Prev: API documentation<74>,  Up: eclat_pattern_miner

6.55.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(eclat_pattern_miner(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<69>,  Next: Features<14>,  Prev: Loading<75>,  Up: eclat_pattern_miner

6.55.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(eclat_pattern_miner(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<14>,  Next: Options<13>,  Prev: Testing<69>,  Up: eclat_pattern_miner

6.55.4 Features
---------------

   - 'Vertical Tidsets': Represents each frequent extension by the
     sorted list of transaction identifiers containing it.

   - 'Transaction Ordinal Normalization': Treats external transaction
     identifiers as opaque metadata and normalizes them to internal
     ascending ordinals before building vertical tidsets.

   - 'Depth-First Mining': Extends frequent prefixes recursively using
     tidset intersections.

   - 'Canonical Transactions': Validates that transactions are sorted,
     duplicate-free, and restricted to declared items.

   - 'Flexible Support Thresholds': Supports relative minimum support
     and absolute minimum support count.  When both are given, the
     absolute-count threshold takes precedence.

   - 'Model Export': Mined pattern collections can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<13>,  Next: Pattern miner representation<3>,  Prev: Features<14>,  Up: eclat_pattern_miner

6.55.5 Options
--------------

The ‘mine/3’ predicate accepts the following options:

   - ‘minimum_support/1’: Relative minimum support threshold in the
     interval ‘]0.0, 1.0]’.  The default is ‘0.5’.

   - ‘minimum_support_count/1’: Absolute minimum support count.  When
     both support options are provided, this option takes precedence.

   - ‘maximum_pattern_length/1’: Maximum itemset length to mine.  The
     default is ‘1000’, which is effectively capped by the longest
     transaction in the dataset.

   - ‘minimum_pattern_length/1’: Minimum itemset length retained in the
     mined result.  The default is ‘1’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pattern miner representation<3>,  Next: References<10>,  Prev: Options<13>,  Up: eclat_pattern_miner

6.55.6 Pattern miner representation
-----------------------------------

The mined pattern miner result is represented by a compound term with
the functor chosen by the implementation and arity 3.  For example:

     eclat_pattern_miner(ItemDomain, Patterns, Options)

Where:

   - ‘ItemDomain’: Canonical sorted list of declared dataset items.

   - ‘Patterns’: List of ‘itemset(Items, SupportCount)’ terms ordered
     first by pattern length and then lexicographically.

   - ‘Options’: Effective mining options used to mine the frequent
     itemsets.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<10>,  Prev: Pattern miner representation<3>,  Up: eclat_pattern_miner

6.55.7 References
-----------------

  1. Zaki, M. J. (2000) - “Scalable algorithms for association mining”.


File: TheLogtalkHandbook-3.100.1.info,  Node: edcg,  Next: elastic_net_regression,  Prev: eclat_pattern_miner,  Up: Libraries

6.56 ‘edcg’
===========

This library provides a Logtalk port of Peter Van Roy’s extended DCG
implementation.  For full documentation on EDCGs, see:

‘https://webperso.info.ucl.ac.be/~pvr/edcg.html’

This Logtalk version defines a hook object, ‘edcg’.  Source files
defining EDCGs must be compiled using the compiler option ‘hook(edcg)’:

     | ?- logtalk_load(source, [hook(edcg)]).

Alternatively, the following directive can be added at the beginning of
the source file containing the EDCGs:

     :- set_logtalk_flag(hook, edcg).

The hook object automatically adds the EDCGs ‘-->>’ infix operator
scoped to the source file.

This port has simplified by copying and then modifying Michael
Hendricks’s ‘edcg’ repo at:

‘https://github.com/mndrix/edcg’

A notable difference is that Michael’s version declares Peter’s original
predicates for declaring accumulators and predicates using the hidden
arguments as multifile predicates.  But this is risky as two independent
EDCGs may use e.g.  the same accumulator names and introduce conflicts.
The Logtalk version uses instead the ‘edcg’ hook object internal state
to temporarily save those predicates in order to parse the corresponding
EDCGs.

* Menu:

* API documentation: API documentation<75>.
* Loading: Loading<76>.
* Testing: Testing<70>.
* Usage: Usage<32>.
* Introduction::
* Syntax::
* Declaration of Predicates::
* Declaration of Accumulators::
* Declaration of Passed Arguments::
* Additional documentation::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<75>,  Next: Loading<76>,  Up: edcg

6.56.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#edcg’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<76>,  Next: Testing<70>,  Prev: API documentation<75>,  Up: edcg

6.56.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(edcg(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<70>,  Next: Usage<32>,  Prev: Loading<76>,  Up: edcg

6.56.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file of the
‘edcgs’ example:

     | ?- logtalk_load(edcgs(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<32>,  Next: Introduction,  Prev: Testing<70>,  Up: edcg

6.56.4 Usage
------------

Follows the usage documentation written by Michael Hendricks (with a
contribution from Peter Ludemann), used here with permission, with the
necessary changes for the Logtalk port.

     % declare accumulators
     acc_info(adder, X, In, Out, integer::plus(X,In,Out)).

     % declare predicates using these hidden arguments
     pred_info(len,0,[adder,dcg]).
     pred_info(increment,0,[adder]).

     increment -->>
         % add one to the accumulator
         [1]:adder.


     len(Xs,N) :-
         len(0,N,Xs,[]).

     len -->>
         % 'dcg' accumulator has an element
         [_],
         !,
         % increment the 'adder' accumulator
         increment,
         len.
     len -->>
         [].


File: TheLogtalkHandbook-3.100.1.info,  Node: Introduction,  Next: Syntax,  Prev: Usage<32>,  Up: edcg

6.56.5 Introduction
-------------------

DCG notation gives us a single, hidden accumulator.  Extended DCG
notation (implemented by this library) lets predicates have arbitrarily
many hidden accumulators.  As demonstrated by the synopsis above, those
accumulators can be implemented with arbitrary goals (like
‘integer::plus/3’).

Benefits of this library:

   - avoid tedium and errors from manually threading accumulators
     through your predicates

   - add or remove accumulators with a single declaration

   - change the accumulator implementation with a single declaration
     (ex, switching from ordsets to rbtrees)


File: TheLogtalkHandbook-3.100.1.info,  Node: Syntax,  Next: Declaration of Predicates,  Prev: Introduction,  Up: edcg

6.56.6 Syntax
-------------

Extended DCG syntax is very similar to DCG notation.  An EDCG is created
with clauses whose neck is the ‘-->>’ operator.  The following syntax is
supported inside an EDCG clause:

   - ‘{Goal}’ - don’t expand any hidden arguments of ‘Goal’

   - ‘Goal’ - expand all hidden arguments of Goal that are also in the
     head.  Those hidden arguments not in the head are given default
     values.

   - ‘Goal:L’ - If ‘Goal’ has no hidden arguments then force the
     expansion of all arguments in ‘L’ in the order given.  If ‘Goal’
     has hidden arguments then expand all of them, using the contents of
     ‘L’ to override the expansion.  ‘L’ is either a term of the form
     ‘Acc’, ‘Acc(Left,Right)’, ‘Pass’, ‘Pass(Value)’, or a list of such
     terms.  When present, the arguments ‘Left’, ‘Right’, and ‘Value’
     override the default values of arguments not in the head.

   - ‘List:Acc’ - Accumulate a list of terms in the accumulator ‘Acc’

   - ‘List’ - Accumulate a list of terms in the accumulator ‘dcg’

   - ‘X/Acc’ - Unify ‘X’ with the left term for the accumulator ‘Acc’

   - ‘Acc/X’ - Unify ‘X’ with the right term for the accumulator ‘Acc’

   - ‘X/Acc/Y’ - Unify ‘X’ with the left and ‘Y’ with the right term for
     the accumulator ‘Acc’

   - ‘insert(X,Y):Acc’ - Insert the arguments ‘X’ and ‘Y’ into the chain
     implementing the accumulator ‘Acc’.  This is useful when the value
     of the accumulator changes radically because ‘X’ and ‘Y’ may be the
     arguments of an arbitrary relation

   - ‘insert(X,Y)’ - Insert the arguments ‘X’ and ‘Y’ into the chain
     implementing the accumulator ‘dcg’.  This inserts the difference
     list X-Y into the accumulated list


File: TheLogtalkHandbook-3.100.1.info,  Node: Declaration of Predicates,  Next: Declaration of Accumulators,  Prev: Syntax,  Up: edcg

6.56.7 Declaration of Predicates
--------------------------------

Predicates are declared with facts of the following form:

     pred_info(Name, Arity, List).

The predicate ‘Name/Arity’ has the hidden parameters given in ‘List’.
The parameters are added in the order given by ‘List’ and their names
must be atoms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Declaration of Accumulators,  Next: Declaration of Passed Arguments,  Prev: Declaration of Predicates,  Up: edcg

6.56.8 Declaration of Accumulators
----------------------------------

Accumulators are declared with facts in one of two forms.  The short
form is:

     acc_info(Acc, Term, Left, Right, Joiner).

The long form is:

     acc_info(Acc, Term, Left, Right, Joiner, LStart, RStart).

In most cases the short form gives sufficient information.  It declares
the accumulator ‘Acc’, which must be an atom, along with the
accumulating function, ‘Joiner’, and its arguments ‘Term’, the term to
be accumulated, and ‘Left’ & ‘Right’, the variables used in chaining.

The long form of ‘acc_info’ is useful in more complex programs.  It
contains two additional arguments, ‘LStart’ and ‘RStart’, that are used
to give default starting values for an accumulator occurring in a body
goal that does not occur in the head.  The starting values are given to
the unused accumulator to ensure that it will execute correctly even
though its value is not used.  Care is needed to give correct values for
‘LStart’ and ‘RStart’.  For DCG-like list accumulation both may remain
unbound.

Two conventions are used for the two variables used in chaining
depending on which direction the accumulation is done.  For forward
accumulation, ‘Left’ is the input and ‘Right’ is the output.  For
reverse accumulation, ‘Right’ is the input and ‘Left’ is the output.


File: TheLogtalkHandbook-3.100.1.info,  Node: Declaration of Passed Arguments,  Next: Additional documentation,  Prev: Declaration of Accumulators,  Up: edcg

6.56.9 Declaration of Passed Arguments
--------------------------------------

Passed arguments are conceptually the same as accumulators with ‘=/2’ as
the joiner function.  Passed arguments are declared as facts in one of
two forms.  The short form is:

     pass_info(Pass).

The long form is:

     pass_info(Pass, PStart).

In most cases the short form is sufficient.  It declares a passed
argument ‘Pass’, that must be an atom.  The long form also contains the
starting value ‘PStart’ that is used to give a default value for a
passed argument in a body goal that does not occur in the head.  Most of
the time this situation does not occur.


File: TheLogtalkHandbook-3.100.1.info,  Node: Additional documentation,  Prev: Declaration of Passed Arguments,  Up: edcg

6.56.10 Additional documentation
--------------------------------

Peter Van Roy’s page: Declarative Programming with State(1)

Technical Report UCB/CSD-90-583 Extended DCG Notation: A Tool for
Applicative Programming in Prolog(2) by Peter Van Roy

   - The Tech Report’s PDF is here(3)

A short Wikipedia article(4) on DCGs and extensions.

   ---------- Footnotes ----------

   (1) https://webperso.info.ucl.ac.be/~pvr/edcg.html

   (2) https://www2.eecs.berkeley.edu/Pubs/TechRpts/1990/5471.html

   (3) https://www2.eecs.berkeley.edu/Pubs/TechRpts/1990/CSD-90-583.pdf

   (4) https://en.wikipedia.org/wiki/Definite_clause_grammar#Extensions


File: TheLogtalkHandbook-3.100.1.info,  Node: elastic_net_regression,  Next: elo_ranker,  Prev: edcg,  Up: Libraries

6.57 ‘elastic_net_regression’
=============================

Elastic net regression regressor supporting continuous and mixed-feature
datasets.  The library implements the ‘regressor_protocol’ defined in
the ‘regression_protocols’ library and learns a linear model using
cyclic coordinate descent with coefficient-wise soft-thresholding
updates and an additional L2 term in order to minimize mean squared
error plus a standard elastic net penalty.

* Menu:

* API documentation: API documentation<76>.
* Loading: Loading<77>.
* Testing: Testing<71>.
* Features: Features<15>.
* Regressor representation: Regressor representation<2>.
* Diagnostics syntax: Diagnostics syntax<6>.
* Options: Options<14>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<76>,  Next: Loading<77>,  Up: elastic_net_regression

6.57.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#elastic_net_regression’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<77>,  Next: Testing<71>,  Prev: API documentation<76>,  Up: elastic_net_regression

6.57.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(elastic_net_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<71>,  Next: Features<15>,  Prev: Loading<77>,  Up: elastic_net_regression

6.57.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(elastic_net_regression(tester)).

The unit test suite covers the default mixed-penalty behavior together
with the boundary cases ‘l1_ratio(0.0)’ and ‘l1_ratio(1.0)’.

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(elastic_net_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<15>,  Next: Regressor representation<2>,  Prev: Testing<71>,  Up: elastic_net_regression

6.57.4 Features
---------------

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes.

   - 'Feature Scaling': Continuous attributes can be standardized using
     z-score scaling.

   - 'Missing Values': Missing numeric and categorical values
     represented using anonymous variables are encoded using explicit
     missing-value indicator features.

   - 'Unknown Values': Prediction requests containing categorical values
     that are not declared by the dataset raise a domain error.

   - 'Mixed Penalty': Combines coefficient-wise L1 shrinkage with an L2
     penalty controlled by the ‘regularization/1’ and ‘l1_ratio/1’
     options, including the ridge-like ‘l1_ratio(0.0)’ and lasso-like
     ‘l1_ratio(1.0)’ endpoints.

   - 'Standard Encoding Semantics': Categorical attributes are encoded
     using reference-level dummy coding derived from the declared
     dataset attribute values, with a trailing missing-value indicator
     feature, and each encoded coefficient is regularized independently.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, optimization stop reason, completed
     iterations, final parameter delta, encoded feature count, and
     effective options, accessible using the shared regression
     diagnostics predicates.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for both zero-penalty
     baselines and explicit elastic-net runs on sparse, mixed,
     categorical, and wide mixed datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<2>,  Next: Diagnostics syntax<6>,  Prev: Features<15>,  Up: elastic_net_regression

6.57.5 Regressor representation
-------------------------------

The learned regressor is represented by default as:

   - ‘elastic_net_regressor(Encoders, Bias, Weights, Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(Encoders, Bias, Weights, Diagnostics)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<6>,  Next: Options<14>,  Prev: Regressor representation<2>,  Up: elastic_net_regression

6.57.6 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(elastic_net_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         convergence(Status),
         iterations(Iterations),
         final_delta(FinalDelta),
         encoded_feature_count(FeatureCount)
     ]

Where:

   - ‘model(elastic_net_regression)’ identifies the learning algorithm
     that produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘convergence(Status)’ records the optimization stop condition.  The
     current values are ‘tolerance’ when the maximum Karush-Kuhn-Tucker
     optimality violation across the intercept and all encoded features
     is within the configured tolerance and
     ‘maximum_iterations_exhausted’ when training stops because the
     iteration cap is reached.

   - ‘iterations(Iterations)’ stores the number of coordinate-descent
     sweeps completed during training.

   - ‘final_delta(FinalDelta)’ stores the maximum Karush-Kuhn-Tucker
     optimality violation measured during the final optimization check.

   - ‘encoded_feature_count(FeatureCount)’ stores the number of numeric
     features induced by the encoder list, including missing-value
     indicator features.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<14>,  Prev: Diagnostics syntax<6>,  Up: elastic_net_regression

6.57.7 Options
--------------

The ‘learn/3’ predicate accepts the following options:

   - ‘maximum_iterations/1’: Maximum number of coordinate-descent sweeps
     to run before stopping even if the tolerance criterion has not been
     met.  The default is ‘2000’.

   - ‘tolerance/1’: Convergence threshold for the maximum
     Karush-Kuhn-Tucker optimality violation in a full
     coordinate-descent sweep.  Training stops early when both the
     intercept condition and all encoded-feature subgradient conditions
     are satisfied within this value.  The default is ‘1.0e-7’.

   - ‘regularization/1’: Overall penalty coefficient applied during
     optimization.  Higher values increase shrinkage and can reduce
     overfitting.  The default is ‘0.01’.

   - ‘l1_ratio/1’: Fraction of the overall penalty assigned to the L1
     part of the elastic net penalty.  The remaining fraction is
     assigned to the L2 part.  Accepted values are floats in the
     interval ‘[0.0, 1.0]’, where ‘0.0’ gives the ridge endpoint and
     ‘1.0’ gives the lasso endpoint.  The default is ‘0.5’.

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes before training and prediction.  Accepted values are
     ‘true’ and ‘false’.  The default is ‘true’.


File: TheLogtalkHandbook-3.100.1.info,  Node: elo_ranker,  Next: events,  Prev: elastic_net_regression,  Up: Libraries

6.58 ‘elo_ranker’
=================

Elo pairwise preference ranker.  Processes the pairwise preference
stream in dataset enumeration order using the standard Elo
expected-score formula and symmetric rating updates after each observed
result.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The current implementation requires a well-formed connected
pairwise dataset so that learned ratings remain globally comparable
across all ranked items.

* Menu:

* API documentation: API documentation<77>.
* Loading: Loading<78>.
* Testing: Testing<72>.
* Features: Features<16>.
* Rating semantics::
* Usage: Usage<33>.
* Options: Options<15>.
* Ranker representation: Ranker representation<5>.
* References: References<11>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<77>,  Next: Loading<78>,  Up: elo_ranker

6.58.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#elo_ranker’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<78>,  Next: Testing<72>,  Prev: API documentation<77>,  Up: elo_ranker

6.58.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(elo_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<72>,  Next: Features<16>,  Prev: Loading<78>,  Up: elo_ranker

6.58.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(elo_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<16>,  Next: Rating semantics,  Prev: Testing<72>,  Up: elo_ranker

6.58.4 Features
---------------

   - 'Pairwise Preference Learning': Learns one deterministic rating per
     item from pairwise outcomes.

   - 'Deterministic Batch Elo Semantics': Replays the dataset preference
     stream in enumeration order using the standard Elo expected-score
     formula.  Because the current pairwise dataset protocol does not
     record historical timestamps, the implementation is a deterministic
     batch interpretation of that enumeration order rather than a
     reconstruction of a literal chronological competition log.

   - 'Configurable Rating Parameters': Exposes the initial rating,
     K-factor, and rating scale as user options.

   - 'Integer Weight Fidelity': Preference weights must be positive
     integers and are replayed as repeated unit outcomes in dataset
     enumeration order.

   - 'Deterministic Ranking': Orders candidate items by learned rating
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     comparison graphs.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Ranking Infrastructure': Reuses the ‘ranking_protocols’
     helpers for option processing, dataset validation, diagnostics,
     export, and candidate ranking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Rating semantics,  Next: Usage<33>,  Prev: Features<16>,  Up: elo_ranker

6.58.5 Rating semantics
-----------------------

This implementation uses a deterministic batch Elo interpretation over
the pairwise preference stream.  Each preference is processed in dataset
enumeration order.  For a winner with rating ‘R_w’ and a loser with
rating ‘R_l’, the expected winner score is computed as

     1 / (1 + 10^((R_l - R_w)/Scale))

and the winner receives a rating update of

     K * (1 - ExpectedWinnerScore)

with the loser receiving the symmetric negative update.

Because the current pairwise dataset protocol does not encode
timestamps, this is a deterministic batch Elo variant rather than a
literal historical competition-log replay.

Positive integer preference weights are replayed as repeated unit
outcomes.  Datasets using non-integer preference weights are rejected
because they do not map cleanly to standard Elo update semantics.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<33>,  Next: Options<15>,  Prev: Rating semantics,  Up: elo_ranker

6.58.6 Usage
------------

* Menu:

* Learning a ranker: Learning a ranker<5>.
* Inspecting diagnostics: Inspecting diagnostics<5>.
* Ranking candidate items: Ranking candidate items<5>.
* Exporting the ranker: Exporting the ranker<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<5>,  Next: Inspecting diagnostics<5>,  Up: Usage<33>

6.58.6.1 Learning a ranker
..........................

     % Learn from a pairwise ranking dataset object
     | ?- elo_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with custom Elo parameters
     | ?- elo_ranker::learn(my_dataset, Ranker, [initial_rating(1400.0), k_factor(24.0), rating_scale(200.0)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<5>,  Next: Ranking candidate items<5>,  Prev: Learning a ranker<5>,  Up: Usage<33>

6.58.6.2 Inspecting diagnostics
...............................

     % Inspect model, options, and dataset summary metadata
     | ?- elo_ranker::learn(my_dataset, Ranker),
          elo_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<5>,  Next: Exporting the ranker<5>,  Prev: Inspecting diagnostics<5>,  Up: Usage<33>

6.58.6.3 Ranking candidate items
................................

     % Rank a candidate set from most preferred to least preferred
     | ?- elo_ranker::learn(my_dataset, Ranker),
          elo_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<5>,  Prev: Ranking candidate items<5>,  Up: Usage<33>

6.58.6.4 Exporting the ranker
.............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- elo_ranker::learn(my_dataset, Ranker),
          elo_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(elo_ranker(...))]
     ...

     % Export to a file
     | ?- elo_ranker::learn(my_dataset, Ranker),
          elo_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<15>,  Next: Ranker representation<5>,  Prev: Usage<33>,  Up: elo_ranker

6.58.7 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘initial_rating(Rating)’: Initial rating assigned to every item.

   - ‘k_factor(KFactor)’: Positive Elo K-factor.

   - ‘rating_scale(Scale)’: Positive rating-scale denominator used in
     the expected-score formula.

Datasets supplied to the ranker must use positive integer preference
weights.  Non-integer weights are rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<5>,  Next: References<11>,  Prev: Options<15>,  Up: elo_ranker

6.58.8 Ranker representation
----------------------------

The learned ranker is represented by a compound term of the form:

     elo_ranker(Items, Ratings, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Rating’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options and dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<11>,  Prev: Ranker representation<5>,  Up: elo_ranker

6.58.9 References
-----------------

  1. Elo, A. E. (1978).  'The Rating of Chessplayers, Past and Present'.
     Arco.


File: TheLogtalkHandbook-3.100.1.info,  Node: events,  Next: ewma_anomaly_detector,  Prev: elo_ranker,  Up: Libraries

6.59 ‘events’
=============

The objects ‘event_registry’, ‘before_event_registry’, and
‘after_event_registry’ implement convenient predicates for registering
before and after events.

The code makes use of the ‘monitoring’ built-in protocol, which declares
the two basic event handler predicates (‘before/3’ and ‘after/3’).  You
will need to refer to this protocol in your objects if you want to use
the super control structure ‘(^^/1)’ with these predicates.

The ‘monitor’ object implements more sophisticated event handling
predicates.

* Menu:

* API documentation: API documentation<78>.
* Loading: Loading<79>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<78>,  Next: Loading<79>,  Up: events

6.59.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#events’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<79>,  Prev: API documentation<78>,  Up: events

6.59.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ loader file:

     | ?- logtalk_load(events(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: ewma_anomaly_detector,  Next: expand_library_alias_paths,  Prev: events,  Up: Libraries

6.60 ‘ewma_anomaly_detector’
============================

EWMA (Exponentially Weighted Moving Average) anomaly detector for
continuous sequence-like datasets.  It is a statistical
anomaly-detection method based on a two-sided EWMA control chart: for
each known step value ‘x_t’, it computes a standardized deviation,
updates the EWMA statistic ‘E_t’, and uses the maximum normalized
excursion ‘|E_t| / (L*c_t)’ as the raw anomaly score, so a score of
‘1.0’ corresponds exactly to reaching the chosen EWMA control limit.

The library implements the ‘anomaly_detector_protocol’ defined in the
‘anomaly_detection_protocols’ library.  It learns a detector from a
continuous dataset, computes anomaly scores for new instances, predicts
‘normal’ or ‘anomaly’, and exports learned detectors as clauses or
files.

Datasets are represented as objects implementing the
‘anomaly_dataset_protocol’ protocol from the
‘anomaly_detection_protocols’ library.  Declared continuous attributes
are interpreted as ordered monitoring steps in a sequence.  See the
‘ewma_anomaly_detector/tests.lgt’ file for example datasets.

* Menu:

* API documentation: API documentation<79>.
* Loading: Loading<80>.
* Testing: Testing<73>.
* Features: Features<17>.
* Options: Options<16>.
* Detector representation: Detector representation<2>.
* Notes: Notes<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<79>,  Next: Loading<80>,  Up: ewma_anomaly_detector

6.60.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#ewma_anomaly_detector’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<80>,  Next: Testing<73>,  Prev: API documentation<79>,  Up: ewma_anomaly_detector

6.60.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ewma_anomaly_detector(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<73>,  Next: Features<17>,  Prev: Loading<80>,  Up: ewma_anomaly_detector

6.60.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ewma_anomaly_detector(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<17>,  Next: Options<16>,  Prev: Testing<73>,  Up: ewma_anomaly_detector

6.60.4 Features
---------------

   - 'Statistical method': implements anomaly detection based on a
     two-sided EWMA control chart, using learned per-step population
     means and standard deviations for continuous attributes.

   - 'Ordered sequence interpretation': declared continuous attributes
     are treated as ordered monitoring steps.  For each known step value
     ‘x_t’, the library computes ‘z_t = (x_t - mu_t) / sigma_t’ and
     updates the EWMA recurrence ‘E_t = lambda*z_t + (1 -
     lambda)*E_(t-1)’ with ‘E_0 = 0’.

   - 'EWMA control limits': the raw anomaly score is the maximum
     normalized excursion ‘|E_t| / (L*c_t)’, where ‘L’ is the learn-time
     ‘control_limit_multiplier/1’ option and ‘c_t =
     sqrt(lambda/(2-lambda) * (1 - (1-lambda)^(2*t)))’ is the classical
     EWMA control-limit factor after ‘t’ EWMA updates.  The learned
     detector stores a precomputed attribute schema so that query values
     can be reordered efficiently during scoring.

   - 'Continuous features only': accepts datasets whose declared
     attributes are all ‘continuous’.

   - 'Baseline training selection': supports learn-time
     ‘baseline_class_values(ClassValues)’ and
     ‘baseline_selection_policy(Policy)’ options.  The default baseline
     class values are ‘[normal]’.  The default ‘reject’ policy throws an
     error if any non-baseline training example is found.  The ‘filter’
     policy removes non-baseline examples before fitting the baseline
     statistics.

   - 'Missing-value tolerant': ignores missing values when fitting
     per-step statistics.  During scoring, missing step values do not
     update the EWMA state or advance the EWMA update count.  Queries
     must still provide at least one known value.

   - 'Bounded scoring': maps the raw EWMA excursion to ‘[0.0, 1.0)’
     using ‘Score = Raw / (1 + Raw)’.

   - 'EWMA control parameters': supports learn-time
     ‘control_limit_multiplier/1’ and ‘smoothing_factor/1’ options.  The
     default ‘control_limit_multiplier(3.0)’ and ‘smoothing_factor(0.2)’
     correspond to a common EWMA monitoring setup.

   - 'Default threshold': the default ‘anomaly_threshold(0.5)’
     corresponds to the chosen EWMA control limit after score
     normalization.  Because the raw score is already normalized by the
     learned control limit, this threshold remains the same for any
     learned ‘control_limit_multiplier/1’ value.

   - 'Learn-time control parameters': ‘control_limit_multiplier/1’ and
     ‘smoothing_factor/1’ are recorded in the learned detector and
     reused for subsequent scoring and prediction.  Passing them to
     ‘predict/4’ does not override the learned values.  Only
     ‘anomaly_threshold/1’ can be overridden at predict time.

   - 'All-missing queries rejected': scoring and prediction throw a
     ‘domain_error(non_empty_known_values, AttributeNames)’ exception
     when every declared step is missing in the query.

   - 'Featureless datasets rejected': datasets must declare at least one
     continuous feature; otherwise ‘learn/2-3’ throws a
     ‘domain_error(non_empty_features, Dataset)’ exception.

   - 'Detector export': learned detectors can be exported as predicate
     clauses.

   - 'Explicit validation and diagnostics': supports the shared
     ‘check_anomaly_detector/1’, ‘valid_anomaly_detector/1’,
     ‘diagnostics/2’, ‘diagnostic/2’, and ‘anomaly_detector_options/2’
     predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<16>,  Next: Detector representation<2>,  Prev: Features<17>,  Up: ewma_anomaly_detector

6.60.5 Options
--------------

The following options are supported by the public API:

   - ‘anomaly_threshold(Threshold)’: Threshold for ‘predict/3-4’
     (default: ‘0.5’)

   - ‘baseline_class_values(ClassValues)’: Learn-time class labels that
     are admissible for baseline fitting (default: ‘[normal]’)

   - ‘baseline_selection_policy(Policy)’: Learn-time handling of
     examples whose class is not listed in ‘baseline_class_values/1’.
     Supported values are ‘reject’ and ‘filter’ (default: ‘reject’)

   - ‘control_limit_multiplier(ControlLimitMultiplier)’: Learn-time EWMA
     control-limit multiplier ‘L’ (default: ‘3.0’)

   - ‘smoothing_factor(SmoothingFactor)’: Learn-time EWMA smoothing
     factor ‘lambda’ (default: ‘0.2’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Detector representation<2>,  Next: Notes<4>,  Prev: Options<16>,  Up: ewma_anomaly_detector

6.60.6 Detector representation
------------------------------

The learned detector is represented by default as:

     ewma_detector(TrainingDataset, AttributeSchema, Encoders, Diagnostics)

Where:

   - ‘TrainingDataset’: training dataset object identifier

   - ‘AttributeSchema’: precomputed attribute ordering metadata used to
     validate and reorder query step values efficiently during scoring

   - ‘Encoders’: list of ‘ewma_encoder(Attribute, Mean, Scale)’ records

   - ‘Diagnostics’: learned metadata terms including ‘model/1’,
     ‘training_dataset/1’, ‘attribute_names/1’, ‘feature_count/1’,
     ‘example_count/1’, and ‘options/1’.  The ‘example_count/1’ value is
     the effective number of training examples after applying the
     selected baseline selection policy.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
detector term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<4>,  Prev: Detector representation<2>,  Up: ewma_anomaly_detector

6.60.7 Notes
------------

Scoring has three stages.  First, the detector computes one standardized
deviation ‘z_t = (x_t - mu_t) / sigma_t’ for each known monitoring step.
Second, those deviations are processed sequentially using the EWMA
recurrence ‘E_t = lambda*z_t + (1 - lambda)*E_(t-1)’ with the learned
‘smoothing_factor/1’ value.  Third, the maximum normalized excursion
‘|E_t| / (L*c_t)’ is mapped to the interval ‘[0.0, 1.0)’ using ‘Score =
Raw / (1 + Raw)’.

The control-limit factor ‘c_t’ is computed from the number of actual
EWMA updates, not from the declared attribute position.  Accordingly,
leading or intermediate missing step values neither update the EWMA
state nor widen the control limits.

The ‘smoothing_factor/1’ option changes the EWMA update rule itself.
Smaller values make the detector retain longer-term history while larger
values react more strongly to recent deviations.  The
‘control_limit_multiplier/1’ option scales the control limits directly
in the score path.  Larger values therefore make the detector less
sensitive by requiring larger EWMA excursions before the raw score
reaches ‘1.0’.

The ‘baseline_class_values/1’ option declares which dataset class labels
are admissible for baseline fitting.  The ‘baseline_selection_policy/1’
option then controls what happens when other labels are present in the
training data.  The default ‘reject’ policy raises a
‘domain_error(baseline_only_training_data, Dataset)’ exception when any
non-baseline example is found.  The ‘filter’ policy removes non-baseline
examples before fitting and raises a
‘domain_error(non_empty_baseline_training_data, Dataset)’ exception if
no training examples remain after filtering.

Attributes with zero observed dispersion are assigned a fallback scale
of ‘1.0’.  This keeps the detector well-defined for singleton datasets
or constant steps while still yielding zero score for matching values
and positive scores for deviating values.


File: TheLogtalkHandbook-3.100.1.info,  Node: expand_library_alias_paths,  Next: expecteds,  Prev: ewma_anomaly_detector,  Up: Libraries

6.61 ‘expand_library_alias_paths’
=================================

This library provides provides a hook object,
‘expand_library_alias_paths’, for expanding library alias paths in
‘logtalk_library_path/2 facts’ in source files.  It is mainly used when
embedding Logtalk and Logtalk applications.

* Menu:

* API documentation: API documentation<80>.
* Loading: Loading<81>.
* Usage: Usage<34>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<80>,  Next: Loading<81>,  Up: expand_library_alias_paths

6.61.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#expand-library-alias-paths’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<81>,  Next: Usage<34>,  Prev: API documentation<80>,  Up: expand_library_alias_paths

6.61.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(expand_library_alias_paths(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<34>,  Prev: Loading<81>,  Up: expand_library_alias_paths

6.61.3 Usage
------------

Use the ‘hook/1’ option when compiling a source file:

     | ?- logtalk_load(my_source_file, [hook(expand_library_alias_paths)]).
     ...

Alternatively, assuming it is the only hook object you are using, you
can set it as thew default hook object:

     | ?- set_logtalk_flag(hook, expand_library_alias_paths).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: expecteds,  Next: format,  Prev: expand_library_alias_paths,  Up: Libraries

6.62 ‘expecteds’
================

This library provides an implementation of 'expected terms' with an API
that is inspired by the ‘optional’ library and C++ standardization
proposals for an ‘Expected<T>’ type.  An expected term is an opaque
compound term that either contains an expected value or an error
informing why the expected value is not present.  Expected terms provide
an alternative to generating an exception (or a failure) when something
unexpected happens when asking for a value.  This allows, e.g.,
separating the code that constructs expected terms from the code that
processes them, which is then free to deal if necessary and at its
convenience with any unexpected events.

* Menu:

* API documentation: API documentation<81>.
* Loading: Loading<82>.
* Testing: Testing<74>.
* Usage: Usage<35>.
* See also::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<81>,  Next: Loading<82>,  Up: expecteds

6.62.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#expecteds’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<82>,  Next: Testing<74>,  Prev: API documentation<81>,  Up: expecteds

6.62.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(expecteds(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<74>,  Next: Usage<35>,  Prev: Loading<82>,  Up: expecteds

6.62.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(expecteds(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<35>,  Next: See also,  Prev: Testing<74>,  Up: expecteds

6.62.4 Usage
------------

The ‘expected’ object provides constructors for expected terms.  For
example:

     | ?- expected::of_expected(1, Expected).
     ...

The created expected terms can then be passed as parameters to the
‘expected/1’ parametric object.  For example:

     | ?- expected::of_expected(1, Expected), expected(Expected)::or_else(Value, 0).
     Expected = expected(1),
     Value = 1
     yes

     | ?- expected::of_unexpected(-1, Expected), expected(Expected)::or_else(Value, 0).
     Expected = unexpected(-1),
     Value = 0
     yes

The ‘either’ object provides types and predicates for extended
type-checking and predicates for handling lists of expected terms,
including ‘sequence/2’ and ‘traverse/3’.

The ‘expected/1’ parametric object provides ‘filter/3’ for conditionally
rejecting values, converting them to unexpected terms with a given
error:

     | ?- expected::of_expected(1, Expected),
          expected(Expected)::filter(integer, not_integer, NewExpected).
     NewExpected = expected(1)
     yes

     | ?- expected::of_expected(a, Expected),
          expected(Expected)::filter(integer, not_integer, NewExpected).
     NewExpected = unexpected(not_integer)
     yes

The ‘map_or_else/3’ predicate applies a closure to the value if present,
returning a default value otherwise (symmetric with the optionals
library):

     | ?- expected::of_expected(a, Expected),
          expected(Expected)::map_or_else(char_code, 0, Value).
     Value = 97
     yes

     | ?- expected::of_unexpected(-1, Expected),
          expected(Expected)::map_or_else(char_code, 0, Value).
     Value = 0
     yes

The ‘or/2’ predicate chains expected terms, returning the current term
if it holds a value, or calling a closure to produce an alternative
otherwise:

     | ?- expected::of_expected(1, Expected),
          expected(Expected)::or(NewExpected, expected::of_expected(2)).
     NewExpected = expected(1)
     yes

     | ?- expected::of_unexpected(-1, Expected),
          expected(Expected)::or(NewExpected, expected::of_expected(2)).
     NewExpected = expected(2)
     yes

The ‘zip/3’ predicate combines two expected terms using a closure when
both hold values, returning the first error otherwise:

     | ?- expected::of_expected(1, E1), expected::of_expected(3, E2),
          expected(E1)::zip([X,Y,Z]>>(Z is X+Y), E2, NewExpected).
     NewExpected = expected(4)
     yes

     | ?- expected::of_unexpected(-1, E1), expected::of_expected(3, E2),
          expected(E1)::zip([X,Y,Z]>>(Z is X+Y), E2, NewExpected).
     NewExpected = unexpected(-1)
     yes

The ‘map_unexpected/2’ predicate transforms the error held by an
expected term:

     | ?- expected::of_unexpected(-1, Expected),
          expected(Expected)::map_unexpected([X,Y]>>(Y is abs(X)), NewExpected).
     NewExpected = unexpected(1)
     yes

The ‘map_catching/2’ predicate applies a closure that may throw an
error, catching it and wrapping it as an unexpected term:

     | ?- expected::of_expected(a, Expected),
          expected(Expected)::map_catching(char_code, NewExpected).
     NewExpected = expected(97)
     yes

     | ?- expected::of_expected(1, Expected),
          expected(Expected)::map_catching(char_code, NewExpected),
          expected(NewExpected)::is_unexpected.
     yes

The ‘map_both/3’ predicate is a bifunctor map that transforms both the
expected value and unexpected error using separate closures:

     | ?- expected::of_expected(1, Expected),
          expected(Expected)::map_both([X,Y]>>(Y is X+1), [X,Y]>>(Y is abs(X)), NewExpected).
     NewExpected = expected(2)
     yes

The ‘swap/1’ predicate swaps expected and unexpected terms:

     | ?- expected::of_expected(1, Expected),
          expected(Expected)::swap(NewExpected).
     NewExpected = unexpected(1)
     yes

     | ?- expected::of_unexpected(error, Expected),
          expected(Expected)::swap(NewExpected).
     NewExpected = expected(error)
     yes

The ‘flatten/1’ predicate unwraps a nested expected term:

     | ?- expected::of_expected(1, Inner), expected::of_expected(Inner, Outer),
          expected(Outer)::flatten(NewExpected).
     NewExpected = expected(1)
     yes

     | ?- expected::of_unexpected(oops, Inner), expected::of_expected(Inner, Outer),
          expected(Outer)::flatten(NewExpected).
     NewExpected = unexpected(oops)
     yes

Conversion between expected and optional terms is provided by the
‘to_optional/1’, ‘from_optional/3’, and ‘optional/1::to_expected/2’
predicates:

     | ?- expected::of_expected(1, Expected),
          expected(Expected)::to_optional(Optional).
     Optional = optional(1)
     yes

     | ?- expected::of_unexpected(error, Expected),
          expected(Expected)::to_optional(Optional).
     Optional = empty
     yes

     | ?- optional::of(1, Optional),
          expected::from_optional(Optional, missing, Expected).
     Expected = expected(1)
     yes

     | ?- optional::empty(Optional),
          expected::from_optional(Optional, missing, Expected).
     Expected = unexpected(missing)
     yes

Examples:

     | ?- expected::of_expected(1, E1), expected::of_expected(2, E2),
          either::sequence([E1, E2], Expected).
     Expected = expected([1,2])
     yes

     | ?- either::traverse({expected}/[X,E]>>expected::of_expected(X, E), [1,2], Expected).
     Expected = expected([1,2])
     yes

     | ?- either::traverse({expected}/[X,E]>>(
            integer(X) -> expected::of_expected(X, E)
          ; expected::of_unexpected(not_integer(X), E)
          ), [1,a,2], Expected).
     Expected = unexpected(not_integer(a))
     yes

     | ?- expected::of_expected(1, E1), expected::of_unexpected(e, E2),
          either::sequence([E1, E2], Expected).
     Expected = unexpected(e)
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: See also,  Prev: Usage<35>,  Up: expecteds

6.62.5 See also
---------------

The ‘optionals’ and ‘validations’ libraries.


File: TheLogtalkHandbook-3.100.1.info,  Node: format,  Next: fp_growth_pattern_miner,  Prev: expecteds,  Up: Libraries

6.63 ‘format’
=============

The ‘format’ object provides a portable abstraction over how the de
facto standard ‘format/2-3’ predicates are made available by the
supported backend Prolog systems.  Some systems provide these predicates
as built-in predicates, while others make them available using a library
that must be explicitly loaded.

Calls to the library predicates are inlined when compiled with the
‘optimize’ flag turned on for most of the backends.  When that’s the
case, there is no overhead compared with calling the abstracted
predicates directly.

This library provides linter checks for calls to the ‘format/2-3’
predicates.  Given the differences between the implementations of these
predicates among Prolog systems, the linter checks focus on detecting
common errors such as missing arguments and too many arguments.  The
linter warnings are printed when the ‘suspicious_calls’ flag is set to
‘warning’ (its usual default).

* Menu:

* API documentation: API documentation<82>.
* Loading: Loading<83>.
* Testing: Testing<75>.
* Usage: Usage<36>.
* Portability: Portability<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<82>,  Next: Loading<83>,  Up: format

6.63.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#format’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<83>,  Next: Testing<75>,  Prev: API documentation<82>,  Up: format

6.63.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(format(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<75>,  Next: Usage<36>,  Prev: Loading<83>,  Up: format

6.63.3 Testing
--------------

Minimal tests for this library predicates can be run by loading the
‘tester.lgt’ file:

     | ?- logtalk_load(format(tester)).

Detailed tests for the ‘format/2-3’ predicates are available in the
‘tests/prolog/predicates’ directory as part of the Prolog standards
conformance test suite.  Use those tests to confirm the portability of
the format specifiers that you want to use.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<36>,  Next: Portability<2>,  Prev: Testing<75>,  Up: format

6.63.4 Usage
------------

Load this library from your application loader file.  To call the
‘format/2-3’ predicates using implicit message-sending, add the
following directive to any object or category calling the predicates:

     :- uses(format, [
         format/2, format/3
     ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Portability<2>,  Prev: Usage<36>,  Up: format

6.63.5 Portability
------------------

Some Prolog systems provide only a subset of the expected format
specifiers.  Notably, table-related format specifiers are only fully
supported by a few systems.  See the section below on testing.

Only some of the supported Prolog backends provide implementations of
the ‘format/2-3’ predicates that allow using not only an atom or a list
of character codes for the format string (as de facto standard) but also
using a list of characters.  These currently include ECLiPSe, GNU
Prolog, SICStus Prolog, SWI-Prolog, Trealla Prolog, XVM, and YAP.
Therefore, when wide portability is sought, atoms must be used for the
format specifier argument as they bypass any dependency on the
‘double_quotes’ standard Prolog flag.  Some systems, like Tau Prolog,
only accept a list of characters for the format string.  In this case,
this library will convert the atom format string before calling these
systems native implementations.


File: TheLogtalkHandbook-3.100.1.info,  Node: fp_growth_pattern_miner,  Next: frequent_pattern_mining_protocols,  Prev: format,  Up: Libraries

6.64 ‘fp_growth_pattern_miner’
==============================

FP-growth frequent itemset miner for transaction datasets.  The library
depends on the ‘frequent_pattern_mining_protocols’ support library,
implements the generic ‘pattern_miner_protocol’ defined in the
‘pattern_mining_protocols’ core library, and mines frequent itemsets
using recursive conditional pattern-base projection over a compact
FP-tree whose nodes store parent links directly, plus header-table node
chains derived from the final tree for direct conditional-base
reconstruction, without candidate generation.

Requires a dataset implementing ‘transaction_dataset_protocol’ with
transactions represented as canonical sorted lists of unique declared
items.

* Menu:

* API documentation: API documentation<83>.
* Loading: Loading<84>.
* Testing: Testing<76>.
* Features: Features<18>.
* Options: Options<17>.
* Pattern miner representation: Pattern miner representation<4>.
* References: References<12>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<83>,  Next: Loading<84>,  Up: fp_growth_pattern_miner

6.64.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#fp_growth_pattern_miner’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<84>,  Next: Testing<76>,  Prev: API documentation<83>,  Up: fp_growth_pattern_miner

6.64.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(fp_growth_pattern_miner(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<76>,  Next: Features<18>,  Prev: Loading<84>,  Up: fp_growth_pattern_miner

6.64.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(fp_growth_pattern_miner(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<18>,  Next: Options<17>,  Prev: Testing<76>,  Up: fp_growth_pattern_miner

6.64.4 Features
---------------

   - 'FP-tree Construction': Builds a compact prefix tree from frequent
     items ordered by global support.

   - 'Header and Parent Links': Stores parent links directly in tree
     nodes and derives header-table node chains from the final tree so
     conditional pattern bases are reconstructed by walking parent links
     instead of using a separate node index.

   - 'Pattern Growth': Mines frequent itemsets recursively from
     conditional pattern bases without candidate generation.

   - 'Canonical Transactions': Validates that transactions are sorted,
     duplicate-free, and restricted to declared items.

   - 'Flexible Support Thresholds': Supports relative minimum support
     and absolute minimum support count.

   - 'Model Export': Mined pattern collections can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<17>,  Next: Pattern miner representation<4>,  Prev: Features<18>,  Up: fp_growth_pattern_miner

6.64.5 Options
--------------

The ‘mine/3’ predicate accepts the following options:

   - ‘minimum_support/1’: Relative minimum support threshold in the
     interval ‘]0.0, 1.0]’.  The default is ‘0.5’.

   - ‘minimum_support_count/1’: Absolute minimum support count.  When
     both support options are provided, this option takes precedence.

   - ‘maximum_pattern_length/1’: Maximum itemset length to mine.  The
     default is ‘1000’, which is effectively capped by the longest
     transaction in the dataset.

   - ‘minimum_pattern_length/1’: Minimum itemset length retained in the
     mined result.  The default is ‘1’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pattern miner representation<4>,  Next: References<12>,  Prev: Options<17>,  Up: fp_growth_pattern_miner

6.64.6 Pattern miner representation
-----------------------------------

The mined pattern miner result is represented by a compound term with
the functor chosen by the implementation and arity 3.  For example:

     fp_growth_pattern_miner(ItemDomain, Patterns, Options)

Where:

   - ‘ItemDomain’: Canonical sorted list of declared dataset items.

   - ‘Patterns’: List of ‘itemset(Items, SupportCount)’ terms ordered
     first by pattern length and then lexicographically.

   - ‘Options’: Effective mining options used to mine the frequent
     itemsets.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<12>,  Prev: Pattern miner representation<4>,  Up: fp_growth_pattern_miner

6.64.7 References
-----------------

  1. Han, J., Pei, J., and Yin, Y. (2000) - “Mining frequent patterns
     without candidate generation”.


File: TheLogtalkHandbook-3.100.1.info,  Node: frequent_pattern_mining_protocols,  Next: gaussian_mixture_clusterer,  Prev: fp_growth_pattern_miner,  Up: Libraries

6.65 ‘frequent_pattern_mining_protocols’
========================================

This library provides support entities for frequent itemset mining
algorithms.  Transactional datasets are represented as objects
implementing the ‘transaction_dataset_protocol’ protocol.  The generic
‘pattern_miner_protocol’ protocol and the ‘pattern_miner_common’
category used by concrete miners are loaded from the
‘pattern_mining_protocols’ core library.

The ‘frequent_pattern_mining_common’ category builds on that generic
core with frequent-itemset-specific helpers for dataset validation,
support accumulation, and itemset ordering/filtering.

This library also provides reusable transaction smoke-test datasets and
a small smoke-test suite.

* Menu:

* API documentation: API documentation<84>.
* Loading: Loading<85>.
* Testing: Testing<77>.
* Test datasets: Test datasets<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<84>,  Next: Loading<85>,  Up: frequent_pattern_mining_protocols

6.65.1 API documentation
------------------------

Open the
‘../../apis/library_index.html#frequent_pattern_mining_protocols’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<85>,  Next: Testing<77>,  Prev: API documentation<84>,  Up: frequent_pattern_mining_protocols

6.65.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(frequent_pattern_mining_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<77>,  Next: Test datasets<5>,  Prev: Loading<85>,  Up: frequent_pattern_mining_protocols

6.65.3 Testing
--------------

To run the library smoke tests, load the ‘tester.lgt’ file:

     | ?- logtalk_load(frequent_pattern_mining_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test datasets<5>,  Prev: Testing<77>,  Up: frequent_pattern_mining_protocols

6.65.4 Test datasets
--------------------

Several sample transaction datasets are included in the ‘test_datasets’
directory:

   - ‘market_basket_basics.lgt’: A compact transaction dataset with 6
     transactions and 5 items intended for frequent-itemset smoke tests.

   - ‘layered_baskets.lgt’: A transaction dataset with overlapping
     co-occurrence layers intended for support-count and
     candidate-pruning tests.

   - ‘deep_intersection_baskets.lgt’: A compact transaction dataset with
     one frequent length-4 itemset and multiple overlapping length-3
     itemsets intended to stress deeper vertical tidset intersections.

The directory also includes invalid fixtures useful for validation and
error-handling tests:

   - ‘invalid_undeclared_item_baskets.lgt’: Uses an item not listed in
     the declared item domain.

   - ‘invalid_unsorted_transaction_baskets.lgt’: Uses a transaction
     whose items are not in canonical sorted order.

   - ‘invalid_duplicate_item_baskets.lgt’: Uses a transaction with a
     duplicate item.

   - ‘invalid_empty_baskets.lgt’: Declares an item domain but no
     transactions.

   - ‘invalid_item_domain_baskets.lgt’: Declares a non-canonical item
     domain with duplicate items.


File: TheLogtalkHandbook-3.100.1.info,  Node: gaussian_mixture_clusterer,  Next: gaussian_process_regression,  Prev: frequent_pattern_mining_protocols,  Up: Libraries

6.66 ‘gaussian_mixture_clusterer’
=================================

Gaussian mixture model clusterer.  It uses deterministic
expectation-maximization with diagonal covariance matrices.  Supports
continuous attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, returning
Gaussian-mixture posterior component probabilities for new instances,
and exporting the learned clusterer as a list of predicate clauses or to
a file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<85>.
* Loading: Loading<86>.
* Testing: Testing<78>.
* Features: Features<19>.
* Gaussian-Mixture-Specific Prediction API::
* Options: Options<18>.
* Clusterer representation: Clusterer representation<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<85>,  Next: Loading<86>,  Up: gaussian_mixture_clusterer

6.66.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#gaussian_mixture_clusterer’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<86>,  Next: Testing<78>,  Prev: API documentation<85>,  Up: gaussian_mixture_clusterer

6.66.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(gaussian_mixture_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<78>,  Next: Features<19>,  Prev: Loading<86>,  Up: gaussian_mixture_clusterer

6.66.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(gaussian_mixture_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(gaussian_mixture_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<19>,  Next: Gaussian-Mixture-Specific Prediction API,  Prev: Testing<78>,  Up: gaussian_mixture_clusterer

6.66.4 Features
---------------

   - 'Expectation-Maximization': Learns diagonal Gaussian components
     using deterministic EM updates.

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Configurable Dead-Component Handling': Dead components can either
     be preserved with zero weight or deterministically reseeded to the
     least-confident training row.

   - 'Deterministic Initialization': Supports ‘first_k’ and
     deterministic ‘spread’ initialization for component means.  The
     ‘spread’ strategy uses a canonical first seed and canonical
     tie-breaking so equivalent row permutations produce the same
     initialization.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Posterior Prediction': New instances are assigned to the component
     with the highest posterior score, and ‘cluster_probabilities/3’ can
     return the full posterior distribution over components.

   - 'Training Diagnostics': Learned clusterers record convergence
     reason, iteration count, average log-likelihood, final delta, and
     effective options.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.


File: TheLogtalkHandbook-3.100.1.info,  Node: Gaussian-Mixture-Specific Prediction API,  Next: Options<18>,  Prev: Features<19>,  Up: gaussian_mixture_clusterer

6.66.5 Gaussian-Mixture-Specific Prediction API
-----------------------------------------------

In addition to the shared ‘cluster/3’ predicate from the clustering
protocols library, this package provides a Gaussian-mixture-specific
predicate:

   - ‘cluster_probabilities(Clusterer, Instance, Probabilities)’:
     Returns posterior component probabilities for ‘Instance’ as
     ‘Cluster-Probability’ pairs in component-id order.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<18>,  Next: Clusterer representation<3>,  Prev: Gaussian-Mixture-Specific Prediction API,  Up: gaussian_mixture_clusterer

6.66.6 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of mixture components.  Default is ‘2’.

   - ‘initialization(Initialization)’: Mean initialization strategy.
     Options: ‘spread’ (default) or ‘first_k’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.

   - ‘maximum_iterations(MaximumIterations)’: Maximum number of EM
     iterations.  Default is ‘100’.

   - ‘tolerance(Tolerance)’: Per-example average log-likelihood
     convergence tolerance.  Default is ‘0.0001’.

   - ‘covariance_regularization(Regularization)’: Positive diagonal
     covariance regularization constant.  Default is ‘0.001’.

   - ‘dead_component_policy(Policy)’: Handling for components whose
     total responsibility collapses below the dead-component threshold.
     Options: ‘zero_weight’ (default) keeps the previous component with
     zero weight; ‘reseed’ relocates the component to the
     least-confident training row and gives it one-example prior weight.


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<3>,  Prev: Options<18>,  Up: gaussian_mixture_clusterer

6.66.7 Clusterer representation
-------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 5.  For
example:

     gaussian_mixture_clusterer(Encoders, Components, Weights, Options, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Components’: List of ‘component(Mean, Variances)’ terms in
     component-id order.

   - ‘Weights’: List of mixture weights in component-id order.

   - ‘Options’: Effective training options used to learn the clusterer.

   - ‘Diagnostics’: Training diagnostics including convergence status,
     iteration count, average log-likelihood, final delta, and options.


File: TheLogtalkHandbook-3.100.1.info,  Node: gaussian_process_regression,  Next: genint,  Prev: gaussian_mixture_clusterer,  Up: Libraries

6.67 ‘gaussian_process_regression’
==================================

Gaussian process regression regressor supporting continuous and
mixed-feature datasets.  Uses exact Gaussian process regression with a
mixed covariance kernel: an automatic-relevance-determination
squared-exponential component over continuous encoded features and a
field-wise categorical overlap component over categorical attributes.
Hyperparameters are selected by maximizing the log marginal likelihood
using a deterministic coordinate search in log space.

The library implements the ‘regressor_protocol’ defined in the
‘regression_protocols’ library and learns an exact mixed gaussian
process using an automatic-relevance-determination squared-exponential
kernel for continuous encoded features together with a categorical
overlap kernel for categorical attributes.  Hyperparameters are selected
by maximizing the log marginal likelihood using a deterministic
coordinate search in log space.

* Menu:

* API documentation: API documentation<86>.
* Loading: Loading<87>.
* Testing: Testing<79>.
* Features: Features<20>.
* Regressor representation: Regressor representation<3>.
* Prediction API::
* Diagnostics syntax: Diagnostics syntax<7>.
* Options: Options<19>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<86>,  Next: Loading<87>,  Up: gaussian_process_regression

6.67.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#gaussian_process_regression’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<87>,  Next: Testing<79>,  Prev: API documentation<86>,  Up: gaussian_process_regression

6.67.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(gaussian_process_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<79>,  Next: Features<20>,  Prev: Loading<87>,  Up: gaussian_process_regression

6.67.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(gaussian_process_regression(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(gaussian_process_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<20>,  Next: Regressor representation<3>,  Prev: Testing<79>,  Up: gaussian_process_regression

6.67.4 Features
---------------

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes encoded using reference-level dummy coding.

   - 'Feature Scaling': Continuous attributes can be standardized using
     z-score scaling.

   - 'Missing Values': Missing numeric and categorical values are
     encoded using explicit missing-value indicator features.

   - 'Unknown Values': Prediction requests containing categorical values
     that are not declared by the dataset raise a domain error.

   - 'Exact Bayesian Regression': Uses exact Gaussian process regression
     with a mixed covariance kernel combining an
     automatic-relevance-determination squared-exponential component for
     continuous encoded features and a field-wise categorical overlap
     component for categorical attributes.

   - 'Automatic Hyperparameter Selection': By default performs
     deterministic log-marginal-likelihood optimization of the
     continuous-feature length scales, categorical mismatch penalties,
     signal variance, and noise variance.  The ‘length_scale/1’,
     ‘categorical_penalty/1’, ‘signal_variance/1’, and
     ‘noise_variance/1’ options also accept ‘auto’ when optimization is
     disabled.

   - 'Uncertainty Quantification': Exposes posterior predictive Gaussian
     distributions for new instances (including observation noise
     variance) using the ‘predict_distribution/3’ predicate.  Small
     negative posterior variances caused by floating-point roundoff are
     clipped to zero while larger negative values raise an error.

   - 'Adaptive Stabilization': Retries covariance factorization with
     progressively larger jitter values and records the effective retry
     count in the learned diagnostics.

   - 'Memory-Based Representation': Stores the encoded training rows and
     cached Cholesky factor required for exact posterior prediction plus
     the dual coefficients required for exact posterior prediction.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for representative
     regression datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<3>,  Next: Prediction API,  Prev: Features<20>,  Up: gaussian_process_regression

6.67.5 Regressor representation
-------------------------------

The learned regressor is represented by default as:

   - ‘gaussian_process_regressor(Encoders, TrainingFeatures, TargetMean,
     Alpha, CholeskyFactor, Kernel, Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(Encoders, TrainingFeatures, TargetMean, Alpha,
     CholeskyFactor, Kernel, Diagnostics)’

In this representation, ‘Encoders’ stores feature encoding metadata,
‘TrainingFeatures’ stores the encoded training rows, ‘TargetMean’ stores
the centered-mean offset, ‘Alpha’ stores the cached dual coefficients,
‘CholeskyFactor’ stores the lower-triangular covariance factor, ‘Kernel’
stores the learned mixed-kernel hyperparameters including one continuous
length scale per encoded continuous feature and one categorical penalty
per categorical attribute, and ‘Diagnostics’ stores training metadata
including the effective options and learned hyperparameters.


File: TheLogtalkHandbook-3.100.1.info,  Node: Prediction API,  Next: Diagnostics syntax<7>,  Prev: Regressor representation<3>,  Up: gaussian_process_regression

6.67.6 Prediction API
---------------------

The standard ‘predict/3’ predicate returns the posterior predictive
mean.

The ‘predict_distribution/3’ predicate returns a term with the form:

   - ‘gaussian(Mean, Variance)’

where ‘Variance’ is the posterior predictive variance for observed
targets, including the learned observation noise variance.  Tiny
negative values caused by floating-point roundoff are clipped to zero;
larger negative values raise a domain error.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<7>,  Next: Options<19>,  Prev: Prediction API,  Up: gaussian_process_regression

6.67.7 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(gaussian_process_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         kernel(squared_exponential),
         length_scales(LengthScales),
         categorical_penalties(CategoricalPenalties),
         signal_variance(SignalVariance),
         noise_variance(NoiseVariance),
         jitter(Jitter),
         continuous_feature_count(ContinuousFeatureCount),
         categorical_feature_count(CategoricalFeatureCount),
         jitter_attempts(JitterAttempts),
         log_marginal_likelihood(LogMarginalLikelihood),
         convergence(Convergence),
         iterations(Iterations),
         final_delta(FinalDelta),
         encoded_feature_count(FeatureCount)
     ]

Where:

   - ‘model(gaussian_process_regression)’ identifies the learning
     algorithm that produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘kernel(squared_exponential)’ records the covariance-kernel family
     used by the learned model.

   - ‘length_scales(LengthScales)’ stores the learned per-feature
     squared-exponential length scales for the continuous encoded
     feature dimensions.

   - ‘categorical_penalties(CategoricalPenalties)’ stores the learned
     mismatch penalties for the categorical attributes.

   - ‘signal_variance(SignalVariance)’ stores the learned latent-process
     marginal variance.

   - ‘noise_variance(NoiseVariance)’ stores the learned observation
     noise variance.

   - ‘jitter(Jitter)’ stores the effective diagonal jitter used to
     stabilize the covariance factorization.

   - ‘continuous_feature_count(ContinuousFeatureCount)’ stores the
     number of continuous encoded feature dimensions used by the
     squared-exponential kernel.

   - ‘categorical_feature_count(CategoricalFeatureCount)’ stores the
     number of categorical attributes handled by the overlap-kernel
     component.

   - ‘jitter_attempts(JitterAttempts)’ stores the number of adaptive
     jitter retries required by the final covariance factorization.

   - ‘log_marginal_likelihood(LogMarginalLikelihood)’ stores the final
     training log marginal likelihood.

   - ‘convergence(Convergence)’ records the hyperparameter-search stop
     reason.

   - ‘iterations(Iterations)’ stores the number of hyperparameter-search
     sweeps performed.

   - ‘final_delta(FinalDelta)’ stores the last log-marginal-likelihood
     improvement magnitude.

   - ‘encoded_feature_count(FeatureCount)’ stores the number of numeric
     features induced by the encoder list, including missing-value
     indicator features.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<19>,  Prev: Diagnostics syntax<7>,  Up: gaussian_process_regression

6.67.8 Options
--------------

The ‘learn/3’ predicate accepts the following options:

   - ‘kernel/1’: Kernel family.  The current accepted value is
     ‘squared_exponential’.  The default is ‘squared_exponential’.

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes before training and prediction.  Accepted values are
     ‘true’ and ‘false’.  The default is ‘true’.

   - ‘optimize_hyperparameters/1’: Controls deterministic
     log-marginal-likelihood optimization of the kernel hyperparameters.
     Accepted values are ‘true’ and ‘false’.  The default is ‘true’.

   - ‘length_scale/1’: Initial or fixed squared-exponential length-scale
     specification for the continuous encoded feature dimensions.
     Accepted values are ‘auto’, a positive float that is broadcast to
     every continuous encoded feature, or a list of positive floats with
     one value per continuous encoded feature.  The default is ‘auto’.

   - ‘categorical_penalty/1’: Initial or fixed categorical
     mismatch-penalty specification.  Accepted values are ‘auto’, a
     positive float that is broadcast to every categorical attribute, or
     a list of positive floats with one value per categorical attribute.
     The default is ‘auto’.

   - ‘signal_variance/1’: Initial or fixed latent-process variance.
     Accepted values are ‘auto’ or a positive float.  The default is
     ‘auto’.

   - ‘noise_variance/1’: Initial or fixed observation noise variance.
     Accepted values are ‘auto’ or a non-negative float.  The default is
     ‘auto’.

   - ‘jitter/1’: Positive diagonal stabilization jitter added to the
     covariance matrix before factorization.  When factorization fails,
     the implementation retries with progressively larger jitter values
     until it succeeds or exhausts the retry budget.  The default is
     ‘1.0e-8’.

   - ‘maximum_iterations/1’: Maximum number of hyperparameter-search
     sweeps when optimization is enabled.  The default is ‘12’.

   - ‘tolerance/1’: Minimum log-marginal-likelihood improvement floor
     required to continue hyperparameter optimization.  The default
     floor is ‘1.0e-6’.

   - ‘relative_improvement_factor/1’: Relative log-marginal-likelihood
     improvement factor used together with ‘tolerance/1’ to stop
     hyperparameter optimization when only numerically insignificant
     gains remain.  The default is ‘1.0e-4’.

   - ‘hyperparameter_minimum/1’: Lower bound used when proposing scaled
     hyperparameter candidates during coordinate search.  The default is
     ‘1.0e-6’.

   - ‘maximum_continuous_length_scale/1’: Upper bound used when
     proposing scaled continuous length-scale candidates during
     coordinate search.  The default is ‘32.0’.

   - ‘maximum_categorical_penalty/1’: Upper bound used when proposing
     scaled categorical mismatch-penalty candidates during coordinate
     search.  The default is ‘32.0’.

   - ‘max_factorization_attempts/1’: Maximum number of
     covariance-factorization retries performed with progressively
     increased jitter before training raises a positive-definiteness
     error.  The default is ‘32’.

   - ‘jitter_scale_factor/1’: Multiplicative factor used to increase the
     diagonal jitter on each covariance-factorization retry.  The
     default is ‘2.0’.


File: TheLogtalkHandbook-3.100.1.info,  Node: genint,  Next: gensym,  Prev: gaussian_process_regression,  Up: Libraries

6.68 ‘genint’
=============

The ‘genint’ library implements predicates for generating positive
integers in increasing order.  The public predicates are declared
synchronized to prevent race conditions when using a backend Prolog
compiler with multi-threading support.

* Menu:

* API documentation: API documentation<87>.
* Loading: Loading<88>.
* Testing: Testing<80>.
* Usage: Usage<37>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<87>,  Next: Loading<88>,  Up: genint

6.68.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#genint’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<88>,  Next: Testing<80>,  Prev: API documentation<87>,  Up: genint

6.68.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(genint(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<80>,  Next: Usage<37>,  Prev: Loading<88>,  Up: genint

6.68.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(genint(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<37>,  Prev: Testing<80>,  Up: genint

6.68.4 Usage
------------

The ‘genint_core’ category implements the library predicates.  This
category is imported by the default ‘genint’ object to provide
application global named counters.  To make the counters local and thus
minimize the potential for counter name clashes, the category can be
imported by one or more application objects.  Use protected or private
import to restrict the scope of the library predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: gensym,  Next: geojson,  Prev: genint,  Up: Libraries

6.69 ‘gensym’
=============

The ‘gensym’ library implements predicates for generating unique atoms.
The public predicates are declared synchronized to prevent race
conditions when using a backend Prolog compiler with multi-threading
support.

* Menu:

* API documentation: API documentation<88>.
* Loading: Loading<89>.
* Testing: Testing<81>.
* Usage: Usage<38>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<88>,  Next: Loading<89>,  Up: gensym

6.69.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#gensym’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<89>,  Next: Testing<81>,  Prev: API documentation<88>,  Up: gensym

6.69.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(gensym(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<81>,  Next: Usage<38>,  Prev: Loading<89>,  Up: gensym

6.69.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(gensym(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<38>,  Prev: Testing<81>,  Up: gensym

6.69.4 Usage
------------

The ‘gensym_core’ category implements the library predicates.  This
category is imported by the default ‘gensym’ object to provide
application global generators.  To make the generators local and thus
minimize the potential for generator name clashes, the category can be
imported by one or more application objects.  Use protected or private
import to restrict the scope of the library predicates.  For example:

     :- object(foo,
         imports(private::gensym_core)).

         bar :-
             ^^gensym(p, S),
             ...

     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: geojson,  Next: geospatial,  Prev: gensym,  Up: Libraries

6.70 ‘geojson’
==============

The ‘geojson’ library provides predicates for parsing, generating, and
validating GeoJSON documents as specified by RFC 7946:

   - ‘https://www.rfc-editor.org/rfc/rfc7946’

It builds on top of the ‘json’ library for JSON parsing and generation
and complements the ‘geospatial’ library by providing a standard
interchange format for geometry, features, and feature collections.

* Menu:

* API documentation: API documentation<89>.
* Loading: Loading<90>.
* Testing: Testing<82>.
* Representation: Representation<10>.
* Examples: Examples<168>.
* Notes: Notes<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<89>,  Next: Loading<90>,  Up: geojson

6.70.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#geojson’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<90>,  Next: Testing<82>,  Prev: API documentation<89>,  Up: geojson

6.70.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(geojson(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<82>,  Next: Representation<10>,  Prev: Loading<90>,  Up: geojson

6.70.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(geojson(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<10>,  Next: Examples<168>,  Prev: Testing<82>,  Up: geojson

6.70.4 Representation
---------------------

The library parses GeoJSON documents into native terms using the
following representation:

   - ‘point(Position)’ or ‘point(Position, Options)’

   - ‘multi_point(Positions)’ or ‘multi_point(Positions, Options)’

   - ‘line_string(Positions)’ or ‘line_string(Positions, Options)’

   - ‘multi_line_string(LineStrings)’ or ‘multi_line_string(LineStrings,
     Options)’

   - ‘polygon(Rings)’ or ‘polygon(Rings, Options)’

   - ‘multi_polygon(Polygons)’ or ‘multi_polygon(Polygons, Options)’

   - ‘geometry_collection(Geometries)’ or
     ‘geometry_collection(Geometries, Options)’

   - ‘feature(Geometry, Properties)’ or ‘feature(Geometry, Properties,
     Options)’

   - ‘feature_collection(Features)’ or ‘feature_collection(Features,
     Options)’

Positions follow the GeoJSON order and are represented as lists of
numbers, e.g.  ‘[Longitude, Latitude]’ or ‘[Longitude, Latitude,
Altitude]’.  Validation also checks longitude and latitude values
against the RFC 7946 geographic ranges.

The ‘Options’ lists may contain:

   - ‘bbox(BBox)’ for the optional bounding box member

   - ‘id(Id)’ for feature identifiers

   - ‘foreign_members(ForeignMembers)’ for additional non-reserved
     members, represented either as a list of pairs or as an embedded
     JSON object term using the selected object representation

Feature geometries and properties may be ‘@null’ to represent GeoJSON
‘null’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<168>,  Next: Notes<5>,  Prev: Representation<10>,  Up: geojson

6.70.5 Examples
---------------

Parse a point document:

     | ?- geojson::parse(atom('{"type":"Point","coordinates":[100.0,0.0]}'), GeoJSON).
     GeoJSON = point([100.0, 0.0])
     yes

Generate a GeoJSON feature collection:

     | ?- geojson::generate(atom(JSON), feature_collection([
         feature(point([102.0, 0.5]), {prop0-value0}),
         feature(@null, @null)
     ], [bbox([100.0, 0.0, 105.0, 1.0])])).

Validate a native GeoJSON term:

     | ?- geojson::validate(polygon([[[100.0,0.0],[101.0,0.0],[101.0,1.0],[100.0,1.0],[100.0,0.0]]])).

Inspect validation errors:

     | ?- geojson::validate(polygon([[[100.0,0.0],[101.0,0.0],[101.0,1.0],[100.0,1.0]]]), Errors).
     Errors = [ring_not_closed([coordinates,0])]
     yes

Convert between JSON terms and native GeoJSON terms:

     | ?- geojson::json_to_geojson({type-'Point', coordinates-[1,2]}, GeoJSON).
     GeoJSON = point([1,2])
     yes

     | ?- geojson::geojson_to_json(feature(@null, @null, [id(1)]), JSON).
     JSON = {type-'Feature', geometry-@null, properties-@null, id-1}
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<5>,  Prev: Examples<168>,  Up: geojson

6.70.6 Notes
------------

   - The library validates the RFC 7946 structural rules for geometry,
     features, feature collections, linear rings, bounding boxes, and
     prohibited ‘crs’ members.

   - Bounding boxes are represented as plain lists of numbers with
     either four or six elements.  Longitude values must stay within
     ‘[-180,180]’, latitude values within ‘[-90,90]’, south must not
     exceed north, and three-dimensional boxes also require minimum
     altitude not to exceed maximum altitude.  Bounding box
     dimensionality must match the represented geometry dimensionality,
     so two-dimensional geometries use four-element boxes while
     geometries with altitude use six-element boxes.  Mixed
     two-dimensional and three-dimensional geometry or feature
     collections are treated as three-dimensional for bounding-box
     validation.  Antimeridian-crossing boxes are accepted, so west may
     still be greater than east.

   - Parsing rejects duplicate reserved GeoJSON members instead of
     silently normalizing them.

   - Properties and foreign member values are recursively validated as
     JSON values compatible with the selected embedded object
     representation.

   - When using the ‘chars’ or ‘codes’ string representations, string
     terms are validated as proper character or character-code lists.

   - Foreign members are preserved but reserved GeoJSON member names are
     rejected when used as foreign member keys, regardless of whether
     the foreign members are supplied as pair lists or embedded object
     terms.

   - The ‘geojson/3’ parametric object mirrors the ‘json/3’
     customization parameters for embedded object, pair, and string
     representations.


File: TheLogtalkHandbook-3.100.1.info,  Node: geospatial,  Next: git,  Prev: geojson,  Up: Libraries

6.71 ‘geospatial’
=================

This library provides a ‘geospatial_protocol’ protocol and a
‘geospatial’ object for common geographic computations over coordinates
represented as ‘geographic(Latitude,Longitude)’.  By default, distances
are returned in kilometers.

* Menu:

* API documentation: API documentation<90>.
* Loading: Loading<91>.
* Testing: Testing<83>.
* Available predicates::
* Notes: Notes<6>.
* Usage: Usage<39>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<90>,  Next: Loading<91>,  Up: geospatial

6.71.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#geospatial’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<91>,  Next: Testing<83>,  Prev: API documentation<90>,  Up: geospatial

6.71.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(geospatial(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<83>,  Next: Available predicates,  Prev: Loading<91>,  Up: geospatial

6.71.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(geospatial(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Available predicates,  Next: Notes<6>,  Prev: Testing<83>,  Up: geospatial

6.71.4 Available predicates
---------------------------

The library currently includes predicates for:

   - Coordinate validation

   - Coordinate normalization

   - Point-to-point distances (‘haversine’ and ‘vincenty’)

   - Rhumb-line distance, bearing, and destination predicates

   - Rhumb-line interpolation and midpoint

   - Generic distance dispatch (‘distance/4’ and ‘distance/5’)

   - Initial and final bearings

   - Midpoint and destination point computations

   - Great-circle interpolation and track-distance

   - Proximity checks and nearest coordinate search

   - Mean center and coordinates bounding boxes

   - Minimum enclosing circle

   - Coordinates-to-bounding-box conversion

   - Equirectangular projection and inverse

   - Point-in-polygon checks

   - Polygon area, polygon centroid, and polygon bounding boxes

   - Polygon closure and orientation

   - Polygon orientation normalization

   - Polygon validity checks

   - Bounding-box utilities

   - Strict bounding-box overlap checks

   - Bounding-box and polygon/polyline relation

   - Nearest-point and point-to-polyline distance

   - Polyline length and polygon perimeter

   - Polyline simplification by tolerance

   - Polyline split and resampling

   - Polygon intersection checks

   - Spherical bounding boxes

   - Route distance accumulation (‘route_distance/2’,
     ‘route_distance/3’, and ‘route_distance/4’)

For explicit units, predicates ‘distance/5’ and ‘route_distance/4’
support ‘kilometers’, ‘meters’, ‘miles’, and ‘nautical_miles’.

Generic metric dispatch accepts ‘rhumb’ (and alias ‘loxodrome’) in
addition to existing spherical and ellipsoidal metrics.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<6>,  Next: Usage<39>,  Prev: Available predicates,  Up: geospatial

6.71.5 Notes
------------

The generic vector distance predicates already available in the ‘types’
library (notably in the ‘listp’ and ‘numberlistp’ protocols) remain the
recommended choice for non-geographic n-dimensional data.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<39>,  Prev: Notes<6>,  Up: geospatial

6.71.6 Usage
------------

Load the library:

     | ?- logtalk_load(geospatial(loader)).

Validate a coordinate:

     | ?- geospatial::valid_coordinate(geographic(38.7223, -9.1393)).

Normalize coordinates and convert to/from local planar coordinates:

     | ?- geospatial::normalize_coordinate(geographic(95.0, 10.0), Normalized).
     | ?- geospatial::equirectangular_projection(geographic(38.7223, -9.1393), 38.0, X, Y).
     | ?- geospatial::equirectangular_inverse(X, Y, 38.0, Coordinate).

Compute default distance in kilometers (Haversine):

     | ?- geospatial::distance(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), haversine, Distance).
     | ?- geospatial::rhumb_distance(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), Distance).
     | ?- geospatial::rhumb_bearing(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), Bearing).
     | ?- geospatial::rhumb_destination_point(geographic(38.7223, -9.1393), 45.0, 50.0, Destination).
     | ?- geospatial::interpolate_rhumb(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), 0.5, Intermediate).
     | ?- geospatial::rhumb_midpoint(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), Midpoint).

Compute distance with explicit unit (‘meters’, ‘miles’, or
‘nautical_miles’):

     | ?- geospatial::distance(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), vincenty, miles, Distance).

Compute route distance using the default metric (‘haversine’) in
kilometers:

     | ?- geospatial::route_distance([geographic(38.7223, -9.1393), geographic(39.7440, -8.8070), geographic(41.1579, -8.6291)], Distance).

Compute route distance with explicit metric and unit:

     | ?- geospatial::route_distance([geographic(38.7223, -9.1393), geographic(39.7440, -8.8070), geographic(41.1579, -8.6291)], vincenty, nautical_miles, Distance).

Compute midpoint and destination point:

     | ?- geospatial::midpoint(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), Midpoint).
     | ?- geospatial::destination_point(geographic(38.7223, -9.1393), 45.0, 50.0, Destination).
     | ?- geospatial::interpolate_great_circle(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), 0.5, Intermediate).
     | ?- geospatial::cross_track_distance(geographic(40.0, -9.0), geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), CrossTrackKm).
     | ?- geospatial::along_track_distance(geographic(40.0, -9.0), geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), AlongTrackKm).

Compute final bearing and proximity checks:

     | ?- geospatial::final_bearing(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), Bearing).
     | ?- geospatial::within_distance(geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), 300.0, haversine).

Find the nearest coordinate from a list:

     | ?- geospatial::nearest_coordinate(geographic(38.7223, -9.1393), [geographic(37.7749, -122.4194), geographic(41.1579, -8.6291), geographic(40.4168, -3.7038)], vincenty, Nearest, Distance).

Compute center and coordinate-list bounding boxes:

     | ?- geospatial::mean_center([geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), geographic(40.4168, -3.7038)], Center).
     | ?- geospatial::minimum_enclosing_circle([geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), geographic(40.4168, -3.7038)], Center, Radius).
     | ?- geospatial::coordinates_bounding_box([geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), geographic(40.4168, -3.7038)], BoundingBox).
     | ?- geospatial::bbox_from_coordinates([geographic(38.7223, -9.1393), geographic(41.1579, -8.6291), geographic(40.4168, -3.7038)], BoundingBox).

Work with polygons:

     | ?- geospatial::point_in_polygon(geographic(0.5, 0.5), [geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(1.0, 1.0), geographic(1.0, 0.0)]).
     | ?- geospatial::polygon_area([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(1.0, 1.0), geographic(1.0, 0.0)], Area).
     | ?- geospatial::polygon_centroid([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(1.0, 1.0), geographic(1.0, 0.0)], Centroid).
     | ?- geospatial::polygon_bounding_box([geographic(1.0, -2.0), geographic(0.0, 1.0), geographic(-1.0, -1.0)], BoundingBox).
     | ?- geospatial::close_polygon([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(1.0, 0.0)], ClosedPolygon).
     | ?- geospatial::polygon_orientation([geographic(0.0, 0.0), geographic(1.0, 0.0), geographic(1.0, 1.0), geographic(0.0, 1.0)], Orientation).
     | ?- geospatial::is_clockwise_polygon([geographic(0.0, 0.0), geographic(1.0, 0.0), geographic(1.0, 1.0), geographic(0.0, 1.0)]).
     | ?- geospatial::normalize_polygon_orientation([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(1.0, 1.0), geographic(1.0, 0.0)], clockwise, Oriented).
     | ?- geospatial::clockwise_polygon([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(1.0, 1.0), geographic(1.0, 0.0)], Clockwise).
     | ?- geospatial::counterclockwise_polygon([geographic(0.0, 0.0), geographic(1.0, 0.0), geographic(1.0, 1.0), geographic(0.0, 1.0)], Counterclockwise).
     | ?- geospatial::is_valid_polygon([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(1.0, 0.0)]).

Work with bounding boxes:

     | ?- geospatial::bbox_contains(bbox(geographic(-1.0, -1.0), geographic(1.0, 1.0)), geographic(0.5, 0.5)).
     | ?- geospatial::bbox_contains(bbox(geographic(-1.0, 170.0), geographic(1.0, -170.0)), bbox(geographic(-0.5, 175.0), geographic(0.5, -175.0))).
     | ?- geospatial::bbox_intersects(bbox(geographic(0.0, 0.0), geographic(1.0, 1.0)), bbox(geographic(0.5, 0.5), geographic(2.0, 2.0))).
     | ?- geospatial::bbox_overlaps(bbox(geographic(0.0, 0.0), geographic(1.0, 1.0)), bbox(geographic(0.5, 0.5), geographic(2.0, 2.0))).
     | ?- geospatial::bbox_intersects_polygon(bbox(geographic(0.0, 0.0), geographic(1.0, 1.0)), [geographic(0.5, 0.5), geographic(0.5, 1.5), geographic(1.5, 1.5), geographic(1.5, 0.5)]).
     | ?- geospatial::bbox_contains_polygon(bbox(geographic(0.0, 0.0), geographic(2.0, 2.0)), [geographic(0.5, 0.5), geographic(0.5, 1.5), geographic(1.5, 1.5), geographic(1.5, 0.5)]).
     | ?- geospatial::bbox_intersects_polyline(bbox(geographic(0.0, 0.0), geographic(1.0, 1.0)), [geographic(-1.0, 0.5), geographic(2.0, 0.5)]).
     | ?- geospatial::bbox_union(bbox(geographic(0.0, 0.0), geographic(1.0, 1.0)), bbox(geographic(-1.0, 0.5), geographic(0.5, 2.0)), BoundingBox).
     | ?- geospatial::bbox_expand(bbox(geographic(0.0, 0.0), geographic(0.0, 0.0)), 111.195, ExpandedBoundingBox).

Compute nearest points and distances to paths:

     | ?- geospatial::nearest_point_on_segment(geographic(1.0, 1.0), geographic(0.0, 0.0), geographic(0.0, 2.0), Nearest).
     | ?- geospatial::nearest_point_on_polyline(geographic(1.0, 1.0), [geographic(0.0, 0.0), geographic(0.0, 2.0), geographic(2.0, 2.0)], Nearest, Distance).
     | ?- geospatial::point_to_polyline_distance(geographic(1.0, 1.0), [geographic(0.0, 0.0), geographic(0.0, 2.0)], Distance).

Compute polyline and polygon lengths:

     | ?- geospatial::polyline_length([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(0.0, 2.0)], Length).
     | ?- geospatial::polyline_length([geographic(0.0, 0.0), geographic(0.0, 1.0)], vincenty, Length).
     | ?- geospatial::polyline_simplify([geographic(0.0, 0.0), geographic(0.5, 0.1), geographic(1.0, 0.0)], 20.0, Simplified).
     | ?- geospatial::polyline_split_at_distance([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(0.0, 2.0)], 111.195, Left, Right).
     | ?- geospatial::polyline_resample([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(0.0, 2.0)], 50.0, Resampled).
     | ?- geospatial::polygon_perimeter([geographic(0.0, 0.0), geographic(0.0, 1.0), geographic(1.0, 1.0), geographic(1.0, 0.0)], Perimeter).

Check polygon intersections:

     | ?- geospatial::polygons_intersect([geographic(0.0, 0.0), geographic(0.0, 2.0), geographic(2.0, 2.0), geographic(2.0, 0.0)], [geographic(1.0, 1.0), geographic(1.0, 3.0), geographic(3.0, 3.0), geographic(3.0, 1.0)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: git,  Next: glicko2_ranker,  Prev: geospatial,  Up: Libraries

6.72 ‘git’
==========

This library provides access to a git project current branch and latest
commit data (e.g., commit hash).  Support for using this library on
Windows operating-systems is experimental and may or may not work
depending on the used Prolog backend.

* Menu:

* API documentation: API documentation<91>.
* Loading: Loading<92>.
* Testing: Testing<84>.
* Usage: Usage<40>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<91>,  Next: Loading<92>,  Up: git

6.72.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#git’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<92>,  Next: Testing<84>,  Prev: API documentation<91>,  Up: git

6.72.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(git(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<84>,  Next: Usage<40>,  Prev: Loading<92>,  Up: git

6.72.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(git(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<40>,  Prev: Testing<84>,  Up: git

6.72.4 Usage
------------

All predicates take as first argument a directory, which should be
either a git repository directory or a sub-directory of a git repository
directory.  The main predicate is ‘commit_log/3’.  It provides access to
the ‘git log’ command when called with the ‘--oneline -n 1
--pretty=format:’ options.  By passing as second argument the desired
format, it returns an atom with the formatted output.  For example:

     | ?- git::commit_log('/Users/pmoura/logtalk3', '%h%n%B', Output),
          write(Output), nl.

     eccaa1a2a
     Update SVG diagrams

     Output = 'eccaa1a2a\nUpdate SVG diagrams\n'
     yes

See e.g.  the official documentation on ‘git log’ pretty formats for
details:

‘https://git-scm.com/docs/pretty-formats’

Convenient predicates are also provided for commonly used formats such
as the commit author and the commit hash.  For example:

     | ?- git::commit_author('/Users/pmoura/Documents/Logtalk/logtalk3', Author).

     Author = 'Paulo Moura'
     yes

     | ?- git::commit_hash('/Users/pmoura/Documents/Logtalk/logtalk3', Hash).

     Hash = eccaa1a2a9495fef441915bbace84e0a4b0394a2
     yes

It’s also possible to get the name of the current local branch.  For
example:

     | ?- git::branch('/Users/pmoura/Documents/Logtalk/logtalk3', Branch).

     Branch = master
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: glicko2_ranker,  Next: glicko2_periodic_ranker,  Prev: git,  Up: Libraries

6.73 ‘glicko2_ranker’
=====================

Glicko-2 pairwise preference ranker.  It applies the standard Glicko-2
rating, rating-deviation, and volatility update equations over a single
synthetic rating period built from the aggregated pairwise outcomes of
the dataset.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The current implementation requires a well-formed connected
pairwise dataset so that learned ratings remain globally comparable
across all ranked items.

* Menu:

* API documentation: API documentation<92>.
* Loading: Loading<93>.
* Testing: Testing<85>.
* Features: Features<21>.
* Rating semantics: Rating semantics<2>.
* Usage: Usage<41>.
* Options: Options<20>.
* Diagnostics syntax: Diagnostics syntax<8>.
* Ranker representation: Ranker representation<6>.
* References: References<13>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<92>,  Next: Loading<93>,  Up: glicko2_ranker

6.73.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#glicko2_ranker’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<93>,  Next: Testing<85>,  Prev: API documentation<92>,  Up: glicko2_ranker

6.73.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(glicko2_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<85>,  Next: Features<21>,  Prev: Loading<93>,  Up: glicko2_ranker

6.73.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(glicko2_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<21>,  Next: Rating semantics<2>,  Prev: Testing<85>,  Up: glicko2_ranker

6.73.4 Features
---------------

   - 'Pairwise Preference Learning': Learns one deterministic rating per
     item from pairwise outcomes.

   - 'Deterministic Single-Period Glicko-2 Semantics': Applies the
     standard Glicko-2 rating-period update equations over one synthetic
     rating period built from the aggregated pairwise results.

   - 'Configurable Rating Parameters': Exposes the initial rating,
     initial rating deviation, initial volatility, volatility constraint
     parameter, and volatility-solver tolerance as user options.

   - 'Integer Weight Fidelity': Preference weights must be positive
     integers and are interpreted as repeated unit outcomes inside the
     same rating period.

   - 'Deterministic Ranking': Orders candidate items by learned rating
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     comparison graphs.

   - 'Extended Diagnostics': Preserves per-item rating deviations and
     volatilities in the learned ranker diagnostics.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Ranking Infrastructure': Reuses the ‘ranking_protocols’
     helpers for option processing, dataset validation, diagnostics
     access, export, and candidate ranking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Rating semantics<2>,  Next: Usage<41>,  Prev: Features<21>,  Up: glicko2_ranker

6.73.5 Rating semantics
-----------------------

This implementation uses a deterministic batch interpretation of
Glicko-2.  The whole dataset is treated as a single synthetic rating
period because the current pairwise dataset protocol does not encode
timestamps or rating-period boundaries.

The implementation converts ratings and rating deviations to the
internal Glicko-2 scale, applies the standard opponent-scaling factor
‘g(phi)’, expected-score function, variance term ‘v’, improvement
estimate ‘delta’, and volatility update iteration, and then converts the
updated ratings and deviations back to the conventional Glicko scale.

Positive integer preference weights are replayed as repeated unit
outcomes.  Datasets using non-integer preference weights are rejected
because they do not map cleanly to standard Glicko-2 update semantics.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<41>,  Next: Options<20>,  Prev: Rating semantics<2>,  Up: glicko2_ranker

6.73.6 Usage
------------

* Menu:

* Learning a ranker: Learning a ranker<6>.
* Inspecting diagnostics: Inspecting diagnostics<6>.
* Ranking candidate items: Ranking candidate items<6>.
* Exporting the ranker: Exporting the ranker<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<6>,  Next: Inspecting diagnostics<6>,  Up: Usage<41>

6.73.6.1 Learning a ranker
..........................

     % Learn from a pairwise ranking dataset object
     | ?- glicko2_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with custom Glicko-2 parameters
     | ?- glicko2_ranker::learn(my_dataset, Ranker, [initial_rating(1400.0), initial_deviation(300.0), initial_volatility(0.07), tau(0.4)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<6>,  Next: Ranking candidate items<6>,  Prev: Learning a ranker<6>,  Up: Usage<41>

6.73.6.2 Inspecting diagnostics
...............................

     % Inspect model, options, deviations, volatilities, and dataset metadata
     | ?- glicko2_ranker::learn(my_dataset, Ranker),
          glicko2_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<6>,  Next: Exporting the ranker<6>,  Prev: Inspecting diagnostics<6>,  Up: Usage<41>

6.73.6.3 Ranking candidate items
................................

     % Rank a candidate set from most preferred to least preferred
     | ?- glicko2_ranker::learn(my_dataset, Ranker),
          glicko2_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<6>,  Prev: Ranking candidate items<6>,  Up: Usage<41>

6.73.6.4 Exporting the ranker
.............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- glicko2_ranker::learn(my_dataset, Ranker),
          glicko2_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(glicko2_ranker(...))]
     ...

     % Export to a file
     | ?- glicko2_ranker::learn(my_dataset, Ranker),
          glicko2_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<20>,  Next: Diagnostics syntax<8>,  Prev: Usage<41>,  Up: glicko2_ranker

6.73.7 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘initial_rating(Rating)’: Initial rating assigned to every item.

   - ‘initial_deviation(Deviation)’: Initial rating deviation assigned
     to every item.

   - ‘initial_volatility(Volatility)’: Initial volatility assigned to
     every item.

   - ‘tau(Tau)’: Positive volatility-constraint parameter used by the
     Glicko-2 update.

   - ‘volatility_tolerance(Tolerance)’: Positive stopping tolerance used
     by the volatility root-finding iteration.

Datasets supplied to the ranker must use positive integer preference
weights.  Non-integer weights are rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<8>,  Next: Ranker representation<6>,  Prev: Options<20>,  Up: glicko2_ranker

6.73.8 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(glicko2_ranker),
         options(Options),
         rating_deviations(Deviations),
         volatilities(Volatilities),
         dataset_summary(DatasetSummary)
     ]


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<6>,  Next: References<13>,  Prev: Diagnostics syntax<8>,  Up: glicko2_ranker

6.73.9 Ranker representation
----------------------------

The learned ranker is represented by a compound term of the form:

     glicko2_ranker(Items, Ratings, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Ratings’: List of ‘Item-Rating’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, per-item rating deviations, per-item volatilities, and
     dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<13>,  Prev: Ranker representation<6>,  Up: glicko2_ranker

6.73.10 References
------------------

  1. Glickman, M. E. (2012).  'Example of the Glicko-2 system'.


File: TheLogtalkHandbook-3.100.1.info,  Node: glicko2_periodic_ranker,  Next: gradient_boosting_classifier,  Prev: glicko2_ranker,  Up: Libraries

6.74 ‘glicko2_periodic_ranker’
==============================

Multi-period Glicko-2 ranker over temporal pairwise game datasets.
Applies the standard Glicko-2 rating, rating-deviation, and volatility
update equations period by period using simultaneous player updates
inside each declared rating period.

This library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It learns one rating per item from
datasets implementing the ‘temporal_pairwise_ranking_dataset_protocol’
protocol, processing declared rating periods in order and applying
simultaneous Glicko-2 player updates inside each period using the
standard Glicko-2 rating, rating-deviation, and volatility update
equations.

Draws are represented directly using game scores on the set ‘{0.0, 0.5,
1.0}’.  Players who are inactive in a declared period keep their rating
and volatility while their rating deviation is inflated for that period.

Players are initialized when they first play instead of being forced to
appear in the first declared period.

The library provides predicates for learning a ranker from temporal
pairwise games, using it to order candidate items, and exporting it as a
list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘temporal_pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.

* Menu:

* API documentation: API documentation<93>.
* Loading: Loading<94>.
* Testing: Testing<86>.
* Features: Features<22>.
* Rating semantics: Rating semantics<3>.
* Usage: Usage<42>.
* Options: Options<21>.
* Diagnostics syntax: Diagnostics syntax<9>.
* Ranker representation: Ranker representation<7>.
* References: References<14>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<93>,  Next: Loading<94>,  Up: glicko2_periodic_ranker

6.74.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#glicko2_periodic_ranker’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<94>,  Next: Testing<86>,  Prev: API documentation<93>,  Up: glicko2_periodic_ranker

6.74.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(glicko2_periodic_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<86>,  Next: Features<22>,  Prev: Loading<94>,  Up: glicko2_periodic_ranker

6.74.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(glicko2_periodic_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<22>,  Next: Rating semantics<3>,  Prev: Testing<86>,  Up: glicko2_periodic_ranker

6.74.4 Features
---------------

   - 'Temporal Pairwise Game Learning': Learns one deterministic rating
     per item from temporal pairwise game results.

   - 'Deterministic Multi-Period Glicko-2 Semantics': Processes the
     declared rating periods in order and applies simultaneous Glicko-2
     player updates within each period.

   - 'Direct Draw Support': Uses explicit game scores on the set ‘{0.0,
     0.5, 1.0}’, allowing wins, draws, and losses to be represented
     directly.

   - 'Inactive-Period Deviation Inflation': Players who do not play in a
     declared period keep their rating and volatility while their rating
     deviation is inflated for that period.

   - 'Late Player Initialization': Players are initialized when they
     first appear in the dataset instead of being forced to play in the
     first declared period.

   - 'Configurable Rating Parameters': Exposes the initial rating,
     initial rating deviation, initial volatility, volatility constraint
     parameter, and volatility-solver tolerance as user options.

   - 'Deterministic Ranking': Orders candidate items by learned rating
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate periods, unknown
     periods, undeclared items, self-games, illegal scores, and
     disconnected comparison graphs.

   - 'Extended Diagnostics': Preserves per-item rating deviations,
     volatilities, processed period count, and final period metadata in
     the learned ranker diagnostics.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Ranking Infrastructure': Reuses the ‘ranking_protocols’
     helpers for option processing, dataset validation, diagnostics
     access, export, and candidate ranking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Rating semantics<3>,  Next: Usage<42>,  Prev: Features<22>,  Up: glicko2_periodic_ranker

6.74.5 Rating semantics
-----------------------

This implementation uses the standard Glicko-2 update equations over
explicit rating periods supplied by the dataset.  The declared periods
are processed in order, and all active players in a period are updated
simultaneously from the pre-period ratings, deviations, and
volatilities.

Game results are represented directly using scores in the set ‘{0.0,
0.5, 1.0}’.  A score of ‘0.5’ denotes a draw.  Players who are inactive
in a period keep their rating and volatility, but their rating deviation
is inflated for that period according to the Glicko-2 inactivity rule.

Players are initialized when they first appear in a game rather than
being required to occur in the first declared period.  Items declared by
the dataset but never seen in a game are initialized after training so
they remain present in the learned ranker with the configured initial
parameters.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<42>,  Next: Options<21>,  Prev: Rating semantics<3>,  Up: glicko2_periodic_ranker

6.74.6 Usage
------------

* Menu:

* Learning a ranker: Learning a ranker<7>.
* Inspecting diagnostics: Inspecting diagnostics<7>.
* Ranking candidate items: Ranking candidate items<7>.
* Exporting the ranker: Exporting the ranker<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<7>,  Next: Inspecting diagnostics<7>,  Up: Usage<42>

6.74.6.1 Learning a ranker
..........................

     % Learn from a temporal pairwise ranking dataset object
     | ?- glicko2_periodic_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with custom Glicko-2 parameters
     | ?- glicko2_periodic_ranker::learn(my_dataset, Ranker, [initial_rating(1400.0), initial_deviation(300.0), initial_volatility(0.07), tau(0.4)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<7>,  Next: Ranking candidate items<7>,  Prev: Learning a ranker<7>,  Up: Usage<42>

6.74.6.2 Inspecting diagnostics
...............................

     % Inspect model, options, deviations, volatilities, and period metadata
     | ?- glicko2_periodic_ranker::learn(my_dataset, Ranker),
          glicko2_periodic_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<7>,  Next: Exporting the ranker<7>,  Prev: Inspecting diagnostics<7>,  Up: Usage<42>

6.74.6.3 Ranking candidate items
................................

     % Rank a candidate set from most preferred to least preferred
     | ?- glicko2_periodic_ranker::learn(my_dataset, Ranker),
          glicko2_periodic_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<7>,  Prev: Ranking candidate items<7>,  Up: Usage<42>

6.74.6.4 Exporting the ranker
.............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- glicko2_periodic_ranker::learn(my_dataset, Ranker),
          glicko2_periodic_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(glicko2_periodic_ranker(...))]
     ...

     % Export to a file
     | ?- glicko2_periodic_ranker::learn(my_dataset, Ranker),
          glicko2_periodic_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<21>,  Next: Diagnostics syntax<9>,  Prev: Usage<42>,  Up: glicko2_periodic_ranker

6.74.7 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘initial_rating(Rating)’: Initial rating assigned to a player when
     it is first initialized.

   - ‘initial_deviation(Deviation)’: Initial rating deviation assigned
     to a player when it is first initialized.

   - ‘initial_volatility(Volatility)’: Initial volatility assigned to a
     player when it is first initialized.

   - ‘tau(Tau)’: Positive volatility-constraint parameter used by the
     Glicko-2 update.

   - ‘volatility_tolerance(Tolerance)’: Positive stopping tolerance used
     by the volatility root-finding iteration.

Datasets supplied to the ranker must use legal game scores from the set
‘{0.0, 0.5, 1.0}’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<9>,  Next: Ranker representation<7>,  Prev: Options<21>,  Up: glicko2_periodic_ranker

6.74.8 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(glicko2_periodic_ranker),
         options(Options),
         rating_deviations(Deviations),
         volatilities(Volatilities),
         periods_processed(PeriodsProcessed),
         final_period(FinalPeriod),
         dataset_summary(DatasetSummary)
     ]


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<7>,  Next: References<14>,  Prev: Diagnostics syntax<9>,  Up: glicko2_periodic_ranker

6.74.9 Ranker representation
----------------------------

The learned ranker is represented by a compound term of the form:

     glicko2_periodic_ranker(Items, Ratings, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Ratings’: List of ‘Item-Rating’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, per-item rating deviations, per-item volatilities,
     processed period count, final period, and dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<14>,  Prev: Ranker representation<7>,  Up: glicko2_periodic_ranker

6.74.10 References
------------------

  1. Glickman, M. E. (2012).  'Example of the Glicko-2 system'.


File: TheLogtalkHandbook-3.100.1.info,  Node: gradient_boosting_classifier,  Next: gradient_boosting_regression,  Prev: glicko2_periodic_ranker,  Up: Libraries

6.75 ‘gradient_boosting_classifier’
===================================

Gradient boosting classifier for tabular datasets using multinomial
additive models fitted by regression trees to softmax residuals.  At
each boosting stage the implementation fits one regression tree per
class and updates additive class scores using the configured learning
rate.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset, using it to make predictions, estimating
class probabilities, and exporting it as a list of predicate clauses or
to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  Continuous,
categorical, and mixed-feature datasets are supported through the reused
‘regression_tree’ backend.

* Menu:

* API documentation: API documentation<94>.
* Loading: Loading<95>.
* Testing: Testing<87>.
* Features: Features<23>.
* Options: Options<22>.
* Usage: Usage<43>.
* Classifier representation: Classifier representation<2>.
* References: References<15>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<94>,  Next: Loading<95>,  Up: gradient_boosting_classifier

6.75.1 API documentation
------------------------

Open the ‘../../docs/library_index.html#gradient_boosting_classifier’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<95>,  Next: Testing<87>,  Prev: API documentation<94>,  Up: gradient_boosting_classifier

6.75.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(gradient_boosting_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<87>,  Next: Features<23>,  Prev: Loading<95>,  Up: gradient_boosting_classifier

6.75.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(gradient_boosting_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<23>,  Next: Options<22>,  Prev: Testing<87>,  Up: gradient_boosting_classifier

6.75.4 Features
---------------

   - 'Multiclass Boosting': Fits one additive score function per class
     and predicts using the highest boosted score.

   - 'Regression Tree Backend': Reuses the ‘regression_tree’ library to
     fit residual models at each boosting stage.

   - 'Probability Estimation': Provides class probabilities using a
     softmax over the final additive scores.

   - 'Configurable Tree Complexity': Exposes boosting-stage tree depth,
     minimum leaf size, and minimum variance reduction options.

   - 'Tabular Datasets': Supports continuous, categorical, and
     mixed-feature datasets.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<22>,  Next: Usage<43>,  Prev: Features<23>,  Up: gradient_boosting_classifier

6.75.5 Options
--------------

The ‘learn/3’ predicate supports these options:

   - ‘number_of_estimators/1’ - number of boosting stages to fit
     (default: ‘25’)

   - ‘learning_rate/1’ - shrinkage factor applied to each stage
     prediction (default: ‘0.1’)

   - ‘maximum_depth/1’ - maximum depth of each regression tree (default:
     ‘3’)

   - ‘minimum_samples_leaf/1’ - minimum number of examples in a leaf
     (default: ‘1’)

   - ‘minimum_variance_reduction/1’ - minimum variance reduction
     required for a split (default: ‘0.0’)

   - ‘feature_scaling/1’ - whether to scale continuous features in the
     regression-tree backend (default: ‘false’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<43>,  Next: Classifier representation<2>,  Prev: Options<22>,  Up: gradient_boosting_classifier

6.75.6 Usage
------------

* Menu:

* Learning a classifier::
* Making predictions::
* Exporting the classifier::


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a classifier,  Next: Making predictions,  Up: Usage<43>

6.75.6.1 Learning a classifier
..............................

     | ?- gradient_boosting_classifier::learn(weather, Classifier).

     | ?- gradient_boosting_classifier::learn(iris_small, Classifier, [number_of_estimators(50), learning_rate(0.05)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Making predictions,  Next: Exporting the classifier,  Prev: Learning a classifier,  Up: Usage<43>

6.75.6.2 Making predictions
...........................

     | ?- gradient_boosting_classifier::learn(weather, Classifier),
          gradient_boosting_classifier::predict(Classifier, [outlook-overcast, temperature-mild, humidity-high, windy-false], Class).

     | ?- gradient_boosting_classifier::learn(mixed, Classifier),
          gradient_boosting_classifier::predict_probabilities(Classifier, [age-40, income-60000, student-yes, credit_rating-fair], Probabilities).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the classifier,  Prev: Making predictions,  Up: Usage<43>

6.75.6.3 Exporting the classifier
.................................

     | ?- gradient_boosting_classifier::learn(weather, Classifier),
          gradient_boosting_classifier::export_to_clauses(weather, Classifier, classify, Clauses).

     | ?- gradient_boosting_classifier::learn(weather, Classifier),
          gradient_boosting_classifier::export_to_file(weather, Classifier, classify, 'classifier.pl').


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<2>,  Next: References<15>,  Prev: Usage<43>,  Up: gradient_boosting_classifier

6.75.7 Classifier representation
--------------------------------

The learned classifier is represented as a compound term with the form:

     gradient_boosting_classifier(Classes, InitialScores, StageTrees, Options)

Where:

   - ‘Classes’: list of class labels

   - ‘InitialScores’: list of initial log-prior scores, one per class

   - ‘StageTrees’: list of ‘stage_trees(ClassTrees)’ terms, where each
     ‘ClassTrees’ value contains ‘class_tree(Class, LearningRate, Tree)’
     terms

   - ‘Options’: merged training options used to learn the classifier

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<15>,  Prev: Classifier representation<2>,  Up: gradient_boosting_classifier

6.75.8 References
-----------------

  1. Friedman, J.H. (2001).  “Greedy Function Approximation: A Gradient
     Boosting Machine”.

  2. Hastie, T., Tibshirani, R. and Friedman, J. (2009).  “The Elements
     of Statistical Learning”.  Chapter 10.

  3. Bishop, C.M. (2006).  “Pattern Recognition and Machine Learning”.
     Section 14.4.


File: TheLogtalkHandbook-3.100.1.info,  Node: gradient_boosting_regression,  Next: grammars,  Prev: gradient_boosting_classifier,  Up: Libraries

6.76 ‘gradient_boosting_regression’
===================================

Gradient boosting regression supporting continuous and mixed-feature
datasets.  Builds an additive ensemble of regression trees by repeatedly
fitting the current residuals under squared-error loss.  Starts from the
arithmetic mean of the training targets and then adds a scaled tree
prediction at each boosting stage.

The library implements the ‘regressor_protocol’ defined in the
‘regression_protocols’ library and learns an additive ensemble of
regression trees by repeatedly fitting the current residuals under
squared-error loss.

* Menu:

* API documentation: API documentation<95>.
* Loading: Loading<96>.
* Testing: Testing<88>.
* Features: Features<24>.
* Regressor representation: Regressor representation<4>.
* Diagnostics syntax: Diagnostics syntax<10>.
* Options: Options<23>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<95>,  Next: Loading<96>,  Up: gradient_boosting_regression

6.76.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#gradient_boosting_regression’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<96>,  Next: Testing<88>,  Prev: API documentation<95>,  Up: gradient_boosting_regression

6.76.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(gradient_boosting_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<88>,  Next: Features<24>,  Prev: Loading<96>,  Up: gradient_boosting_regression

6.76.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(gradient_boosting_regression(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(gradient_boosting_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<24>,  Next: Regressor representation<4>,  Prev: Testing<88>,  Up: gradient_boosting_regression

6.76.4 Features
---------------

   - 'Residual Fitting': Fits each regression tree to the residuals of
     the current additive model under squared-error loss.

   - 'Shrinkage': Supports a fixed learning rate to scale stage
     contributions and reduce overfitting.

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes encoded by the underlying regression-tree
     learner.

   - 'Tree Configuration': Exposes the underlying regression-tree depth,
     minimum-leaf, variance-reduction, and scaling options.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, initial prediction, fitted stage
     count, and effective options, accessible using the shared
     regression diagnostics predicates.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for representative
     regression datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<4>,  Next: Diagnostics syntax<10>,  Prev: Features<24>,  Up: gradient_boosting_regression

6.76.5 Regressor representation
-------------------------------

The learned regressor is represented by default as:

   - ‘gradient_boosting_regressor(InitialPrediction, WeightedTrees,
     Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(InitialPrediction, WeightedTrees, Diagnostics)’

In this representation, ‘WeightedTrees’ contains
‘weighted_tree(LearningRate, Tree)’ terms and ‘Diagnostics’ stores
training metadata including the effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<10>,  Next: Options<23>,  Prev: Regressor representation<4>,  Up: gradient_boosting_regression

6.76.6 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(gradient_boosting_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         initial_prediction(InitialPrediction),
         stage_count(StageCount)
     ]

Where:

   - ‘model(gradient_boosting_regression)’ identifies the learning
     algorithm that produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘initial_prediction(InitialPrediction)’ stores the constant
     prediction used to initialize the additive model before fitting any
     trees.

   - ‘stage_count(StageCount)’ stores the number of boosting stages that
     were actually fitted.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<23>,  Prev: Diagnostics syntax<10>,  Up: gradient_boosting_regression

6.76.7 Options
--------------

The ‘learn/3’ predicate accepts the following options:

   - ‘number_of_estimators/1’: Maximum number of boosting stages to fit.
     Each stage adds one regression tree to the ensemble.  The default
     is ‘50’.  Training can stop before reaching this limit when the
     residual sum of squares becomes negligible.

   - ‘learning_rate/1’: Shrinkage factor applied to each stage
     prediction before it is added to the current model.  Smaller values
     usually require more stages but can improve generalization.  The
     default is ‘0.1’.

   - ‘maximum_depth/1’: Maximum depth allowed for each regression tree
     used as a base learner.  Lower values produce weaker, simpler
     trees; higher values allow each stage to model more complex
     residual structure.  The default is ‘3’.

   - ‘minimum_samples_leaf/1’: Minimum number of training examples
     required in each leaf of a base learner tree.  Increasing this
     value makes the fitted trees more conservative and can reduce
     overfitting.  The default is ‘1’.

   - ‘minimum_variance_reduction/1’: Minimum reduction in target
     variance required to accept a split when fitting a base learner
     tree.  Larger values make tree growth stricter by rejecting weak
     splits.  The default is ‘0.0’.

   - ‘feature_scaling/1’: Controls continuous-feature scaling in the
     underlying regression-tree learner.  The accepted values are ‘true’
     and ‘false’.  The default is ‘false’.


File: TheLogtalkHandbook-3.100.1.info,  Node: grammars,  Next: graphs,  Prev: gradient_boosting_regression,  Up: Libraries

6.77 ‘grammars’
===============

This library provides Definite Clause Grammars (DCGs) for common parsing
tasks.  The DCGs support parsing both lists of characters (aka chars)
and lists of character codes (aka codes).

Currently, four groups of DCGs are available, each defined in its own
file:

   - blanks (‘blank_grammars.lgt’)

   - numbers (‘number_grammars.lgt’)

   - sequences (‘sequence_grammars.lgt’)

   - IP addresses (‘ip_grammars.lgt’; depends on ‘number_grammars.lgt’)

* Menu:

* API documentation: API documentation<96>.
* Loading: Loading<97>.
* Testing: Testing<89>.
* Usage: Usage<44>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<96>,  Next: Loading<97>,  Up: grammars

6.77.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#grammars’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<97>,  Next: Testing<89>,  Prev: API documentation<96>,  Up: grammars

6.77.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(grammars(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<89>,  Next: Usage<44>,  Prev: Loading<97>,  Up: grammars

6.77.3 Testing
--------------

Minimal tests for this library predicates can be run by loading the
‘tester.lgt’ file:

     | ?- logtalk_load(grammars(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<44>,  Prev: Testing<89>,  Up: grammars

6.77.4 Usage
------------

The library uses (when necessary) parametric objects where the single
parameter can be either ‘chars’ or ‘codes’.  The parameter must be bound
when using the DCGs.  For example, when using implicit message-sending:

     :- uses(blank_grammars(chars), [
         white_spaces//0, new_lines//0
     ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: graphs,  Next: gsp_pattern_miner,  Prev: grammars,  Up: Libraries

6.78 ‘graphs’
=============

The ‘graphs’ library implements predicates for handling
directed/undirected weighted/unweighted graphs.  Graphs are represented
using a dictionary where keys are vertices and values are sorted lists
of neighbors (vertex names for unweighted graphs, ‘Vertex-Weight’ pairs
for weighted graphs).

The four graph types are implemented as parametric objects where the
parameter specifies the dictionary implementation to use (e.g.,
‘avltree’, ‘rbtree’, ‘bintree’, or ‘splaytree’).  This allows for easy
experimentation (e.g., for performance analysis) with different
dictionary backends.  Non-parametric objects are also provided for each
graph type using the ‘avltree’ dictionary implementation.

The common protocol for all graph types is defined in ‘graph_protocol’.
There are also ‘directed_graph_protocol’ and ‘undirected_graph_protocol’
for protocols specific to directed and undirected graphs, respectively.
Additional predicates specific to each graph type (e.g., ‘transpose/2’,
‘topological_sort/2’, ‘min_path/5’, ‘min_tree/3’) are declared in the
individual graph objects.

* Menu:

* API documentation: API documentation<97>.
* Loading: Loading<98>.
* Testing: Testing<90>.
* Usage: Usage<45>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<97>,  Next: Loading<98>,  Up: graphs

6.78.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#graphs’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<98>,  Next: Testing<90>,  Prev: API documentation<97>,  Up: graphs

6.78.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(graphs(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<90>,  Next: Usage<45>,  Prev: Loading<98>,  Up: graphs

6.78.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(graphs(tester)).

This library provides also a ‘graph_types’ category for type-checking
and arbitrary generation of graph-related terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<45>,  Prev: Testing<90>,  Up: graphs

6.78.4 Usage
------------

* Menu:

* Graph types::
* Creating graphs::
* Querying graphs::
* Undirected graphs::


File: TheLogtalkHandbook-3.100.1.info,  Node: Graph types,  Next: Creating graphs,  Up: Usage<45>

6.78.4.1 Graph types
....................

   - ‘unweighted_directed_graph(Dictionary)’ - Unweighted directed graph

   - ‘unweighted_undirected_graph(Dictionary)’ - Unweighted undirected
     graph

   - ‘weighted_directed_graph(Dictionary)’ - Weighted directed graph

   - ‘weighted_undirected_graph(Dictionary)’ - Weighted undirected graph


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating graphs,  Next: Querying graphs,  Prev: Graph types,  Up: Usage<45>

6.78.4.2 Creating graphs
........................

Create an empty graph:

     | ?- unweighted_directed_graph(avltree)::new(Graph).

Create a graph from a list of edges:

     | ?- unweighted_directed_graph(avltree)::new([1-2, 2-3, 3-1], Graph).

Create a graph from vertices and edges:

     | ?- unweighted_directed_graph(avltree)::new([1,2,3,4], [1-2, 2-3], Graph).

For weighted graphs, edges use the format ‘(V1-V2)-Weight’:

     | ?- weighted_directed_graph(avltree)::new([(a-b)-5, (b-c)-3], Graph).


File: TheLogtalkHandbook-3.100.1.info,  Node: Querying graphs,  Next: Undirected graphs,  Prev: Creating graphs,  Up: Usage<45>

6.78.4.3 Querying graphs
........................

     | ?- unweighted_directed_graph(avltree)::new([1-2, 2-3], Graph),
          unweighted_directed_graph(avltree)::vertices(Graph, Vertices),
          unweighted_directed_graph(avltree)::edges(Graph, Edges),
          unweighted_directed_graph(avltree)::neighbors(1, Graph, Neighbors).


File: TheLogtalkHandbook-3.100.1.info,  Node: Undirected graphs,  Prev: Querying graphs,  Up: Usage<45>

6.78.4.4 Undirected graphs
..........................

Undirected edges are stored internally as two directed edges.  The
‘edges/2’ predicate returns each undirected edge only once (with ‘V1 @=<
V2’).  For undirected graphs, ‘neighbors/3’ excludes self-loops.


File: TheLogtalkHandbook-3.100.1.info,  Node: gsp_pattern_miner,  Next: hashes,  Prev: graphs,  Up: Libraries

6.79 ‘gsp_pattern_miner’
========================

GSP sequential pattern miner for sequence datasets.  The library depends
on the ‘sequential_pattern_mining_protocols’ support library, implements
the generic ‘pattern_miner_protocol’ defined in the
‘pattern_mining_protocols’ core library, and mines frequent sequential
patterns using prefix-indexed candidate joins, pruning candidates whose
immediate subpatterns are not all frequent, and counting singleton and
candidate supports in batched horizontal dataset scans.

Requires a dataset implementing ‘sequence_dataset_protocol’ with
sequences represented as ordered lists of canonical sorted itemsets over
a declared item domain.

* Menu:

* API documentation: API documentation<98>.
* Loading: Loading<99>.
* Testing: Testing<91>.
* Features: Features<25>.
* Options: Options<24>.
* Pattern miner representation: Pattern miner representation<5>.
* References: References<16>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<98>,  Next: Loading<99>,  Up: gsp_pattern_miner

6.79.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#gsp_pattern_miner’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<99>,  Next: Testing<91>,  Prev: API documentation<98>,  Up: gsp_pattern_miner

6.79.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(gsp_pattern_miner(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<91>,  Next: Features<25>,  Prev: Loading<99>,  Up: gsp_pattern_miner

6.79.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(gsp_pattern_miner(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<25>,  Next: Options<24>,  Prev: Testing<91>,  Up: gsp_pattern_miner

6.79.4 Features
---------------

   - 'Level-Wise Mining': Builds longer frequent sequences by extending
     the current frequent level.

   - 'Join-Based Candidates': Generates candidate sequences by joining
     compatible frequent patterns from the previous level.

   - 'Support-Pruned Candidates': Prunes candidates whose immediate
     subpatterns are not all frequent.

   - 'Batched Horizontal Support Counting': Counts singleton and
     candidate supports using horizontal scans over the sequence
     database at each level.

   - 'Canonical Sequences': Validates that itemsets are sorted,
     duplicate-free, non-empty, and restricted to declared items.

   - 'Flexible Support Thresholds': Supports relative minimum support
     and absolute minimum support count.

   - 'Model Export': Mined pattern collections can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<24>,  Next: Pattern miner representation<5>,  Prev: Features<25>,  Up: gsp_pattern_miner

6.79.5 Options
--------------

The ‘mine/3’ predicate accepts the following options:

   - ‘minimum_support/1’: Relative minimum support threshold in the
     interval ‘]0.0, 1.0]’.  The default is ‘0.5’.

   - ‘minimum_support_count/1’: Absolute minimum support count.  When
     both support options are provided, this option takes precedence.

   - ‘maximum_pattern_length/1’: Maximum total number of items in a
     mined sequential pattern.  The default is ‘1000’, effectively
     capped by the longest sequence in the dataset.

   - ‘minimum_pattern_length/1’: Minimum total number of items retained
     in the mined result.  The default is ‘1’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pattern miner representation<5>,  Next: References<16>,  Prev: Options<24>,  Up: gsp_pattern_miner

6.79.6 Pattern miner representation
-----------------------------------

The mined pattern miner result is represented by a compound term with
the functor chosen by the implementation and arity 3.  For example:

     gsp_pattern_miner(ItemDomain, Patterns, Options)

Where:

   - ‘ItemDomain’: Canonical sorted list of declared dataset items.

   - ‘Patterns’: List of ‘sequence_pattern(Pattern, SupportCount)’ terms
     ordered first by total item count and then lexicographically.

   - ‘Options’: Effective mining options used to mine the frequent
     sequential patterns.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<16>,  Prev: Pattern miner representation<5>,  Up: gsp_pattern_miner

6.79.7 References
-----------------

  1. Srikant, R. and Agrawal, R. (1996) - “Mining sequential patterns:
     Generalizations and performance improvements”.


File: TheLogtalkHandbook-3.100.1.info,  Node: hashes,  Next: hdbscan_clusterer,  Prev: gsp_pattern_miner,  Up: Libraries

6.80 ‘hashes’
=============

The ‘hashes’ library provides portable implementations of several
commonly used hashing algorithms.  All hash objects implement the
‘hash_protocol’ protocol by providing a ‘hash/2’ predicate that takes a
list of bytes and returns the computed hash as a lowercase hexadecimal
atom.

The fixed-size cryptographic hash objects that can be safely used with
HMAC (‘md5’, ‘sha1’, ‘sha256’, ‘sha3_224’, ‘sha3_256’, ‘sha3_384’, and
‘sha3_512’) also implement the ‘hash_digest_protocol’ protocol.  This
protocol adds ‘digest/2’, ‘digest_size/1’, and ‘block_size/1’ predicates
so that libraries such as ‘hmac’ can compute keyed digests without
duplicating hash function internals.

The library implements the following hashing algorithms:

   - DJB2 32-bit (‘djb2_32’)

   - DJB2 64-bit (‘djb2_64’)

   - SDBM 32-bit (‘sdbm_32’)

   - SDBM 64-bit (‘sdbm_64’)

   - FNV-1a 32-bit (‘fnv1a_32’)

   - FNV-1a 64-bit (‘fnv1a_64’)

   - SipHash (‘siphash_2_4’)

   - CRC-32 parametric reflected implementation
     (‘crc32_reflected(Polynomial)’)

   - CRC-32 parametric non-reflected implementation
     (‘crc32_non_reflected(Polynomial, Initial, FinalXor,
     AppendLength)’)

   - CRC-32/ISO-HDLC (‘crc32b’)

   - CRC-32C/Castagnoli (‘crc32c’)

   - CRC-32/POSIX (‘crc32posix’)

   - CRC-32/MPEG-2 (‘crc32mpeg2’)

   - CRC-32/BZIP2 (‘crc32bzip2’)

   - CRC-32Q (aka CRC-32/AIXM) (‘crc32q’)

   - MurmurHash3 x86 32-bit (‘murmurhash3_x86_32’)

   - MurmurHash3 x86 128-bit (‘murmurhash3_x86_128’)

   - MurmurHash3 x64 128-bit (‘murmurhash3_x64_128’)

   - SHA3-224 (‘sha3_224’)

   - SHA3-256 (‘sha3_256’)

   - SHA3-384 (‘sha3_384’)

   - SHA3-512 (‘sha3_512’)

   - SHAKE128 (‘shake128(OutputBytes)’)

   - SHAKE256 (‘shake256(OutputBytes)’)

   - MD5 (‘md5’)

   - SHA1 (‘sha1’)

   - SHA256 (‘sha256’)

The ‘djb2_64’, ‘sdbm_64’, ‘fnv1a_64’, ‘siphash_2_4’,
‘murmurhash3_x86_128’, ‘murmurhash3_x64_128’, ‘sha3_224’, ‘sha3_256’,
‘sha3_384’, ‘sha3_512’, ‘shake128(OutputBytes)’,
‘shake256(OutputBytes)’, ‘sha1’, and ‘sha256’ objects are only loaded on
backend Prolog compilers supporting unbounded integer arithmetic.

The SHAKE objects are parametric extensible-output functions.  Pass the
number of output bytes to generate when constructing the object.

The ‘crc32_reflected(Polynomial)’ object implements a reflected CRC-32
family using initial value ‘0xFFFFFFFF’ and final xor value
‘0xFFFFFFFF’, where ‘Polynomial’ is the reflected CRC-32 polynomial.

The ‘crc32_non_reflected(Polynomial, Initial, FinalXor, AppendLength)’
object implements a non-reflected CRC-32 family using a canonical
polynomial, configurable initial and final xor values, and an
‘AppendLength’ flag that controls whether the message length is appended
as little-endian bytes.

The ‘crc32b’ object implements the CRC-32/ISO-HDLC variant, also widely
used by Ethernet, gzip, and PKZip.  It uses reflected input/output
processing, the reflected polynomial ‘0xEDB88320’ (equivalent to the
canonical polynomial ‘0x04C11DB7’), initial value ‘0xFFFFFFFF’, and
final xor value ‘0xFFFFFFFF’.

The ‘crc32c’ object implements the CRC-32C/Castagnoli variant using
reflected input/output processing, the reflected polynomial ‘0x82F63B78’
(equivalent to the canonical polynomial ‘0x1EDC6F41’), initial value
‘0xFFFFFFFF’, and final xor value ‘0xFFFFFFFF’.

The ‘crc32posix’ object implements the CRC-32/POSIX variant used by the
standard ‘cksum’ utility.  It is an instance of the non-reflected
‘crc32_non_reflected(Polynomial, Initial, FinalXor, AppendLength)’
family: it uses the canonical polynomial ‘0x04C11DB7’, initial value
‘0x00000000’, processes bits most-significant first, appends the message
length as little-endian bytes, and applies a final xor value of
‘0xFFFFFFFF’.

The ‘crc32mpeg2’ object implements the CRC-32/MPEG-2 variant using the
canonical polynomial ‘0x04C11DB7’, initial value ‘0xFFFFFFFF’, no
appended length bytes, and final xor value ‘0x00000000’.

The ‘crc32bzip2’ object implements the CRC-32/BZIP2 variant using the
canonical polynomial ‘0x04C11DB7’, initial value ‘0xFFFFFFFF’, no
appended length bytes, and final xor value ‘0xFFFFFFFF’.

The ‘crc32q’ object implements the CRC-32Q variant, also used by
AIXM-style formats, using the canonical polynomial ‘0x814141AB’, initial
value ‘0x00000000’, no appended length bytes, and final xor value
‘0x00000000’.

The ‘siphash_2_4’ object uses the standard reference key ‘00 01 02 ...
0f’.  For custom keys, use the parametric object ‘siphash_2_4(Key)’
where ‘Key’ is a list of 16 bytes.

The implementations of the hashing algorithms make no attempt to
validate that the input is a list of bytes.  When necessary, use the
‘types’ library ‘type::check(list(byte), Input)’ goal before calling the
‘hash/2’ predicate.

* Menu:

* API documentation: API documentation<99>.
* Loading: Loading<100>.
* Testing: Testing<92>.
* Examples: Examples<169>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<99>,  Next: Loading<100>,  Up: hashes

6.80.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#hashes’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<100>,  Next: Testing<92>,  Prev: API documentation<99>,  Up: hashes

6.80.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(hashes(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<92>,  Next: Examples<169>,  Prev: Loading<100>,  Up: hashes

6.80.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(hashes(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<169>,  Prev: Testing<92>,  Up: hashes

6.80.4 Examples
---------------

Compute the SHA-256 hash of a text message:

     | ?- atom_codes('The quick brown fox jumps over the lazy dog', Bytes),
          sha256::hash(Bytes, Hash).
     Bytes = [84,104,101,32,113,117,105,99,107,32,98,114,111,119,110,32,102,111,120,32,106,117,109,112,115,32,111,118,101,114,32,116,104,101,32,108,97,122,121,32,100,111,103],
     Hash = 'd7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592'
     yes

Compute a 32-byte SHAKE128 digest:

     | ?- atom_codes('The quick brown fox jumps over the lazy dog', Bytes),
          shake128(32)::hash(Bytes, Hash).
     Bytes = [84,104,101,32,113,117,105,99,107,32,98,114,111,119,110,32,102,111,120,32,106,117,109,112,115,32,111,118,101,114,32,116,104,101,32,108,97,122,121,32,100,111,103],
     Hash = 'f4202e3c5852f9182a0430fd8144f0a74b95e7417ecae17db0f8cfeed0e3e66e'
     yes

Compute the CRC-32/ISO-HDLC checksum for the standard ‘123456789’ test
vector:

     | ?- atom_codes('123456789', Bytes), crc32b::hash(Bytes, Hash).
     Bytes = [49,50,51,52,53,54,55,56,57],
     Hash = 'cbf43926'
     yes

Compute the CRC-32C/Castagnoli checksum for the standard ‘123456789’
test vector:

     | ?- atom_codes('123456789', Bytes), crc32c::hash(Bytes, Hash).
     Bytes = [49,50,51,52,53,54,55,56,57],
     Hash = 'e3069283'
     yes

Compute the CRC-32/POSIX checksum for the standard ‘123456789’ test
vector:

     | ?- atom_codes('123456789', Bytes), crc32posix::hash(Bytes, Hash).
     Bytes = [49,50,51,52,53,54,55,56,57],
     Hash = '377a6011'
     yes

Compute the CRC-32/MPEG-2 checksum for the standard ‘123456789’ test
vector:

     | ?- atom_codes('123456789', Bytes), crc32mpeg2::hash(Bytes, Hash).
     Bytes = [49,50,51,52,53,54,55,56,57],
     Hash = '0376e6e7'
     yes

Compute the CRC-32/BZIP2 checksum for the standard ‘123456789’ test
vector:

     | ?- atom_codes('123456789', Bytes), crc32bzip2::hash(Bytes, Hash).
     Bytes = [49,50,51,52,53,54,55,56,57],
     Hash = 'fc891918'
     yes

Compute the CRC-32Q checksum for the standard ‘123456789’ test vector:

     | ?- atom_codes('123456789', Bytes), crc32q::hash(Bytes, Hash).
     Bytes = [49,50,51,52,53,54,55,56,57],
     Hash = '3010bf7f'
     yes

Use SipHash-2-4 with a custom key on a backend supporting unbounded
integer arithmetic:

     | ?- siphash_2_4([0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15])::hash([0,1,2,3], Hash).
     Hash = 'cf2794e0277187b7'
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: hdbscan_clusterer,  Next: heaps,  Prev: hashes,  Up: Libraries

6.81 ‘hdbscan_clusterer’
========================

Simplified HDBSCAN-style clusterer.  It builds the mutual-reachability
graph, computes a minimum spanning tree, derives the single-linkage
hierarchy, condenses the hierarchy using ‘minimum_cluster_size’, and
selects clusters using ‘eom’ or ‘leaf’ selection.  Supports continuous
attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<100>.
* Loading: Loading<101>.
* Testing: Testing<93>.
* Features: Features<26>.
* Options: Options<25>.
* Clusterer representation: Clusterer representation<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<100>,  Next: Loading<101>,  Up: hdbscan_clusterer

6.81.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#hdbscan_clusterer’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<101>,  Next: Testing<93>,  Prev: API documentation<100>,  Up: hdbscan_clusterer

6.81.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(hdbscan_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<93>,  Next: Features<26>,  Prev: Loading<101>,  Up: hdbscan_clusterer

6.81.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(hdbscan_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(hdbscan_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<26>,  Next: Options<25>,  Prev: Testing<93>,  Up: hdbscan_clusterer

6.81.4 Features
---------------

   - 'Hierarchical Density Clustering': Builds the mutual-reachability
     graph, computes a minimum spanning tree, derives the single-linkage
     hierarchy, condenses it using ‘minimum_cluster_size’, and selects
     clusters using ‘eom’ or ‘leaf’ selection.

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Cluster Selection Methods': Supports both ‘eom’ and ‘leaf’ cluster
     selection.

   - 'Distance Metrics': Supports Euclidean and Manhattan distances.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Reachability-Based Prediction': New instances are assigned to the
     selected cluster with the nearest training point when the distance
     is within the learned cluster reachability threshold; otherwise the
     atom ‘noise’ is returned.

   - 'Noise Detection': Points not assigned to any extracted cluster are
     retained as noise.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<25>,  Next: Clusterer representation<4>,  Prev: Features<26>,  Up: hdbscan_clusterer

6.81.5 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘minimum_points(MinimumPoints)’: Minimum neighborhood size used
     when computing core distances and mutual reachability.  Default is
     ‘2’.

   - ‘minimum_cluster_size(MinimumClusterSize)’: Minimum number of
     points required for an extracted cluster.  Default is ‘2’.

   - ‘cluster_selection_method(Method)’: Cluster extraction policy.
     Options: ‘eom’ (default) or ‘leaf’.

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default) or ‘manhattan’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<4>,  Prev: Options<25>,  Up: hdbscan_clusterer

6.81.6 Clusterer representation
-------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     hdbscan_clusterer(Encoders, Clusters, Noise, Options)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

        - ‘Clusters’: List of ‘cluster(Id, Points, MaxCoreDistance,
          Stability)’ terms in cluster-id order.

   - ‘Noise’: List of encoded training points classified as noise.

   - ‘Options’: Effective training options used to learn the clusterer.


File: TheLogtalkHandbook-3.100.1.info,  Node: heaps,  Next: hierarchical_clustering,  Prev: hdbscan_clusterer,  Up: Libraries

6.82 ‘heaps’
============

This library defines a heap protocol and provides minimum and maximum
heaps using two different implementations: pairing heaps and binary
heaps.

The heap representations should be regarded as opaque terms, subjected
to be changed without notice, and only accessed using the library
predicates.

For backward-compatibility, the ‘legacy.lgt’ file defines the ‘heapp’
protocol extending the ‘heap_protocol’ protocol plus the ‘heap/1’,
‘minheap’, and ‘maxheap’ objects extending the ‘binary_heap/1’ object.
These legacy protocol and objects are deprecated and should not be used
in new code.

* Menu:

* API documentation: API documentation<101>.
* Loading: Loading<102>.
* Testing: Testing<94>.
* Usage: Usage<46>.
* Credits: Credits<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<101>,  Next: Loading<102>,  Up: heaps

6.82.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#heaps’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<102>,  Next: Testing<94>,  Prev: API documentation<101>,  Up: heaps

6.82.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(heaps(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<94>,  Next: Usage<46>,  Prev: Loading<102>,  Up: heaps

6.82.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(heaps(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<46>,  Next: Credits<3>,  Prev: Testing<94>,  Up: heaps

6.82.4 Usage
------------

Choose the heap implementation that best suits your needs.  The pairing
heap implementation is usually the best choice, specially if insertion
and merging operations dominate in your use case.  You can easily
benchmark and compare the two implementations using either a ‘uses/2’
directive with a parameter variable for the heap object and calling the
heap predicates using implicit message-sending goals or a ‘uses/1’
directive defining an object alias for the heap object and using the
alias with explicit message-sending goals.

The two main library objects are ‘binary_heap(Order)’ and
‘pairing_heap(Order)’, where ‘Order’ is either ‘<’ for a minimum heap or
‘>’ for a maximum heap.  For convenience, there are also
‘binary_heap_min’ and ‘pairing_heap_min’ objects for minimum heaps and
‘binary_heap_max’ and ‘pairing_heap_max’ objects for maximum heaps.


File: TheLogtalkHandbook-3.100.1.info,  Node: Credits<3>,  Prev: Usage<46>,  Up: heaps

6.82.5 Credits
--------------

Original binary heap code by Richard O’Keefe and adapted to Logtalk by
Paulo Moura and Victor Lagerkvist.


File: TheLogtalkHandbook-3.100.1.info,  Node: hierarchical_clustering,  Next: hierarchies,  Prev: heaps,  Up: Libraries

6.83 ‘hierarchical_clustering’
==============================

Hierarchical clusterer.  Supports continuous attributes only.  It builds
the full bottom-up agglomerative_clusterer hierarchy and derives the
requested partition by cutting the learned dendrogram at the largest
remaining merge distances.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
full agglomerative_clusterer hierarchy from a dataset, deriving a
‘k’-cluster cut for prediction, and exporting the learned clusterer as a
list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<102>.
* Loading: Loading<103>.
* Testing: Testing<95>.
* Features: Features<27>.
* Options: Options<26>.
* Clusterer representation: Clusterer representation<5>.
* Additional API::
* Diagnostics: Diagnostics<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<102>,  Next: Loading<103>,  Up: hierarchical_clustering

6.83.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#hierarchical_clustering’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<103>,  Next: Testing<95>,  Prev: API documentation<102>,  Up: hierarchical_clustering

6.83.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(hierarchical_clustering(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<95>,  Next: Features<27>,  Prev: Loading<103>,  Up: hierarchical_clustering

6.83.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(hierarchical_clustering(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(hierarchical_clustering(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<27>,  Next: Options<26>,  Prev: Testing<95>,  Up: hierarchical_clustering

6.83.4 Features
---------------

   - 'Full Hierarchy Learning': Builds the complete bottom-up merge
     hierarchy before deriving the requested cluster partition.

   - 'Deterministic Dendrogram Cutting': Produces the final ‘k’ clusters
     by repeatedly splitting the highest remaining merge.

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Linkage Strategies': Supports ‘single’, ‘complete’, and ‘average’
     linkage.

   - 'Distance Metrics': Supports Euclidean and Manhattan distances.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Linkage-Aware Prediction': New instances are assigned to the
     nearest learned cluster using the selected linkage strategy and
     distance metric rather than a prototype shortcut.

   - 'Incremental Distance Updates': Training caches singleton pair
     distances once and updates merge distances incrementally for
     ‘single’, ‘complete’, and ‘average’ linkage instead of recomputing
     all member-pair distances after every merge.

   - 'Heap-Based Merge Selection': Training uses a lazy min-heap of
     candidate cluster pairs and skips stale entries for merged-away
     nodes instead of rescanning all active pairs at every agglomeration
     step.

   - 'Reusable Hierarchy Cuts': Learned hierarchies can be re-cut to a
     different ‘k’ using ‘cut/3’ without retraining.

   - 'Rich Diagnostics': Learned clusterers record merge counts,
     dendrogram height, heap rebuilds, scan fallbacks, maximum heap
     size, and effective options.

   - 'Deterministic Tie-Breaking': Equal merge distances and equal split
     heights are resolved by preferring the smallest node-id pair.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<26>,  Next: Clusterer representation<5>,  Prev: Features<27>,  Up: hierarchical_clustering

6.83.5 Options
--------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of clusters to retain after cutting the learned
     hierarchy.  Default is ‘2’.

   - ‘linkage(Linkage)’: Linkage strategy to use.  Options: ‘single’,
     ‘complete’, or ‘average’ (default).

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default) or ‘manhattan’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<5>,  Next: Additional API,  Prev: Options<26>,  Up: hierarchical_clustering

6.83.6 Clusterer representation
-------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 5.  For
example:

     hierarchical_clustering_clusterer(Encoders, hierarchy(RootState, MergeRecords, Dendrogram), Clusters, Prototypes, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘hierarchy(RootState, MergeRecords, Dendrogram)’: Reusable
     hierarchy state.  ‘RootState’ and ‘MergeRecords’ are used
     internally by ‘cut/3’, and ‘Dendrogram’ is the learned merge tree
     represented with ‘leaf(Id)’ and ‘merge(Left, Right, Distance,
     Size)’ terms.

   - ‘Clusters’: List of ‘cluster(Id, Points)’ terms for the selected
     ‘k’-cluster cut.

   - ‘Prototypes’: List of average vectors kept for display and export
     metadata.

   - ‘Diagnostics’: Diagnostics metadata including the effective
     training options used to learn the clusterer.


File: TheLogtalkHandbook-3.100.1.info,  Node: Additional API,  Next: Diagnostics<3>,  Prev: Clusterer representation<5>,  Up: hierarchical_clustering

6.83.7 Additional API
---------------------

   - ‘cut(+Clusterer, +K, -RecutClusterer)’: Reuses the learned
     hierarchy to derive a new ‘K’-cluster cut without retraining.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<3>,  Prev: Additional API,  Up: hierarchical_clustering

6.83.8 Diagnostics
------------------

The ‘diagnostics/2’ predicate returns metadata terms including:

   - ‘model(hierarchical_clustering)’

   - ‘cluster_count(Count)’

   - ‘prototype_count(Count)’

   - ‘training_example_count(Count)’

   - ‘merge_count(Count)’

   - ‘dendrogram_height(Height)’

   - ‘heap_rebuild_count(Count)’

   - ‘scan_fallback_count(Count)’

   - ‘maximum_heap_size(Size)’

   - ‘tie_breaking(node_id_order)’

   - ‘options(Options)’


File: TheLogtalkHandbook-3.100.1.info,  Node: hierarchies,  Next: hmac,  Prev: hierarchical_clustering,  Up: Libraries

6.84 ‘hierarchies’
==================

This library provides categories implementing reflection predicates over
class and prototype hierarchies.  These categories can be imported by
any object that requires reasoning about hierarchies.

* Menu:

* API documentation: API documentation<103>.
* Loading: Loading<104>.
* Testing: Testing<96>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<103>,  Next: Loading<104>,  Up: hierarchies

6.84.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#hierarchies’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<104>,  Next: Testing<96>,  Prev: API documentation<103>,  Up: hierarchies

6.84.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(hierarchies(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<96>,  Prev: Loading<104>,  Up: hierarchies

6.84.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(hierarchies(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: hmac,  Next: hodge_rank,  Prev: hierarchies,  Up: Libraries

6.85 ‘hmac’
===========

The ‘hmac’ library provides a portable implementation of HMAC
(Keyed-Hashing for Message Authentication) as specified in RFC 2104:

‘https://datatracker.ietf.org/doc/html/rfc2104.html’

The library exports a single object, ‘hmac’, implementing the
‘hmac_protocol’ protocol with the predicates:

   - ‘digest/4’

   - ‘hex_digest/4’

   - ‘digest/5’

   - ‘hex_digest/5’

The first argument is a hash object implementing the
‘hash_digest_protocol’ protocol from the ‘hashes’ library.  Currently
supported hash objects are:

   - ‘md5’

   - ‘sha1’

   - ‘sha256’

   - ‘sha3_224’

   - ‘sha3_256’

   - ‘sha3_384’

   - ‘sha3_512’

On backend Prolog compilers supporting only bounded integer arithmetic,
only ‘md5’ is available.  On backends supporting unbounded integer
arithmetic, all the listed hash objects are available.

The ‘digest/5’ and ‘hex_digest/5’ predicates implement the truncation
rule described in RFC 2104 and RFC 2202 by returning the requested
number of leftmost digest bytes.

* Menu:

* API documentation: API documentation<104>.
* Loading: Loading<105>.
* Testing: Testing<97>.
* Examples: Examples<170>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<104>,  Next: Loading<105>,  Up: hmac

6.85.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#hmac’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<105>,  Next: Testing<97>,  Prev: API documentation<104>,  Up: hmac

6.85.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(hmac(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<97>,  Next: Examples<170>,  Prev: Loading<105>,  Up: hmac

6.85.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(hmac(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<170>,  Prev: Testing<97>,  Up: hmac

6.85.4 Examples
---------------

Compute the HMAC-SHA-256 digest for a text message and return it as a
hexadecimal atom:

     | ?- atom_codes('Jefe', Key),
          atom_codes('what do ya want for nothing?', Message),
          hmac::hex_digest(sha256, Key, Message, Digest).
     Key = [74,101,102,101],
     Message = [119,104,97,116,32,100,111,32,121,97,32,119,97,110,116,32,102,111,114,32,110,111,116,104,105,110,103,63],
     Digest = '5bdcc146bf60754e6a042426089575c75a003f089d2739839dec58b964ec3843'
     yes

Compute a truncated 16-byte HMAC-SHA-256 digest:

     | ?- atom_codes('Jefe', Key),
          atom_codes('what do ya want for nothing?', Message),
          hmac::hex_digest(sha256, Key, Message, 16, Digest).
     Key = [74,101,102,101],
     Message = [119,104,97,116,32,100,111,32,121,97,32,119,97,110,116,32,102,111,114,32,110,111,116,104,105,110,103,63],
     Digest = '5bdcc146bf60754e6a042426089575c7'
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: hodge_rank,  Next: hook_flows,  Prev: hmac,  Up: Libraries

6.86 ‘hodge_rank’
=================

HodgeRank pairwise measurement ranker.  It builds a weighted graph
Laplacian from the pairwise measurement support graph, solves the
anchored normal equations using deterministic Gaussian elimination with
partial pivoting and residual validation, and computes edge residuals
against the fitted score differences.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from weighted signed pairwise measurements, using it to order
candidate items, inspecting the resulting edge residuals, and exporting
it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_measurement_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The current implementation requires a well-formed connected
pairwise measurement dataset so that learned scores remain globally
comparable across all ranked items.

* Menu:

* API documentation: API documentation<105>.
* Loading: Loading<106>.
* Testing: Testing<98>.
* Features: Features<28>.
* Scoring semantics: Scoring semantics<4>.
* Residual semantics::
* Usage: Usage<47>.
* Diagnostics syntax: Diagnostics syntax<11>.
* Ranker representation: Ranker representation<8>.
* References: References<17>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<105>,  Next: Loading<106>,  Up: hodge_rank

6.86.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#hodge_rank’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<106>,  Next: Testing<98>,  Prev: API documentation<105>,  Up: hodge_rank

6.86.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(hodge_rank(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<98>,  Next: Features<28>,  Prev: Loading<106>,  Up: hodge_rank

6.86.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(hodge_rank(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<28>,  Next: Scoring semantics<4>,  Prev: Testing<98>,  Up: hodge_rank

6.86.4 Features
---------------

   - 'Weighted Measurement Learning': Learns one deterministic score per
     item from weighted signed pairwise measurements instead of
     winner/loser counts.

   - 'HodgeRank Global Component': Solves the weighted graph-Laplacian
     least- squares system with a zero-sum anchoring convention.

   - 'Residual Inspection': Exposes edge residuals through the
     ‘residuals/2’ predicate so the non-global residual edge flow can be
     inspected explicitly.

   - 'Numerically Hardened Solver': Uses Gaussian elimination with
     partial pivoting plus residual checks before accepting the learned
     scores.

   - 'Deterministic Ranking': Orders candidate items by learned score
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-measurements, non-numeric values, non-positive weights,
     and disconnected support graphs.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoring semantics<4>,  Next: Residual semantics,  Prev: Features<28>,  Up: hodge_rank

6.86.5 Scoring semantics
------------------------

This implementation interprets each measurement fact

     measurement(Item1, Item2, Value, Weight)

as a weighted signed observation for the oriented edge ‘Item1 -> Item2’.
The learner fits a global zero-sum score vector ‘s’ by minimizing the
weighted least-squares objective

     sum_ij Weight_ij * (Value_ij - (s_i - s_j))^2

subject to ‘sum(scores) = 0’.  The resulting normal equations are a
weighted graph-Laplacian system with one anchoring row enforcing the
zero-sum gauge.

The learned scores are relative rather than probabilistic: only their
differences and ordering matter.  Larger positive values indicate items
whose fitted global potential is higher than average.  The ‘residuals/2’
predicate returns the unexplained part of each observed edge measurement
after removing the fitted score difference, i.e.  the non-global
residual edge flow left after fitting the global component.


File: TheLogtalkHandbook-3.100.1.info,  Node: Residual semantics,  Next: Usage<47>,  Prev: Scoring semantics<4>,  Up: hodge_rank

6.86.6 Residual semantics
-------------------------

Residuals capture the part of each observed edge measurement that is not
explained by the fitted global score difference, exposing the non-global
residual edge flow left after fitting the global component.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<47>,  Next: Diagnostics syntax<11>,  Prev: Residual semantics,  Up: hodge_rank

6.86.7 Usage
------------

* Menu:

* Learning a ranker: Learning a ranker<8>.
* Inspecting residuals::


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<8>,  Next: Inspecting residuals,  Up: Usage<47>

6.86.7.1 Learning a ranker
..........................

     % Learn from a pairwise measurement dataset object
     | ?- hodge_rank::learn(my_dataset, Ranker).
     ...

     % Learn with an explicit empty options list
     | ?- hodge_rank::learn(my_dataset, Ranker, []).
     ...

The current implementation accepts only the empty options list ‘[]’.
Any non-empty options list is rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting residuals,  Prev: Learning a ranker<8>,  Up: Usage<47>

6.86.7.2 Inspecting residuals
.............................

     % Inspect edge residuals from the fitted global scores
     | ?- hodge_rank::learn(my_dataset, Ranker),
          hodge_rank::residuals(Ranker, Residuals).
     Residuals = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<11>,  Next: Ranker representation<8>,  Prev: Usage<47>,  Up: hodge_rank

6.86.8 Diagnostics syntax
-------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(hodge_rank),
         options(Options),
         residuals(Residuals),
         residual_norm(ResidualNorm),
         dataset_summary(DatasetSummary)
     ]


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<8>,  Next: References<17>,  Prev: Diagnostics syntax<11>,  Up: hodge_rank

6.86.9 Ranker representation
----------------------------

The learned ranker is represented by a compound term of the form:

     hodge_rank_ranker(Items, Scores, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Score’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the residuals,
     residual norm, effective options, and dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<17>,  Prev: Ranker representation<8>,  Up: hodge_rank

6.86.10 References
------------------

  1. Jiang, X., Lim, L.-H., Yao, Y., & Ye, Y. (2011).  'Statistical
     ranking and combinatorial Hodge theory'.


File: TheLogtalkHandbook-3.100.1.info,  Node: hook_flows,  Next: hook_objects,  Prev: hodge_rank,  Up: Libraries

6.87 ‘hook_flows’
=================

Hook objects (i.e., objects that define term- and goal-expansion rules)
can be combined to define expansion 'workflows'.  While in some cases
the expansions are independent and thus can be applied in any order, in
other cases a specific order is required.  The ‘hook_pipeline’ and
‘hook_set’ parametric objects in this library implement the two most
common scenarios of combining multiple hook objects for the expansion of
source files.  These parametric hook objects can be combined to define
workflows of any complexity (e.g., a pipeline where one of the steps is
set with an element that is a pipeline).  These two basic hook flows can
also be used as examples of how to construct your own custom expansion
workflows.

* Menu:

* API documentation: API documentation<106>.
* Loading: Loading<107>.
* Testing: Testing<99>.
* Usage: Usage<48>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<106>,  Next: Loading<107>,  Up: hook_flows

6.87.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#hook-flows’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<107>,  Next: Testing<99>,  Prev: API documentation<106>,  Up: hook_flows

6.87.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(hook_flows(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<99>,  Next: Usage<48>,  Prev: Loading<107>,  Up: hook_flows

6.87.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(hook_flows(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<48>,  Prev: Testing<99>,  Up: hook_flows

6.87.4 Usage
------------

Pre-processing a source file with a hook object can be accomplished by
either compiling the source file using the option ‘hook(HookObject)’ or
by adding to the top of the file the directive:

     :- set_logtalk_flag(hook, HookObject).

Note that ‘set_logtalk_flag/2’ directives are local to an entity or a
source file.

The ‘hook_pipeline(Pipeline)’ is a parametric object where the parameter
is a list of hook objects, interpreted as a pre-processing pipeline: the
results of a hook object are passed to the next hook object.  Terms and
goals that are not expanded by a hook object are passed as-is to the
next hook object.  This parametric object is used when a set of
expansions must be applied in a specific order.  It also allows
overriding the default compiler semantics where term-expansion rules are
tried in sequence only until one of them succeeds.

The ‘hook_set(Set)’ is a parametric object where the parameter is a list
of hook objects, interpreted as a set of hook objects.  The hook objects
are tried in sequence until one of them succeeds in expanding the
current term (goal) into a different term (goal).  This parametric
object is used when applying multiple independent expansions (i.e.,
expansions that don’t apply to the same terms or goals).

Both the ‘hook_pipeline(Pipeline)’ and ‘hook_set(Set)’ objects assume
that the individual hook objects publicly implement the ‘expanding’
protocol (this is the default) as they send ‘term_expansion/2’ and
‘goal_expansion/2’ messages to those objects.

When using a backend Prolog compiler that supports modules, it’s also
possible to use as parameter a list of hook modules as long as their
names do not coincide with the names of loaded objects.


File: TheLogtalkHandbook-3.100.1.info,  Node: hook_objects,  Next: html,  Prev: hook_flows,  Up: Libraries

6.88 ‘hook_objects’
===================

This library provides a set of convenient hook objects for defining
custom expansion workflows (using, e.g., the ‘hook_flows’ library) and
for debugging.  They are usable and useful as-is but should also be
regarded as term- and goal-expansion examples that you can learn from,
clone, and change to fit your application requirements.

* Menu:

* API documentation: API documentation<107>.
* Loading: Loading<108>.
* Testing: Testing<100>.
* Usage: Usage<49>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<107>,  Next: Loading<108>,  Up: hook_objects

6.88.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#hook-objects’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<108>,  Next: Testing<100>,  Prev: API documentation<107>,  Up: hook_objects

6.88.2 Loading
--------------

To load all hook objects in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(hook_objects(loader)).

To load a specific hook object, e.g., the ‘backend_adapter_hook’ object:

     | ?- logtalk_load(hook_objects(backend_adapter_hook)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<100>,  Next: Usage<49>,  Prev: Loading<108>,  Up: hook_objects

6.88.3 Testing
--------------

To test this library hook objects, load the ‘tester.lgt’ file:

     | ?- logtalk_load(hook_objects(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<49>,  Prev: Testing<100>,  Up: hook_objects

6.88.4 Usage
------------

The provided hook objects cover different expansion scenarios as
follows.

* Menu:

* Using the Prolog backend adapter file expansion rules::
* Restoring the default compiler expansion workflow::
* Preventing applying any (other) user-defined expansion rules: Preventing applying any other user-defined expansion rules.
* Expanding grammar rules into clauses independently of the compiler::
* Using the expansion rules defined in a Prolog module::
* Wrap the contents of a plain Prolog file as an object::
* Outputting term-expansion results to a stream or a file::
* Printing entity predicate goals before or after calling them::
* Suppressing goals::


File: TheLogtalkHandbook-3.100.1.info,  Node: Using the Prolog backend adapter file expansion rules,  Next: Restoring the default compiler expansion workflow,  Up: Usage<49>

6.88.4.1 Using the Prolog backend adapter file expansion rules
..............................................................

Useful when defining a custom expansion workflow.  This can be
accomplished by loading the ‘backend_adapter_hook.lgt’ file, which
defines a ‘backend_adapter_hook’ hook object that can be used as a
workflow step.


File: TheLogtalkHandbook-3.100.1.info,  Node: Restoring the default compiler expansion workflow,  Next: Preventing applying any other user-defined expansion rules,  Prev: Using the Prolog backend adapter file expansion rules,  Up: Usage<49>

6.88.4.2 Restoring the default compiler expansion workflow
..........................................................

In this case, load the ‘default_workflow_hook.lgt’ file, which defines a
‘default_workflow_hook’ hook object, and use the following 'goal' to set
the default hook object:

     | ?- set_logtalk_flag(hook, default_workflow_hook).


File: TheLogtalkHandbook-3.100.1.info,  Node: Preventing applying any other user-defined expansion rules,  Next: Expanding grammar rules into clauses independently of the compiler,  Prev: Restoring the default compiler expansion workflow,  Up: Usage<49>

6.88.4.3 Preventing applying any (other) user-defined expansion rules
.....................................................................

When compiling a source file, we sometimes want to prevent applying
expansion rules.  This can be accomplished by simply loading the
‘identity_hook.lgt’ file, which defines the ‘identity_hook’ hook object,
whose expansion rules simply succeed without changing the terms and
goals, and setting it as the file-specific hook object writing as the
first term in the file the 'directive':

     :- set_logtalk_flag(hook, identity_hook).

Note that the compiler will always convert any grammar rules defined in
the file into clauses.  Although this conversion can also be performed
as an expansion, grammar rules are part of the Logtalk language.  If you
want to preserve the grammar rules, use the hook objects described below
to write them to a stream.


File: TheLogtalkHandbook-3.100.1.info,  Node: Expanding grammar rules into clauses independently of the compiler,  Next: Using the expansion rules defined in a Prolog module,  Prev: Preventing applying any other user-defined expansion rules,  Up: Usage<49>

6.88.4.4 Expanding grammar rules into clauses independently of the compiler
...........................................................................

Load the ‘grammar_rules_hook.lgt’ and use the term-expansion rules in
the ‘grammar_rules_hook’ object.  For example:

     | ?- grammar_rules_hook::term_expansion((a --> [b],c), Clause).

     Clause = (a([b|T], C) :- c(T, C))
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Using the expansion rules defined in a Prolog module,  Next: Wrap the contents of a plain Prolog file as an object,  Prev: Expanding grammar rules into clauses independently of the compiler,  Up: Usage<49>

6.88.4.5 Using the expansion rules defined in a Prolog module
.............................................................

Load the ‘prolog_module_hook.lgt’, which defines the parametric hook
object ‘prolog_module_hook(Module)’.  To use this hook object, you need
to instantiate the parameter to the name of the module.  For example:

     :- set_logtalk_flag(hook, prolog_module_hook(user)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Wrap the contents of a plain Prolog file as an object,  Next: Outputting term-expansion results to a stream or a file,  Prev: Using the expansion rules defined in a Prolog module,  Up: Usage<49>

6.88.4.6 Wrap the contents of a plain Prolog file as an object
..............................................................

Load the ‘object_wrapper_hook.lgt’, which defines the
‘object_wrapper_hook/0-2’ hook objects.  Use them to wrap the contents
of a plain Prolog file as an object named after the file (optionally
implementing a protocol) or an object with the given name and object
relations.  Can be used to apply Logtalk developer tools to plain Prolog
code or when porting a Prolog application to Logtalk.  For example:

     | ?- logtalk_load('plain.pl', [hook(object_wrapper_hook)]).
     ...

     | ?- current_object(plain).
     yes

Or:

     | ?- logtalk_load('world_1.pl', [hook(object_wrapper_hook(some_protocol))]).
     ...

     | ?- current_object(world_1).
     yes

     | ?- implements_protocol(world_1, Protocol).
     Protocol = some_protocol
     yes

Or:

     | ?- logtalk_load('foo.pl', [hook(object_wrapper_hook(bar,[imports(some_category))]).
     ...

     | ?- current_object(bar).
     yes

     | ?- imports_category(bar, Category).
     Category = some_category
     yes

The ‘object_wrapper_hook’ object sets the ‘context_switching_calls’ flag
to ‘allow’ for the generated object.  This enables calling the
predicates using the ‘(<<)/2’ context-switching control construct.  But
it’s usually better to define a protocol for the predicates being
encapsulated and use instead the ‘object_wrapper_hook/1-2’ objects.


File: TheLogtalkHandbook-3.100.1.info,  Node: Outputting term-expansion results to a stream or a file,  Next: Printing entity predicate goals before or after calling them,  Prev: Wrap the contents of a plain Prolog file as an object,  Up: Usage<49>

6.88.4.7 Outputting term-expansion results to a stream or a file
................................................................

Load the ‘write_to_stream_hook.lgt’ file and use the
‘write_to_stream_hook(Stream)’ or ‘write_to_stream_hook(Stream,
Options)’ hook objects.  Alternatively, you can load the
‘write_to_file_hook.lgt’ file and use the ‘write_to_file_hook(File)’ or
‘write_to_file_hook(File, Options)’ hook objects.  The terms are not
modified and thus these hook objects may be used at any point in an
expansion workflow.  The terms are written followed by a period and a
new line.

For example, assume that we want to expand all terms in a ‘input.pl’
source file, writing the resulting terms to a ‘output.pl’ file, using
the expansion rules defined in a ‘expansions’ hook object.  Taking
advantage of the ‘hook_flows’ library ‘hook_pipeline/1’ object, we can
write:

     | ?- logtalk_compile(
              'input.pl',
              [hook(hook_pipeline([
                  expansions,
                  write_to_file_hook('output.pl')
              ]))]
          ).


File: TheLogtalkHandbook-3.100.1.info,  Node: Printing entity predicate goals before or after calling them,  Next: Suppressing goals,  Prev: Outputting term-expansion results to a stream or a file,  Up: Usage<49>

6.88.4.8 Printing entity predicate goals before or after calling them
.....................................................................

This is helpful for quick debugging.  Load the ‘print_goal_hook.lgt’
file and use the ‘print_goal_hook’ hook object.  For example, we can set
this hook object as the default hook:

     | ?- set_logtalk_flag(hook, print_goal_hook).

Then, edit the entity source code to print selected goals:

     foo :-
         - bar,   % print goal before calling it
         + baz,   % print goal after calling it
         * quux.  % print goal before and after calling it


File: TheLogtalkHandbook-3.100.1.info,  Node: Suppressing goals,  Prev: Printing entity predicate goals before or after calling them,  Up: Usage<49>

6.88.4.9 Suppressing goals
..........................

The ‘suppress_goal_hook.lgt’ file provides the ‘suppress_goal_hook’ hook
object that supports suppressing a goal in a clause body by prefixing it
using the ‘--’ operator.  We can set this hook object as the default
hook using the goal:

     | ?- set_logtalk_flag(hook, suppress_goal_hook).

If the expansion is only to be used in a single file, use instead the
source file directive:

     :- set_logtalk_flag(hook, suppress_goal_hook).

Then, edit entity predicates to suppress goals.  For example:

     foo :-
         bar,
         -- baz,
         quux.

The suppressed goals are replaced by calls to ‘true/0’.


File: TheLogtalkHandbook-3.100.1.info,  Node: html,  Next: ica_projection,  Prev: hook_objects,  Up: Libraries

6.89 ‘html’
===========

This library provides predicates for generating HTML content using
either HTML 5 or XHTML 1.1 formats from a term representation.  The
library performs minimal validation, checking only that all elements are
valid.  No attempt is made to generate nicely indented output.

Normal elements are represented using a compound term with one argument
(the element content) or two arguments (the element attributes
represented by a list of ‘Key=Value’ or ‘Key-Value’ pairs and the
element content).  The element content can be another element or a list
of elements.  For example:

     ol([type-a], [li(foo), li(bar), li(baz)])

The two exceptions are the ‘pre’ or ‘code’ elements whose content is
never interpreted as an element or a list of elements.  For example, the
fragment:

     pre([foo,bar,baz])

is translated to:

     <pre>
     [foo,bar,baz]
     </pre>

Void elements are represented using a compound term with one argument,
the (possibly empty) list of attributes represented by a list of
‘Key=Value’ or ‘Key-Value’ pairs.  For example:

     hr([class-separator])

Atomic arguments of the compound terms are interpreted as element
content.  Non-atomic element content can be represented as a quoted atom
or by using the ‘pre’ or ‘code’ elements as explained above.

This library is a work in progress.

* Menu:

* API documentation: API documentation<108>.
* Loading: Loading<109>.
* Testing: Testing<101>.
* Generating a HTML document::
* Generating a HTML fragment::
* Working with callbacks to generate content::
* Working with custom elements::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<108>,  Next: Loading<109>,  Up: html

6.89.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#html’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<109>,  Next: Testing<101>,  Prev: API documentation<108>,  Up: html

6.89.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(html(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<101>,  Next: Generating a HTML document,  Prev: Loading<109>,  Up: html

6.89.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(html(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating a HTML document,  Next: Generating a HTML fragment,  Prev: Testing<101>,  Up: html

6.89.4 Generating a HTML document
---------------------------------

HTML documents can be generated from a compound term representation and
written to a file or a stream.  For example, assuming we want to
generate a HTML 5 file:

     | ?- html5::generate(
              file('hello.html'),
              html([lang=en], [head(title('Hello world!')), body(p('Bye!'))])
          ).

When the second argument is a ‘html/1’ or ‘html/2’ compound term, a
'doctype' is automatically written.  If we prefer instead e.g.  a XHTML
1.1 document, we use the ‘xhtml11’ object:

     | ?- xhtml11::generate(
              file('hello.html'),
              html([lang=en], [head(title('Hello world!')), body(p('Bye!'))])
          ).


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating a HTML fragment,  Next: Working with callbacks to generate content,  Prev: Generating a HTML document,  Up: html

6.89.5 Generating a HTML fragment
---------------------------------

It’s also possible to generate just a fragment of a (X)HTML document by
using a list of compound terms or a compound term for an element other
than ‘html’.  For example:

     | ?- current_output(Stream),
          html5::generate(stream(Stream), ul([li(foo), li(bar), li(baz)])).

     <ul>
     <li>
     foo</li>
     <li>
     bar</li>
     <li>
     baz</li>
     </ul>

     Stream = ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Working with callbacks to generate content,  Next: Working with custom elements,  Prev: Generating a HTML fragment,  Up: html

6.89.6 Working with callbacks to generate content
-------------------------------------------------

Often we need to programmatically generate HTML content from queries.
In other cases, we may have fixed content that we don’t want to keep
repeating (e.g., a navigation bar).  The library supports a ‘(::)/2’
pseudo-element that sends a message to an object to retrieve content.
As an example, assume the following predicate definition in ‘user’:

     content(strong('Hello world!')).

This predicate can then be called from the HTML term representation.
For example:

     | ?- current_output(Stream),
          html5::generate(stream(Stream), span(user::content)).

     <span><strong>Hello world!</strong></span>

     Stream = ...

Note that the callback always takes the form ‘Object::Closure’ where
‘Closure’ is extended with a single argument (to be bound to the
generated content).  More complex callbacks are possible by using lambda
expressions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Working with custom elements,  Prev: Working with callbacks to generate content,  Up: html

6.89.7 Working with custom elements
-----------------------------------

The ‘html5’ and ‘xhtml11’ objects recognize the same set of standard
HTML 5 normal and void elements and generate an error for non-standard
elements.  If you need to generate HTML content containing custom
elements, define a new object that extends one of the library objects.
For example:

     :- object(html5custom,
         extends(html5)).

         normal_element(foo, inline).
         normal_element(bar, block).
         normal_element(Name, Display) :-
             ^^normal_element(Name, Display).

     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: ica_projection,  Next: ids,  Prev: html,  Up: Libraries

6.90 ‘ica_projection’
=====================

Independent Component Analysis reducer for continuous datasets (missing
or non-numeric values are rejected).  The library implements the
‘dimension_reducer_protocol’ defined in the
‘dimension_reduction_protocols’ library and learns a linear unmixing
projection by centering the training data, optionally standardizing
continuous attributes, whitening the covariance matrix using the shared
deterministic symmetric eigen-decomposition from ‘linear_algebra’, and
then extracting independent components using a deterministic cubic
FastICA fixed-point iteration with orthogonal deflation.

* Menu:

* API documentation: API documentation<109>.
* Loading: Loading<110>.
* Testing: Testing<102>.
* Features: Features<29>.
* Options: Options<27>.
* Usage: Usage<50>.
* Dimension reducer representation::
* References: References<18>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<109>,  Next: Loading<110>,  Up: ica_projection

6.90.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#ica_projection’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<110>,  Next: Testing<102>,  Prev: API documentation<109>,  Up: ica_projection

6.90.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ica_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<102>,  Next: Features<29>,  Prev: Loading<110>,  Up: ica_projection

6.90.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ica_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<29>,  Next: Options<27>,  Prev: Testing<102>,  Up: ica_projection

6.90.4 Features
---------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Shared Symmetric Whitening Plus Fixed-Point ICA': Whitens the
     training covariance matrix using the shared symmetric
     eigendecomposition from ‘linear_algebra’ and then extracts
     independent directions using deterministic cubic FastICA with
     orthogonal deflation.

   - 'Always Centered': Training and transform inputs are always
     centered using the training-set means before whitening and
     projection.

   - 'Optional Scaling': Can optionally standardize each continuous
     attribute before whitening.

   - 'Training Diagnostics': Records whitening eigenvalues plus
     per-component convergence reasons, iteration counts, and final
     deltas.

   - 'Projection API': Transforms a new instance into a list of
     ‘component_N-Value’ pairs.

   - 'Model Export': Learned reducers can be exported as predicate
     clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<27>,  Next: Usage<50>,  Prev: Features<29>,  Up: ica_projection

6.90.5 Options
--------------

The ‘learn/3’ predicate accepts the following options:

   - ‘n_components/1’: Number of independent components to extract.
     Because training data is always centered, requests that exceed
     ‘min(feature_count, sample_count - 1)’ raise
     ‘domain_error(component_count, Requested-Maximum)’.  Requests that
     still exceed the numerical rank of the whitened covariance matrix
     raise ‘domain_error(component_count, Requested-Extracted)’.  The
     default is ‘2’.

   - ‘feature_scaling/1’: Whether to divide each continuous attribute by
     its training-set standard deviation before whitening.  Options:
     ‘true’ or ‘false’ (default).

   - ‘maximum_iterations/1’: Maximum iteration bound used both by the
     whitening eigensolver and by the FastICA fixed-point steps for each
     independent component.  The default is ‘1000’.

   - ‘tolerance/1’: Positive convergence tolerance used both for
     whitening rank detection and for FastICA fixed-point stopping.  The
     default is ‘1.0e-8’.

The learned diagnostics also include:

   - ‘whitening_eigenvalues(Values)’: Eigenvalues used to build the
     whitening transform, aligned with the extracted components.

   - ‘convergence(Statuses)’: Per-component stop reasons, such as
     ‘tolerance’ or ‘maximum_iterations_exhausted’.

   - ‘iterations(Counts)’: Per-component iteration counts aligned with
     the extracted components.

   - ‘final_delta(Deltas)’: Per-component final update magnitudes
     aligned with the extracted components.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<50>,  Next: Dimension reducer representation,  Prev: Options<27>,  Up: ica_projection

6.90.6 Usage
------------

The following examples use the sample dataset shipped with the
‘dimension_reduction_protocols’ library:

     | ?- logtalk_load(dimension_reduction_protocols('test_datasets/mixed_independent_sources')).

* Menu:

* Learning a reducer::
* Transforming new instances::
* Exporting and reusing the reducer::


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a reducer,  Next: Transforming new instances,  Up: Usage<50>

6.90.6.1 Learning a reducer
...........................

     | ?- ica_projection::learn(mixed_independent_sources, DimensionReducer).

     | ?- ica_projection::learn(mixed_independent_sources, DimensionReducer, [n_components(2), feature_scaling(true), maximum_iterations(200), tolerance(1.0e-7)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transforming new instances,  Next: Exporting and reusing the reducer,  Prev: Learning a reducer,  Up: Usage<50>

6.90.6.2 Transforming new instances
...................................

     | ?- ica_projection::learn(mixed_independent_sources, DimensionReducer),
          ica_projection::transform(DimensionReducer, [x1-(-5.0), x2-(-4.0), x3-(-4.0)], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting and reusing the reducer,  Prev: Transforming new instances,  Up: Usage<50>

6.90.6.3 Exporting and reusing the reducer
..........................................

     | ?- ica_projection::learn(mixed_independent_sources, DimensionReducer, [n_components(2)]),
          ica_projection::export_to_file(mixed_independent_sources, DimensionReducer, reducer, 'ica_reducer.pl').

     | ?- logtalk_load('ica_reducer.pl'),
          reducer(Reducer),
          ica_projection::transform(Reducer, [x1-(-5.0), x2-(-4.0), x3-(-4.0)], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation,  Next: References<18>,  Prev: Usage<50>,  Up: ica_projection

6.90.7 Dimension reducer representation
---------------------------------------

The learned dimension reducer is represented by a compound term with the
functor chosen by the implementation and arity 3.  For example:

     ica_reducer(Encoders, Components, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, centering offset, and scale factor.

   - ‘Components’: List of learned unmixing vectors in feature space.

   - ‘Diagnostics’: Learned reducer metadata including the effective
     training options, whitening eigenvalues, and per-component
     convergence information.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<18>,  Prev: Dimension reducer representation,  Up: ica_projection

6.90.8 References
-----------------

  1. Hyvarinen, A. and Oja, E. (2000) - “Independent Component Analysis:
     Algorithms and Applications”.


File: TheLogtalkHandbook-3.100.1.info,  Node: ids,  Next: ieee_754,  Prev: ica_projection,  Up: Libraries

6.91 ‘ids’
==========

This library generates random identifiers given the number of bytes of
randomness.  The identifiers are Base64 encoded.  By default, 20 bytes
(160 bits) are used.

The generation of random identifiers uses the ‘/dev/urandom’ random
number generator when available.  This includes macOS, Linux, *BSD, and
other POSIX operating-systems.  On Windows, a pseudo-random generator is
used, but randomized using the current wall time.

Identifiers can be generated as atoms, lists of characters, or lists of
character codes.

See also the ‘cuid2’, ‘ksuid’, ‘nanoid’, ‘snowflakeid’, ‘uuid’, and
‘ulid’ libraries.

* Menu:

* API documentation: API documentation<110>.
* Loading: Loading<111>.
* Testing: Testing<103>.
* Usage: Usage<51>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<110>,  Next: Loading<111>,  Up: ids

6.91.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#ids’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<111>,  Next: Testing<103>,  Prev: API documentation<110>,  Up: ids

6.91.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ids(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<103>,  Next: Usage<51>,  Prev: Loading<111>,  Up: ids

6.91.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ids(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<51>,  Prev: Testing<103>,  Up: ids

6.91.4 Usage
------------

To generate an identifier using the default 160 bits of randomness:

     | ?- ids::generate(Identifier).
     Identifier = '2gpMzqAFXBO5mYFIPX1qMkHxgGE='
     yes

To generate an identifier represented by an atom using 240 bits (30
bytes) of randomness:

     | ?- ids(atom, 30)::generate(Identifier).
     Identifier = 'ie/jYcLsqo8ZguCOF1ZNPFDRvJ03Ww5Qa9e0FxRB'
     yes

To generate an identifier represented by a list of characters using 64
bits (8 bytes) of randomness:

     | ?- ids(chars, 8)::generate(Identifier).
     Identifier = ['5','0','8','V',d,'S',c,y,n,o,'A',=]
     yes

To generate an identifier represented by a list of character codes using
64 bits (8 bytes) of randomness:

     | ?- ids(codes, 8)::generate(Identifier).
     Identifier = [111,81,86,55,99,79,70,77,65,74,103,61]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: ieee_754,  Next: intervals,  Prev: ids,  Up: Libraries

6.92 ‘ieee_754’
===============

The ‘ieee_754’ library is a support package for parsing and generating
IEEE 754 floating-point encodings shared by binary interchange libraries
such as ‘message_pack’, ‘avro’, ‘protobuf’, ‘cbor’, and ‘wkt_wkb’.

* Menu:

* Loading: Loading<112>.
* Testing: Testing<104>.
* Object model::
* Value representation::
* Public API: Public API<2>.
* Semantics::


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<112>,  Next: Testing<104>,  Up: ieee_754

6.92.1 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ieee_754(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<104>,  Next: Object model,  Prev: Loading<112>,  Up: ieee_754

6.92.2 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ieee_754(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Object model,  Next: Value representation,  Prev: Testing<104>,  Up: ieee_754

6.92.3 Object model
-------------------

The library provides two parameterized implementation objects:

     `ieee_754(Precision, ByteOrder, NaNRepresentation)`

‘ieee_754_fields(Precision, ByteOrder)’

with the following parameter values:

   - ‘Precision’: ‘half’, ‘single’, or ‘double’

   - ‘ByteOrder’: ‘big’ or ‘little’

   - ‘NaNRepresentation’: ‘canonical’ or ‘payloads’

The parameterization keeps format-specific policy out of the shared
core.  Advanced callers can use ‘ieee_754_fields’ to inspect exact sign,
exponent, mantissa, finite binary-rational decompositions, and NaN
payload bits without going through backend float values.


File: TheLogtalkHandbook-3.100.1.info,  Node: Value representation,  Next: Public API<2>,  Prev: Object model,  Up: ieee_754

6.92.4 Value representation
---------------------------

The intended term representation is:

   - finite values: backend Prolog floats

   - positive infinity: ‘@infinity’

   - negative infinity: ‘@negative_infinity’

   - canonical NaN: ‘@not_a_number’

   - payload-preserving NaN values: ‘not_a_number(Bytes)’

The ‘not_a_number(Bytes)’ representation is only intended to be accepted
and produced by objects configured with ‘NaNRepresentation = payloads’.

Under the ‘payloads’ policy, decoding a canonical quiet NaN should still
yield ‘@not_a_number’.  Non-canonical NaN encodings should decode to
‘not_a_number(Bytes)’ using canonical byte order for the selected
precision.

The high-level ‘ieee_754/3’ object API deliberately abstracts away the
IEEE 754 quiet-versus-signaling NaN distinction.  In ‘canonical’ mode,
all NaN encodings decode to ‘@not_a_number’.  In ‘payloads’ mode, the
designated canonical quiet NaN encoding decodes to ‘@not_a_number’ while
all other NaN encodings decode to ‘not_a_number(Bytes)’ for roundtrip
preservation.  Callers that need exact NaN inspection should use
‘ieee_754_fields/2’ object API.


File: TheLogtalkHandbook-3.100.1.info,  Node: Public API<2>,  Next: Semantics,  Prev: Value representation,  Up: ieee_754

6.92.5 Public API
-----------------

The high-level value API is defined in ‘ieee_754_protocol.lgt’ and
consists of:

   - ‘parse/2’ Decodes ‘bytes(Bytes)’ or ‘bits(Bits)’ into a value term.

   - ‘generate/2’ Encodes a value term into ‘bytes(Bytes)’ or
     ‘bits(Bits)’.

   - ‘generate/3’ Encodes a value term to a byte list with an open tail
     for difference-list based binary generators.

   - ‘valid/1’ Checks whether a term is a valid value representation for
     the selected object.

   - ‘exactly_representable/1’ Checks whether a term can be encoded and
     decoded in the selected precision without loss of value
     information.

   - ‘precision/1’ Returns the selected precision.

   - ‘order/1’ Returns the selected byte order.

   - ‘nan_representation/1’ Returns the selected NaN representation
     policy.

   - ‘byte_count/1’ Returns the number of bytes used by the selected
     precision.

The low-level exact field API is defined in
‘ieee_754_fields_protocol.lgt’ and consists of:

   - ‘classify/2’ Classifies ‘bytes(Bytes)’ or ‘bits(Bits)’ as ‘zero’,
     ‘subnormal’, ‘normal’, ‘infinity’, or ‘not_a_number’.

   - ‘fields/5’ Extracts the exact sign bit, exponent bits, mantissa
     bits, and class.

   - ‘finite_binary_rational/4’ Extracts finite encodings as exact
     ‘(-1)^Sign * Significand * 2^Exponent’ terms.

   - ‘nan_payload/2’ Extracts the raw NaN mantissa payload bits.

   - ‘nan_kind/2’ Classifies a NaN encoding as ‘quiet’ or ‘signaling’.

   - ‘precision/1’ Returns the selected precision.

   - ‘order/1’ Returns the selected byte order.

   - ‘byte_count/1’ Returns the number of bytes used by the selected
     precision.


File: TheLogtalkHandbook-3.100.1.info,  Node: Semantics,  Prev: Public API<2>,  Up: ieee_754

6.92.6 Semantics
----------------

The intended shared semantics are:

   - finite encoding rounds according to the selected IEEE 754 precision

   - ‘exactly_representable/1’ succeeds only when no value information
     is lost

   - signed zero is preserved when supported by the backend Prolog
     compiler

   - infinities and NaN values are represented independently from
     backend float syntax

   - subnormal values are supported for all selected precisions

   - payload-preserving NaN decoding is available when explicitly
     requested

   - the ‘ieee_754_fields’ API works from exact encodings and therefore
     does not depend on backend float decomposition behavior

   - exact quiet/signaling NaN inspection is exposed by
     ‘ieee_754_fields/2’ instead of the high-level value codec API


File: TheLogtalkHandbook-3.100.1.info,  Node: intervals,  Next: iqr_anomaly_detector,  Prev: ieee_754,  Up: Libraries

6.93 ‘intervals’
================

This library provides:

   - an ‘interval_protocol’ protocol and an ‘interval’ object
     implementing the 13 Allen base interval relations plus interval
     pair classification using ‘relation/3’

   - an ‘interval_algebra_protocol’ protocol and an ‘interval_algebra’
     object implementing Allen relation algebra predicates over the 13
     base relation atoms

   - an ‘interval_relation_set_protocol’ protocol and an
     ‘interval_relation_set’ object implementing canonical relation-set
     operations over Allen base relation atoms

   - an ‘interval_constraint_network_protocol’ protocol and an
     ‘interval_constraint_network’ object implementing first interval
     constraint-network predicates over canonical relation sets,
     including batch refinement, explanation lists, and network
     inspection/comparison helpers

The ‘interval’ object works on interval terms represented as ‘i(Start,
End)’.  The ‘interval_algebra’ object works on relation atoms such as
‘before’, ‘overlaps’, and ‘contains’.  The ‘interval_relation_set’
object works on canonical ordered duplicate-free lists of relation
atoms.  The ‘interval_constraint_network’ object works on
‘network(Nodes, Constraints)’ terms whose pair constraints are relation
sets.  Internally, the ‘interval_constraint_network’ object compiles
that public representation to an a dense indexed form for propagation
and for most query operations, while still returning ordinary
‘network/2’ terms at the API boundary.

The ‘interval_algebra::compose/3’ predicate returns canonical ordered
duplicate-free lists of base relation atoms.

* Menu:

* Practical limits::
* API documentation: API documentation<111>.
* Loading: Loading<113>.
* Testing: Testing<105>.
* Examples: Examples<171>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Practical limits,  Next: API documentation<111>,  Up: intervals

6.93.1 Practical limits
-----------------------

The ‘interval_constraint_network’ object is intended for small-to-medium
symbolic networks.  It uses a complete ‘network(Nodes, Constraints)’
representation, so the number of stored pair constraints grows
quadratically with the number of nodes.  Propagation is based on path
consistency and now uses an internal dense indexed representation with
direct pair access, a reverse node-to-index table, and scheduled-pair
tracking to avoid repeated linear worklist duplicate checks.  This
substantially reduces overhead relative to a purely list-based
implementation, but the representation is still dense and updates still
rebuild parts of the internal matrix before the result is decompiled
back to a public ‘network/2’ term.

In practice, the network predicates are suitable for moderate
qualitative temporal reasoning workloads, but they should not be treated
as a large-scale or latency-sensitive temporal CSP solver.  Exact limits
depend on the Prolog backend, network density, how often closure is
recomputed, and how often callers invoke single-step API operations that
must compile or decompile the public network representation.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<111>,  Next: Loading<113>,  Prev: Practical limits,  Up: intervals

6.93.2 API documentation
------------------------

Open the ‘../../apis/library_index.html#intervals’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<113>,  Next: Testing<105>,  Prev: API documentation<111>,  Up: intervals

6.93.3 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(intervals(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<105>,  Next: Examples<171>,  Prev: Loading<113>,  Up: intervals

6.93.4 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(intervals(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<171>,  Prev: Testing<105>,  Up: intervals

6.93.5 Examples
---------------

Classify two valid intervals according to their unique Allen base
relation:

     | ?- interval::new(1, 3, I1), interval::new(3, 5, I2), interval::relation(I1, I2, Relation).
     Relation = meets.

Compose two Allen base relation atoms:

     | ?- interval_algebra::compose(meets, met_by, Relations).
     Relations = [finishes, finished_by, equal].

Normalize an Allen relation set:

     | ?- interval_relation_set::normalize([during, before, during], RelationSet).
     RelationSet = [before, during].

Propagate interval constraints across a small symbolic network:

     | ?- interval_constraint_network::new([a, b, c], Network0),
          interval_constraint_network::refine(Network0, a, b, [before], Network1),
          interval_constraint_network::refine(Network1, b, c, [before], Network2),
          interval_constraint_network::path_consistency(Network2, Network3),
          interval_constraint_network::relation(Network3, a, c, RelationSet).
     RelationSet = [before].

Check whether a query is entailed by the current symbolic constraints:

     | ?- interval_constraint_network::entails(Network3, a, c, [before, meets]).
     true.

Inspect a simple explanation for an entailed relation:

     | ?- interval_constraint_network::entails(Network3, a, c, [before], Explanation).
     Explanation = propagated(b, [before], [before], [before]).

Inspect a simple contradiction explanation after closure:

     | ?- interval_constraint_network::contradiction(Closure, Explanation).
     Explanation = contradiction(a, c, propagated(b, [before], [before], [before])).

Refine and propagate in a single operation that fails on contradiction:

     | ?- interval_constraint_network::new([a, b, c], Network0),
          interval_constraint_network::refine_propagate(Network0, a, b, [before], Network1).
     Network1 = ...

Post a batch of constraints and propagate them in one step:

     | ?- interval_constraint_network::refine_propagate(Network0, [constraint(a, b, [before]), constraint(b, c, [before])], Network1).
     Network1 = ...

Collect direct and propagated changes while propagating:

     | ?- interval_constraint_network::propagate(Network2, Network3, Changes).
     Changes = [...].

Query which node triples caused the propagated refinements:

     | ?- interval_constraint_network::propagation_triples(Changes, Triples).
     Triples = [triple(a, b, c)].

List all immediate explanations supporting an entailed query:

     | ?- interval_constraint_network::entailment_explanations(Network3, a, c, [before, meets], Explanations).
     Explanations = [propagated(b, [before], [before], [before])].

List all contradiction explanations currently present in an inconsistent
network:

     | ?- interval_constraint_network::contradiction_explanations(Closure, Explanations).
     Explanations = [...].

Inspect a closure and compare networks by generality or equivalence:

     | ?- interval_constraint_network::constraints(Network3, Constraints).
     Constraints = [constraint(a, b, [before]), constraint(a, c, [before]), constraint(b, c, [before])].

     | ?- interval_constraint_network::subsumes(Network0, Network3).
     true.

     | ?- interval_constraint_network::equivalent(Network3, Network5).
     true.


File: TheLogtalkHandbook-3.100.1.info,  Node: iqr_anomaly_detector,  Next: iso_639,  Prev: intervals,  Up: Libraries

6.94 ‘iqr_anomaly_detector’
===========================

Statistical interquartile-range anomaly detector for continuous
datasets.  It is a statistical anomaly-detection method based on Tukey
interquartile fences: for each known continuous attribute value it
learns ‘Q1’ and ‘Q3’, computes the exceedance beyond ‘[Q1,Q3]’ in
interquartile-range units normalized by the learned
‘fence_multiplier/1’, and then aggregates the per-attribute normalized
deviations according to ‘score_mode/1’, so any value at or beyond ‘[Q1 -
k*IQR, Q3 + k*IQR]’ reaches the default anomaly boundary when using
‘fence_multiplier(k)’.

The library implements the ‘anomaly_detector_protocol’ defined in the
‘anomaly_detection_protocols’ library.  It learns a detector from a
continuous dataset, computes anomaly scores for new instances, predicts
‘normal’ or ‘anomaly’, and exports learned detectors as clauses or
files.

Datasets are represented as objects implementing the
‘anomaly_dataset_protocol’ protocol from the
‘anomaly_detection_protocols’ library.  See the
‘anomaly_detection_protocols/test_datasets’ directory for examples.

* Menu:

* API documentation: API documentation<112>.
* Loading: Loading<114>.
* Testing: Testing<106>.
* Features: Features<30>.
* Options: Options<28>.
* Detector representation: Detector representation<3>.
* Notes: Notes<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<112>,  Next: Loading<114>,  Up: iqr_anomaly_detector

6.94.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#iqr_anomaly_detector’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<114>,  Next: Testing<106>,  Prev: API documentation<112>,  Up: iqr_anomaly_detector

6.94.2 Loading
--------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(iqr_anomaly_detector(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<106>,  Next: Features<30>,  Prev: Loading<114>,  Up: iqr_anomaly_detector

6.94.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(iqr_anomaly_detector(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<30>,  Next: Options<28>,  Prev: Testing<106>,  Up: iqr_anomaly_detector

6.94.4 Features
---------------

   - 'Statistical method': implements anomaly detection based on
     interquartile-range fences, using per-attribute first and third
     quartiles to measure how far new observations deviate from the
     central baseline distribution.

   - 'Quartile-based scoring': for each known attribute value ‘x’, the
     library computes the positive exceedance of ‘x’ beyond the interval
     ‘[Q1, Q3]’ in interquartile-range units, where ‘Q1’ and ‘Q3’ are
     the learned sample quartiles.

   - 'Continuous features only': accepts datasets whose declared
     attributes are all ‘continuous’.

   - 'Robust statistics': reuses the ‘statistics’ library ‘sample’
     object ‘quartiles/4’ predicate to compute per-attribute quartiles.

   - 'Baseline training selection': supports learn-time
     ‘baseline_class_values(ClassValues)’ and
     ‘baseline_selection_policy(Policy)’ options.  The default baseline
     class values are ‘[normal]’.  The default ‘reject’ policy throws an
     error if non-baseline examples are present, while ‘filter’ removes
     them before fitting.

   - 'Missing-value tolerant': ignores missing values when fitting
     attribute statistics.  During scoring, queries must provide at
     least one known value.  In the default
     ‘score_mode(root_mean_square)’, the raw score is aggregated over
     attributes with positive normalized deviation so that neutral
     inlier attributes do not dilute fence anomalies.  The learned
     detector stores a precomputed attribute schema so that scoring
     reuses the same attribute ordering without rebuilding it on every
     call.

   - 'Configurable scoring semantics': supports both dense multivariate
     deviation scoring using ‘score_mode(root_mean_square)’ and sparse
     anomaly detection using ‘score_mode(any_feature_extreme)’.  The
     default root-mean-square mode reuses the ‘numberlist’ library
     Euclidean norm predicate as part of the computation.

   - 'Configurable Tukey fences': supports a learn-time
     ‘fence_multiplier/1’ option.  The default ‘1.5’ corresponds to the
     classical Tukey inner fence cutoff, and the learned multiplier is
     applied directly in the score path.

   - 'Bounded scoring': maps the raw multivariate IQR score to ‘[0.0,
     1.0)’ using ‘Score = Raw / (1 + Raw)’.

   - 'Default threshold': the default ‘anomaly_threshold(0.5)’
     corresponds to the learned Tukey fence cutoff after score scaling,
     while remaining overrideable in ‘learn/3’ and ‘predict/4’.

   - 'Learn-time options': ‘fence_multiplier/1’ and ‘score_mode/1’ are
     recorded in the learned detector and reused for subsequent scoring
     and prediction.  Passing either option to ‘predict/4’ does not
     override the learned value.

   - 'All-missing queries rejected': scoring and prediction throw a
     ‘domain_error(non_empty_known_values, AttributeNames)’ exception
     when every declared feature is missing in the query.

   - 'Featureless datasets rejected': datasets must declare at least one
     continuous feature; otherwise ‘learn/2-3’ throws a
     ‘domain_error(non_empty_features, Dataset)’ exception.

   - 'Detector export': learned detectors can be exported as predicate
     clauses.

   - 'Explicit validation and diagnostics': supports the shared
     ‘check_anomaly_detector/1’, ‘valid_anomaly_detector/1’,
     ‘diagnostics/2’, ‘diagnostic/2’, and ‘anomaly_detector_options/2’
     predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<28>,  Next: Detector representation<3>,  Prev: Features<30>,  Up: iqr_anomaly_detector

6.94.5 Options
--------------

The following options are supported by the public API:

   - ‘anomaly_threshold(Threshold)’: Threshold for ‘predict/3-4’
     (default: ‘0.5’)

   - ‘baseline_class_values(ClassValues)’: Learn-time class labels that
     are admissible for baseline fitting (default: ‘[normal]’)

   - ‘baseline_selection_policy(Policy)’: Learn-time handling of
     examples whose class is not listed in ‘baseline_class_values/1’.
     Supported values are ‘filter’ and ‘reject’ (default: ‘reject’)

   - ‘fence_multiplier(Multiplier)’: Learn-time Tukey fence multiplier
     stored in the learned detector (default: ‘1.5’)

   - ‘score_mode(Mode)’: Learn-time score aggregation mode for
     ‘learn/3’.  Supported values are ‘root_mean_square’ and
     ‘any_feature_extreme’ (default: ‘root_mean_square’).  If passed to
     ‘predict/4’, it is ignored and the value stored in the learned
     detector is used.


File: TheLogtalkHandbook-3.100.1.info,  Node: Detector representation<3>,  Next: Notes<7>,  Prev: Options<28>,  Up: iqr_anomaly_detector

6.94.6 Detector representation
------------------------------

The learned detector is represented by default as:

     iqr_detector(TrainingDataset, AttributeSchema, Encoders, Diagnostics)

Where:

   - ‘TrainingDataset’: training dataset object identifier

   - ‘AttributeSchema’: precomputed attribute ordering used for
     validation and scoring

   - ‘Encoders’: list of ‘iqr_anomaly_detector(Attribute, Q1, Q3,
     Scale)’ records

   - ‘Diagnostics’: learned metadata terms including ‘model/1’,
     ‘training_dataset/1’, ‘attribute_names/1’, ‘feature_count/1’,
     ‘example_count/1’, and ‘options/1’

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
detector term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<7>,  Prev: Detector representation<3>,  Up: iqr_anomaly_detector

6.94.7 Notes
------------

Scoring has three stages.  First, the detector computes one
per-attribute IQR deviation score for each known attribute value using
its exceedance beyond the interval ‘[Q1, Q3]’ in interquartile-range
units.  Second, each per-attribute score is normalized by the learned
‘fence_multiplier/1’, so that it reaches ‘1.0’ exactly at the chosen
Tukey fence cutoff.  Third, those normalized per-attribute scores are
aggregated into a single raw deviation score according to the learned
‘score_mode/1’ option before being mapped to the interval ‘[0.0, 1.0)’
using ‘Score = Raw / (1 + Raw)’.

The ‘score_mode/1’ option does not change the per-attribute quartile
formula.  It only changes the aggregation step.  With
‘score_mode(root_mean_square)’, the raw score is the root mean square of
the positive normalized per-attribute deviations, computed over the
attributes with positive deviation so that inlier padding does not
dilute fence-reaching anomalies.  With
‘score_mode(any_feature_extreme)’, the raw score is the maximum
normalized per-attribute deviation.

The ‘fence_multiplier/1’ option defines the classical Tukey anomaly
cutoff and directly normalizes the per-attribute deviation scores.  With
any learned ‘fence_multiplier(K)’, a per-attribute score of ‘1.0’ means
the query has reached the chosen Tukey fence on that attribute, so the
default normalized threshold ‘0.5’ corresponds to that cutoff in both
supported aggregation modes.

The ‘baseline_class_values/1’ option declares which dataset class labels
are admissible for fitting the baseline quartiles and interquartile
ranges.  The ‘baseline_selection_policy/1’ option then controls what
happens when other labels are present in the training data.  The default
‘reject’ policy raises a ‘domain_error(baseline_only_training_data,
Dataset)’ exception when any non-baseline example is found.  The
‘filter’ policy removes non-baseline examples before fitting.

Attributes with zero observed interquartile range are assigned a
fallback scale of ‘1.0’.  This keeps the detector well-defined for
singleton datasets or constant columns while still yielding zero score
for matching values and positive scores for deviating values.

The root-mean-square aggregation keeps the default threshold stable
while avoiding dilution from missing or neutral inlier attributes.

Use ‘score_mode(any_feature_extreme)’ when a single extreme feature
should be sufficient to flag an anomaly in high-dimensional data.


File: TheLogtalkHandbook-3.100.1.info,  Node: iso_639,  Next: iso_3166,  Prev: iqr_anomaly_detector,  Up: Libraries

6.95 ‘iso_639’
==============

This library provides ISO 639 sets 1, 2, 3, and 5 lookups generated from
the Library of Congress and SIL maintenance-agency sources.  It requires
Unicode support from the backend Prolog compiler.

The set 1 and set 2 data are generated from the Library of Congress ISO
639-2 code list.  The set 3 data are generated from the SIL
tab-delimited code set download.  The set 5 data are generated from the
Library of Congress ISO 639-5 identifier list.

The refresh tooling lives in ‘library/iso_639/scripts/’ together with
the checked-in source snapshots used to regenerate the fact tables using
shell scripts only.

* Menu:

* API documentation: API documentation<113>.
* Loading: Loading<115>.
* Testing: Testing<107>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<113>,  Next: Loading<115>,  Up: iso_639

6.95.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#iso_639’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<115>,  Next: Testing<107>,  Prev: API documentation<113>,  Up: iso_639

6.95.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(iso_639(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<107>,  Prev: Loading<115>,  Up: iso_639

6.95.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(iso_639(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: iso_3166,  Next: iso_4217,  Prev: iso_639,  Up: Libraries

6.96 ‘iso_3166’
===============

This library provides generated ISO 3166 country and subdivision code
lookups.  The current worktree includes a real ISO 3166-1 fact table
generated from the official United Nations M49 overview page, which
republishes ISO alpha-2 and alpha-3 country codes together with the M49
numeric codes used here.  It requires Unicode support from the backend
Prolog compiler.

ISO 3166-2 subdivision data is bundled in the public facade and
generated from the Debian ‘iso-codes’ machine-readable JSON snapshot.
Subdivision codes and country alpha-2 codes are stored as lowercase
atoms to match the conventions used by the generated ISO 3166-1 country
fact table, while names and categories preserve the source spelling.

To refresh the generated subdivision table, run:

     $ library/iso_3166/scripts/update_iso_3166_2.sh

* Menu:

* API documentation: API documentation<114>.
* Loading: Loading<116>.
* Testing: Testing<108>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<114>,  Next: Loading<116>,  Up: iso_3166

6.96.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#iso_3166’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<116>,  Next: Testing<108>,  Prev: API documentation<114>,  Up: iso_3166

6.96.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(iso_3166(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<108>,  Prev: Loading<116>,  Up: iso_3166

6.96.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(iso_3166(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: iso_4217,  Next: iso_9362,  Prev: iso_3166,  Up: Libraries

6.97 ‘iso_4217’
===============

This library provides ISO 4217 active non-fund currency code lookups
generated from the authoritative SIX maintenance-agency XML list
together with active fund currency code lookups.  It requires Unicode
support from the backend Prolog compiler.

The generated fact table keeps one entry per XML row with a currency
code, therefore preserving entity-specific assignments for shared
currencies such as the Euro or the US Dollar.  Rows marked by SIX as
fund entries are exposed using the ‘fund_currency/5’ predicate while the
‘currency/5’ predicate remains scoped to non-fund entries.  Minor units
are represented either as integers or the atom ‘na’ when the source
lists ‘N.A.’.

* Menu:

* API documentation: API documentation<115>.
* Loading: Loading<117>.
* Testing: Testing<109>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<115>,  Next: Loading<117>,  Up: iso_4217

6.97.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#iso_4217’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<117>,  Next: Testing<109>,  Prev: API documentation<115>,  Up: iso_4217

6.97.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(iso_4217(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<109>,  Prev: Loading<117>,  Up: iso_4217

6.97.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(iso_4217(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: iso_9362,  Next: iso_13616,  Prev: iso_4217,  Up: Libraries

6.98 ‘iso_9362’
===============

This library provides ISO 9362 Business Identifier Code (BIC) structure
parsing and normalization based on the public Swift and ISO 9362
documentation.  It requires Unicode support from the backend Prolog
compiler.

The current public implementation focuses on the normative structure
that Swift and ISO 9362 publish openly: a BIC consists of a 4-character
business party prefix, a 2-character ISO 3166-1 alpha-2 country code, a
2-character business party suffix, and an optional 3-character branch
identifier.  Eight-character primary-office BICs are normalized to the
branch code ‘XXX’.

This library does not currently ship the full ISO 9362 directory as
facts.  The public SwiftRef TXT directory download is available only
through a secure, time-limited email link, so it is not treated as an
automatable checked-in source snapshot in the same way as the ISO 4217
and ISO 639 libraries.

* Menu:

* API documentation: API documentation<116>.
* Loading: Loading<118>.
* Testing: Testing<110>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<116>,  Next: Loading<118>,  Up: iso_9362

6.98.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#iso_9362’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<118>,  Next: Testing<110>,  Prev: API documentation<116>,  Up: iso_9362

6.98.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(iso_9362(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<110>,  Prev: Loading<118>,  Up: iso_9362

6.98.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(iso_9362(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: iso_13616,  Next: isolation_forest_anomaly_detector,  Prev: iso_9362,  Up: Libraries

6.99 ‘iso_13616’
================

This library provides ISO 13616 International Bank Account Number (IBAN)
structure parsing, checksum validation, and normalization based on the
public ISO 13616 and Swift IBAN registry documentation.  It requires
Unicode support from the backend Prolog compiler.

The current public implementation includes a checked-in snapshot of the
public SWIFT IBAN registry for all currently registered IBAN countries.
Validation therefore checks:

   - the ISO 3166-1 alpha-2 country code

   - the country-specific total IBAN length

   - the country-specific BBAN structure pattern

   - the standard MOD-97 checksum

The checked-in registry facts use a derived Prolog segment
representation for BBAN patterns, e.g.  ‘[a-4, n-6, n-8]’ instead of the
original SWIFT text syntax ‘4!a6!n8!n’.  This keeps the published
structure information while making validation code simpler and more
direct.

The public API remains structural.  The library validates the published
national IBAN formats but does not attempt to ship any bank directory or
account existence data beyond the public registry pattern definitions.

* Menu:

* API documentation: API documentation<117>.
* Loading: Loading<119>.
* Testing: Testing<111>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<117>,  Next: Loading<119>,  Up: iso_13616

6.99.1 API documentation
------------------------

Open the ‘../../apis/library_index.html#iso_13616’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<119>,  Next: Testing<111>,  Prev: API documentation<117>,  Up: iso_13616

6.99.2 Loading
--------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(iso_13616(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<111>,  Prev: Loading<119>,  Up: iso_13616

6.99.3 Testing
--------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(iso_13616(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: isolation_forest_anomaly_detector,  Next: java,  Prev: iso_13616,  Up: Libraries

6.100 ‘isolation_forest_anomaly_detector’
=========================================

This library implements the Extended Isolation Forest (EIF) algorithm
for anomaly detection as described by Hariri et al.  (2019).  The
Extended Isolation Forest improves upon the original Isolation Forest
algorithm (Liu et al., 2008) by using random hyperplane cuts instead of
axis-aligned cuts, eliminating bias artifacts in anomaly scores along
coordinate axes.  Learning fits the forest from baseline training
examples selected from the dataset class labels.

The algorithm builds an ensemble of isolation trees (iTrees) by
recursively partitioning data using random hyperplanes.  Anomalous
points, being few and different from normal points, require fewer
partitions (shorter path lengths) to be isolated.  The anomaly score for
an instance is computed based on the average path length across all
trees in the forest.

Datasets are represented as objects implementing the
‘anomaly_dataset_protocol’ protocol from the
‘anomaly_detection_protocols’ library.  See the
‘anomaly_detection_protocols/test_datasets’ directory for examples.

* Menu:

* API documentation: API documentation<118>.
* Loading: Loading<120>.
* Testing: Testing<112>.
* Implemented features: Implemented features<2>.
* Options: Options<29>.
* Detector representation: Detector representation<4>.
* Limitations: Limitations<4>.
* References: References<19>.
* Usage: Usage<52>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<118>,  Next: Loading<120>,  Up: isolation_forest_anomaly_detector

6.100.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#isolation-forest’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<120>,  Next: Testing<112>,  Prev: API documentation<118>,  Up: isolation_forest_anomaly_detector

6.100.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(isolation_forest_anomaly_detector(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<112>,  Next: Implemented features<2>,  Prev: Loading<120>,  Up: isolation_forest_anomaly_detector

6.100.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(isolation_forest_anomaly_detector(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Implemented features<2>,  Next: Options<29>,  Prev: Testing<112>,  Up: isolation_forest_anomaly_detector

6.100.4 Implemented features
----------------------------

   - Extended Isolation Forest with random hyperplane cuts: splits are
     defined by random normal vectors and intercept points drawn from
     the data range, producing ‘(x - p) * n =< 0’ partitions that
     generalize to arbitrary orientations

   - Configurable extension level: level 0 corresponds to the original
     axis-aligned Isolation Forest; levels up to ‘d - 1’ (the default)
     use fully extended random hyperplanes where ‘d’ is the number of
     dimensions

   - Anomaly score computation following Liu et al.  (2008): ‘s(x) =
     2^(-E(h(x)) / c(psi))’ where ‘E(h(x))’ is the average path length
     across all trees, ‘c(psi)’ is the average path length of
     unsuccessful searches in a BST, and ‘psi’ is the subsample size

   - Handling of both continuous (numeric) and discrete (categorical)
     attributes: discrete attributes are mapped to numeric indices based
     on their position in the attribute value list declared by the
     dataset

   - Baseline training selection: ‘baseline_class_values/1’ declares
     which class labels are admissible for fitting the forest, while
     ‘baseline_selection_policy/1’ controls whether non-baseline
     examples are rejected (default) or filtered before training

   - Handling of missing attribute values (represented using anonymous
     variables): during tree construction, missing values are replaced
     with random values drawn from the observed range of the
     corresponding attribute; during scoring, each internal tree node
     stores its own feasible per-dimension bounds so that missing
     dimensions can be routed using subtree-local support instead of
     only the global training ranges

   - Scoring all dataset instances with results sorted by descending
     anomaly score for easy identification of top anomalies

   - Pretty-printing of learned models with tree depth and node count
     summaries

   - Learning rejects empty datasets with a
     ‘domain_error(non_empty_dataset, Dataset)’ exception


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<29>,  Next: Detector representation<4>,  Prev: Implemented features<2>,  Up: isolation_forest_anomaly_detector

6.100.5 Options
---------------

The following options can be passed to the ‘learn/3’ and ‘predict/4’
predicates:

   - ‘number_of_trees(N)’: number of isolation trees to build (default:
     ‘100’)

   - ‘subsample_size(N)’: subsample size used to build each isolation
     tree.  When omitted, the implementation uses ‘256’ or the number of
     training instances if smaller

   - ‘extension_level(N)’: controls the dimensionality of the random
     hyperplane cuts.  ‘0’ reproduces the original axis-aligned
     Isolation Forest; when omitted, the implementation uses ‘d - 1’,
     where ‘d’ is the number of dimensions

   - ‘anomaly_threshold(T)’: threshold used by ‘predict/3-4’ (default:
     ‘0.5’)

   - ‘baseline_class_values(Classes)’: learn-time list of admissible
     baseline class labels (default: ‘[normal]’)

   - ‘baseline_selection_policy(Policy)’: learn-time handling of
     non-baseline examples.  Supported values are ‘reject’ (default) and
     ‘filter’


File: TheLogtalkHandbook-3.100.1.info,  Node: Detector representation<4>,  Next: Limitations<4>,  Prev: Options<29>,  Up: isolation_forest_anomaly_detector

6.100.6 Detector representation
-------------------------------

The learned detector is represented by default as:

     if_model(Trees, Psi, AttributeNames, Attributes, Ranges, Diagnostics)

Where:

   - ‘Trees’: List of learned isolation trees

   - ‘Psi’: Effective subsample size used to build each tree

   - ‘AttributeNames’: List of attribute names in order

   - ‘Attributes’: List of ‘Attribute-Values’ declarations from the
     training dataset

   - ‘Ranges’: Observed numeric ranges used for imputing missing values
     during training

   - ‘Diagnostics’: Learned metadata terms including ‘model/1’,
     ‘tree_count/1’, ‘subsample_size/1’, ‘attribute_names/1’,
     ‘feature_count/1’, and ‘options/1’

Each internal tree node additionally stores node-local dimension bounds
used when resolving missing-value routing during scoring.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
detector term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: Limitations<4>,  Next: References<19>,  Prev: Detector representation<4>,  Up: isolation_forest_anomaly_detector

6.100.7 Limitations
-------------------

   - No incremental learning (the forest must be rebuilt from scratch
     when new examples are added)

   - No streaming or online variant


File: TheLogtalkHandbook-3.100.1.info,  Node: References<19>,  Next: Usage<52>,  Prev: Limitations<4>,  Up: isolation_forest_anomaly_detector

6.100.8 References
------------------

   - Liu, F.T., Ting, K.M. and Zhou, Z.-H. (2008).  Isolation Forest.
     'Proceedings of the 2008 Eighth IEEE International Conference on
     Data Mining', 413-422.  ‘https://doi.org/10.1109/ICDM.2008.17’

   - Hariri, S., Kind, M.C. and Brunner, R.J. (2019).  Extended
     Isolation Forest.  'IEEE Transactions on Knowledge and Data
     Engineering', 33(4), 1479-1489.
     ‘https://doi.org/10.1109/TKDE.2019.2947676’


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<52>,  Prev: References<19>,  Up: isolation_forest_anomaly_detector

6.100.9 Usage
-------------

To learn an isolation forest model from a dataset with default options:

| ?- isolation_forest_anomaly_detector::learn(gaussian_anomalies, Model,
[baseline_selection_policy(filter)]).

To learn with custom options:

     | ?- isolation_forest_anomaly_detector::learn(gaussian_anomalies, Model, [
            baseline_selection_policy(filter),
              number_of_trees(200),
              subsample_size(128),
              extension_level(1),
              anomaly_threshold(0.6)
          ]).

To compute the anomaly score for a new instance:

| ?- isolation_forest_anomaly_detector::learn(gaussian_anomalies, Model,
[baseline_selection_policy(filter)]),
isolation_forest_anomaly_detector::score(Model, [x-0.12, y-0.34],
Score).

To predict whether an instance is an anomaly or normal:

| ?- isolation_forest_anomaly_detector::learn(gaussian_anomalies, Model,
[baseline_selection_policy(filter)]),
isolation_forest_anomaly_detector::predict(Model, [x-4.50, y-4.20],
Prediction).

To compute and rank anomaly scores for all instances in a dataset:

| ?- isolation_forest_anomaly_detector::learn(gaussian_anomalies, Model,
[baseline_selection_policy(filter)]),
isolation_forest_anomaly_detector::score_all(gaussian_anomalies, Model,
Scores).

The ‘Scores’ list contains ‘Id-Class-Score’ triples sorted by descending
anomaly score.  This makes it easy to inspect top anomalies:

| ?- isolation_forest_anomaly_detector::learn(gaussian_anomalies, Model,
[baseline_selection_policy(filter)]),
isolation_forest_anomaly_detector::score_all(gaussian_anomalies, Model,
[Top1, Top2, Top3| _]).

To print a summary of the learned model:

| ?- isolation_forest_anomaly_detector::learn(gaussian_anomalies, Model,
[baseline_selection_policy(filter)]),
isolation_forest_anomaly_detector::print_anomaly_detector(Model).

To use the original (non-extended) Isolation Forest, set the extension
level to 0:

| ?- isolation_forest_anomaly_detector::learn(gaussian_anomalies, Model,
[baseline_selection_policy(filter), extension_level(0)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: java,  Next: json,  Prev: isolation_forest_anomaly_detector,  Up: Libraries

6.101 ‘java’
============

The library Java entities define a minimal abstraction for calling Java
from Logtalk.  This abstraction makes use of Logtalk parametric objects
and allows creating Java objects, accessing Java class fields, and
calling Java class and object methods using syntax closer to Logtalk.
It also gives access to some Java utility predicates.

This abstraction was developed primarily to work with XVM (with its
‘jni’ plug-in installed) or the JPL library bundled with SWI-Prolog and
YAP. However, it’s expected to be implementable with alternative Java
interfaces found in other backend Prolog compilers.  Currently, a
preliminary implementation is also available for JIProlog.

The main idea in this abstraction layer is to use parametric objects
where the first parameter holds the Java reference (usually to a class
or object) and an optional second parameter holds the return value.
Together with a forward message handler, this allows the use of Java
messages with the same functor and number of arguments as found in the
relevant JavaDocs.

* Menu:

* API documentation: API documentation<119>.
* Loading: Loading<121>.
* Testing: Testing<113>.
* Usage: Usage<53>.
* Known issues: Known issues<11>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<119>,  Next: Loading<121>,  Up: java

6.101.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#java’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<121>,  Next: Testing<113>,  Prev: API documentation<119>,  Up: java

6.101.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(java(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<113>,  Next: Usage<53>,  Prev: Loading<121>,  Up: java

6.101.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(java(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<53>,  Next: Known issues<11>,  Prev: Testing<113>,  Up: java

6.101.4 Usage
-------------

The two main objects in this library are ‘java(Reference, ReturnValue)’
and ‘java(Reference)’.  Use the latter if you want to ignore the return
value or when calling a void Java method.

The ‘java’ object implements utility predicates.  For some backend Java
interfaces such as JPL (available in SWI-Prolog, XVM, and YAP) there is
also a ‘java_hook’ hook object for removing any overhead when using this
library abstraction.

For usage examples and additional tests, see the ‘clustering’,
‘document_converter’, ‘jpl’, and ‘neo4j’ examples.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<11>,  Prev: Usage<53>,  Up: java

6.101.5 Known issues
--------------------

When running Java GUI examples on the macOS Terminal application, you
may get a Java error saying that the AWT cannot be started.  In
alternative, try to run the example from within the SWI-Prolog macOS
application instead of using the shell integration script.  This issue
is due to a macOS Java issue that’s orthogonal to both Prolog backends
and Logtalk.


File: TheLogtalkHandbook-3.100.1.info,  Node: json,  Next: json_ld,  Prev: java,  Up: Libraries

6.102 ‘json’
============

The ‘json’ library provides predicates for parsing and generating data
in the JSON format based on the specification and standard found at:

   - ‘https://www.rfc-editor.org/rfc/rfc8259’

   - 
     ‘https://ecma-international.org/publications-and-standards/standards/ecma-404/’

It includes parametric objects whose parameters allow selecting the
representation for parsed JSON objects (‘curly’ or ‘list’), JSON text
strings (‘atom’, ‘chars’, or ‘codes’) and JSON pairs (‘dash’, ‘equal’,
or ‘colon’).

* Menu:

* API documentation: API documentation<120>.
* Loading: Loading<122>.
* Testing: Testing<114>.
* Representation: Representation<11>.
* Encoding: Encoding<7>.
* Decoding: Decoding<7>.
* Known issues: Known issues<12>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<120>,  Next: Loading<122>,  Up: json

6.102.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#json’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<122>,  Next: Testing<114>,  Prev: API documentation<120>,  Up: json

6.102.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(json(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<114>,  Next: Representation<11>,  Prev: Loading<122>,  Up: json

6.102.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(json(tester)).

Some of the sample JSON test files are based on examples published at:

‘https://www.json.org/’


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<11>,  Next: Encoding<7>,  Prev: Testing<114>,  Up: json

6.102.4 Representation
----------------------

The following choices of syntax have been made to represent JSON
elements as terms:

   - By default, JSON objects are represented using curly-bracketed
     terms, ‘{Pairs}’, where each pair uses the representation
     ‘Key-Value’ (see below for alternative representations).

   - Arrays are represented using lists.

   - Text strings can be represented as atoms, ‘chars(List)’, or
     ‘codes(List)’.  The default when decoding is to use atoms when
     using the ‘json’ object.  To decode text strings into lists of
     chars or codes, use the ‘json/1’ with the parameter bound to
     ‘chars’ or ‘codes’.  For example:

          | ?- json::parse(codes([34,104,101,108,108,111,34]), Term).
          Term = hello
          yes

          | ?- json(atom)::parse(codes([34,104,101,108,108,111,34]), Term).
          Term = hello
          yes

          | ?- json(chars)::parse(codes([34,104,101,108,108,111,34]), Term).
          Term = chars([h,e,l,l,o])
          yes

          | ?- json(codes)::parse(codes([34,104,101,108,108,111,34]), Term).
          Term = codes([104,101,108,108,111])
          yes

   - The JSON values ‘false’, ‘true’ and ‘null’ are represented by,
     respectively, the ‘@false’, ‘@true’ and ‘@null’ compound terms.

The following table exemplifies the term equivalents of JSON elements
using default representations for objects, pairs, and strings:

JSON                          term
                              
------------------------------------------------------------
[1,2]                         [1,2]
                              
true                          @true
                              
false                         @false
                              
null                          @null
                              
-1                            -1
                              
[1.2345]                      [1.2345]
                              
[]                            []
                              
[2147483647]                  [2147483647]
                              
[0]                           [0]
                              
[1234567890123456789]         [1234567890123456789]
                              
[false]                       [@false]
                              
[-2147483648]                 [-2147483648]
                              
{“a”:null,”foo”:”bar”}        <{a-@null>, foo-bar}
                              
[2.225073858507201e-308]      [2.225073858507201e-308]
                              
[0,1]                         [0,1]
                              
[2.2250738585072014e-308]     [2.2250738585072014e-308]
                              
[1.7976931348623157e+308]     [1.7976931348623157e+308]
                              
[0.0]                         [0.0]
                              
[4294967295]                  [4294967295]
                              
[-1234567890123456789]        [-1234567890123456789]
                              
[“foo”]                       [foo]
                              
[1]                           [1]
                              
[null]                        [@null]
                              
[-1.2345]                     [-1.2345]
                              
[5.0e-324]                    [5.0e-324]
                              
[-1]                          [-1]
                              
[true]                        [@true]
                              
[9223372036854775807]         [9223372036854775807]
                              

For JSON objects that are two possible term representations:

JSON object               term (curly)
                          
----------------------------------------------
{“a”:1, “b”:2, “c”:3}     {a-1, b-2, c-3}
                          
{}                        {}
                          

and:

JSON object               term (list)
                          
----------------------------------------------------
{“a”:1, “b”:2, “c”:3}     json([a-1, b-2, c-3])
                          
{}                        json([])
                          

For JSON pairs that are three possible representations:

JSON object               term (dash)
                          
----------------------------------------------
{“a”:1, “b”:2, “c”:3}     {a-1, b-2, c-3}
                          

and:

JSON object               term (equal)
                          
----------------------------------------------
{“a”:1, “b”:2, “c”:3}     {a=1, b=2, c=3}
                          

and:

JSON object               term (colon)
                          
----------------------------------------------
{“a”:1, “b”:2, “c”:3}     {a:1, b:2, c:3}
                          

By default, the curly-term representation and the dash pair
representation are used.  The ‘json/3’ parametric object allows
selecting the desired representation choices.  For example:

     | ?- json(curly,dash,atom)::parse(atom('{"a":1, "b":2, "c":3}'), JSON).
     JSON = {a-1, b-2, c-3}
     yes

     | ?- json(list,equal,atom)::parse(atom('{"a":1, "b":2, "c":3}'), JSON).
     JSON = json([a=1, b=2, c=3])
     yes

     | ?- json(curly,colon,atom)::parse(atom('{"a":1, "b":2, "c":3}'), JSON).
     JSON = {a:1, b:2, c:3}
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding<7>,  Next: Decoding<7>,  Prev: Representation<11>,  Up: json

6.102.5 Encoding
----------------

Encoding is accomplished using the ‘generate/2’ predicate.  For example:

     | ?- json::generate(codes(Encoding), [a,{b-c}]).
     Encoding = [91,34,97,34,44,123,34,98,34,58,34,99,34,125,93]
     yes

Alternatively:

     | ?- json::generate(chars(Encoding), [a,{b-c}]).
     Encoding = ['[','"',a,'"',',','{','"',b,'"',:,'"',c,'"','}',']']
     Yes

     | ?- json::generate(atom(Encoding), [a,{b-c}]).
     Encoding = '["a",{"b":"c"}]'
     Yes

Notice that ‘generate/2’ takes, as second argument, a Prolog term that
corresponds to the JSON syntax in Prolog and produces the corresponding
JSON output in the format specified in the first argument:
(‘codes(Variable)’, ‘stream(Stream)’, ‘file(File)’, ‘chars(Variable)’ or
‘atom(Variable)’).


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding<7>,  Next: Known issues<12>,  Prev: Encoding<7>,  Up: json

6.102.6 Decoding
----------------

Decoding is accomplished using the ‘parse/2’ predicate.  For example, to
decode a given json file:

     | ?- json::parse(file('simple/roundtrip_array_obj_array.json'), Term).
     Term = [{a-[b]}]
     yes

The ‘parse/2’ predicate first argument must indicate the input source
(‘codes(Codes)’, ‘stream(Stream)’, ‘line(Stream)’, ‘file(Path)’,
‘chars(Chars)’ or ‘atom(Atom)’) containing a JSON payload to be decoded
into the Prolog term in the second argument.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<12>,  Prev: Decoding<7>,  Up: json

6.102.7 Known issues
--------------------

Some tests, notably ‘parse_simple_valid_files’ and
‘roundtrip_hexadecimals’, fail on backends such as ECLiPSe and GNU
Prolog that don’t support Unicode.


File: TheLogtalkHandbook-3.100.1.info,  Node: json_ld,  Next: json_lines,  Prev: json,  Up: Libraries

6.103 ‘json_ld’
===============

The ‘json_ld’ library provides predicates for parsing, generating,
expanding, and compacting JSON-LD 1.1 (JSON-based Serialization for
Linked Data) documents based on the W3C Recommendation found at:

‘https://www.w3.org/TR/json-ld11/’

This library builds on top of the ‘json’ library for JSON parsing and
generation, and uses the same representation choices for JSON data.  It
includes parametric objects whose parameters allow selecting the
representation for parsed JSON objects (‘curly’ or ‘list’), JSON text
strings (‘atom’, ‘chars’, or ‘codes’) and JSON pairs (‘dash’, ‘equal’,
or ‘colon’).

* Menu:

* API documentation: API documentation<121>.
* Loading: Loading<123>.
* Testing: Testing<115>.
* Parsing: Parsing<2>.
* Generating: Generating<2>.
* Expansion::
* Compaction::
* Flattening::
* Supported Features::
* Representation: Representation<12>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<121>,  Next: Loading<123>,  Up: json_ld

6.103.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#json_ld’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<123>,  Next: Testing<115>,  Prev: API documentation<121>,  Up: json_ld

6.103.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(json_ld(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<115>,  Next: Parsing<2>,  Prev: Loading<123>,  Up: json_ld

6.103.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(json_ld(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing<2>,  Next: Generating<2>,  Prev: Testing<115>,  Up: json_ld

6.103.4 Parsing
---------------

JSON-LD documents can be parsed from various sources using the ‘parse/2’
predicate.  Since JSON-LD is a superset of JSON, any valid JSON-LD
document is also valid JSON:

     | ?- json_ld::parse(file('document.jsonld'), Term).

     | ?- json_ld::parse(atom('{"@context": {"name": "http://schema.org/name"}, "name": "Manu Sporny"}'), Term).


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating<2>,  Next: Expansion,  Prev: Parsing<2>,  Up: json_ld

6.103.5 Generating
------------------

JSON-LD documents can be generated from Logtalk terms using the
‘generate/2’ predicate:

     | ?- json_ld::generate(atom(Atom), {'@context'-{name-'http://schema.org/name'}, name-'Manu Sporny'}).


File: TheLogtalkHandbook-3.100.1.info,  Node: Expansion,  Next: Compaction,  Prev: Generating<2>,  Up: json_ld

6.103.6 Expansion
-----------------

Expansion is the process of removing the context and representing all
properties and types as full IRIs.  This is useful for processing
JSON-LD data in a context-independent way:

     | ?- json_ld::parse(atom('{"@context": {"name": "http://schema.org/name"}, "name": "Manu Sporny"}'), Doc),
          json_ld::expand(Doc, Expanded).
     Doc = {'@context'-{name-'http://schema.org/name'}, name-'Manu Sporny'},
     Expanded = [{'http://schema.org/name'-[{'@value'-'Manu Sporny'}]}]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Compaction,  Next: Flattening,  Prev: Expansion,  Up: json_ld

6.103.7 Compaction
------------------

Compaction is the process of applying a context to shorten IRIs to terms
or compact IRIs.  This is the inverse of expansion:

     | ?- json_ld::expand({'@context'-{name-'http://schema.org/name'}, name-'Manu Sporny'}, Expanded),
          json_ld::compact(Expanded, {'@context'-{name-'http://schema.org/name'}}, Compacted).


File: TheLogtalkHandbook-3.100.1.info,  Node: Flattening,  Next: Supported Features,  Prev: Compaction,  Up: json_ld

6.103.8 Flattening
------------------

Flattening collects all node objects from a document into a flat
‘@graph’ array, with nested objects replaced by references.  Blank node
identifiers are generated for nodes that don’t have an ‘@id’:

     | ?- json_ld::parse(atom('{"@context":{"knows":"http://xmlns.com/foaf/0.1/knows"},"@id":"http://example.org/john","knows":{"@id":"http://example.org/jane"}}'), Doc),
          json_ld::expand(Doc, Expanded),
          json_ld::flatten(Expanded, Flattened).


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported Features,  Next: Representation<12>,  Prev: Flattening,  Up: json_ld

6.103.9 Supported Features
--------------------------

The library supports the following JSON-LD 1.1 features:

'Context processing:'

   - Inline context definitions (‘@context’)

   - Vocabulary mapping (‘@vocab’)

   - Base IRI (‘@base’)

   - Default language (‘@language’)

   - Base direction (‘@direction’)

   - Compact IRIs (prefix:suffix notation)

   - Term definitions (simple and expanded)

   - Type coercion (‘@type’ in term definitions)

   - Context arrays (multiple contexts)

'Node objects:'

   - Node identifiers (‘@id’)

   - Node types (‘@type’)

   - Blank node identifiers (‘_:name’)

'Value objects:'

   - Typed values (‘@value’ with ‘@type’)

   - Language-tagged strings (‘@value’ with ‘@language’)

   - Direction-tagged strings (‘@value’ with ‘@direction’)

'Graph support:'

   - Named graphs (‘@graph’)

   - Default graph

'Collections:'

   - Ordered lists (‘@list’)

   - Unordered sets (‘@set’)

'Other features:'

   - Reverse properties (‘@reverse’)

   - Included blocks (‘@included’)

   - Index preservation (‘@index’)

   - Flattening algorithm (‘flatten/2’)

'Not currently supported:'

   - Remote context fetching (contexts referenced by URL)

   - Framing algorithm

   - ‘@import’ context processing


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<12>,  Prev: Supported Features,  Up: json_ld

6.103.10 Representation
-----------------------

JSON-LD documents are represented using the same term conventions as the
‘json’ library.  The JSON-LD keywords (‘@context’, ‘@id’, ‘@type’, etc.)
are represented as atoms in the parsed terms.  For example:

JSON-LD                                                  term (default)
                                                         
-------------------------------------------------------------------------------------------------------------------------
{“@id”: “‘http://example.org/"}’                         {‘@id <{'@id>’-’‘http://example.org/'}’
                                                         
{“@type”: “Person”}                                      {‘@type’-‘Person <{'@type'-'Person>’}
                                                         
{“@value”: “hello”, “@language”: “en”}                   {‘@value’-hello <{'@value'-hello>, ‘@language’-en
                                                         <'@language'-en>}
                                                         
{“@list”: [1, 2, 3]}                                     {‘@list <{'@list>’-[1, 2, 3]}
                                                         
{“@graph”: […]}                                          {‘@graph <{'@graph>’-[…]}
                                                         

As with the ‘json’ library, objects can be represented using curly terms
(default) or list terms, and pairs can use dash, equal, or colon
notation.


File: TheLogtalkHandbook-3.100.1.info,  Node: json_lines,  Next: json_pointer,  Prev: json_ld,  Up: Libraries

6.104 ‘json_lines’
==================

The ‘json_lines’ library provides predicates for parsing and generating
data in the JSON Lines format based on the proposal found at:

‘https://jsonlines.org’

It includes parametric objects whose parameters allow selecting the
representation for parsed JSON objects (‘curly’ or ‘list’), JSON text
strings (‘atom’, ‘chars’, or ‘codes’) and JSON pairs (‘dash’, ‘equal’,
or ‘colon’).

* Menu:

* API documentation: API documentation<122>.
* Loading: Loading<124>.
* Testing: Testing<116>.
* Representation: Representation<13>.
* Encoding: Encoding<8>.
* Decoding: Decoding<8>.
* Known issues: Known issues<13>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<122>,  Next: Loading<124>,  Up: json_lines

6.104.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#json_lines’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<124>,  Next: Testing<116>,  Prev: API documentation<122>,  Up: json_lines

6.104.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(json_lines(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<116>,  Next: Representation<13>,  Prev: Loading<124>,  Up: json_lines

6.104.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(json_lines(tester)).

Some of the sample JSON test files are based on examples published at:

‘https://jsonlines.org/’


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<13>,  Next: Encoding<8>,  Prev: Testing<116>,  Up: json_lines

6.104.4 Representation
----------------------

The following choices of syntax have been made to represent JSON
elements as terms:

   - By default, JSON objects are represented using curly-bracketed
     terms, ‘{Pairs}’, where each pair uses the representation
     ‘Key-Value’ (see below for alternative representations).

   - Arrays are represented using lists.

   - Text strings can be represented as atoms, ‘chars(List)’, or
     ‘codes(List)’.  The default when decoding is to use atoms when
     using the ‘json_lines’ object.  To decode text strings into lists
     of chars or codes, use the ‘json_lines/1’ object with the parameter
     bound to ‘chars’ or ‘codes’.  For example:

          | ?- json_lines::parse(codes([34,104,101,108,108,111,34]), Terms).
          Terms = [hello]
          yes

          | ?- json_lines(atom)::parse(codes([34,104,101,108,108,111,34]), Terms).
          Terms = [hello]
          yes

          | ?- json_lines(chars)::parse(codes([34,104,101,108,108,111,34]), Terms).
          Terms = [chars([h,e,l,l,o])]
          yes

          | ?- json_lines(codes)::parse(codes([34,104,101,108,108,111,34]), Terms).
          Terms = [codes([104,101,108,108,111])]
          yes

   - The JSON values ‘false’, ‘true’ and ‘null’ are represented by,
     respectively, the ‘@false’, ‘@true’ and ‘@null’ compound terms.

The following table exemplifies the term equivalents of JSON elements
using default representations for objects, pairs, and strings:

JSON                          term
                              
------------------------------------------------------------
[1,2]                         [1,2]
                              
true                          @true
                              
false                         @false
                              
null                          @null
                              
-1                            -1
                              
[1.2345]                      [1.2345]
                              
[]                            []
                              
[2147483647]                  [2147483647]
                              
[0]                           [0]
                              
[1234567890123456789]         [1234567890123456789]
                              
[false]                       [@false]
                              
[-2147483648]                 [-2147483648]
                              
{“a”:null,”foo”:”bar”}        <{a-@null>, foo-bar}
                              
[2.225073858507201e-308]      [2.225073858507201e-308]
                              
[0,1]                         [0,1]
                              
[2.2250738585072014e-308]     [2.2250738585072014e-308]
                              
[1.7976931348623157e+308]     [1.7976931348623157e+308]
                              
[0.0]                         [0.0]
                              
[4294967295]                  [4294967295]
                              
[-1234567890123456789]        [-1234567890123456789]
                              
[“foo”]                       [foo]
                              
[1]                           [1]
                              
[null]                        [@null]
                              
[-1.2345]                     [-1.2345]
                              
[5.0e-324]                    [5.0e-324]
                              
[-1]                          [-1]
                              
[true]                        [@true]
                              
[9223372036854775807]         [9223372036854775807]
                              

For JSON objects that are two possible term representations:

JSON object               term (curly)
                          
----------------------------------------------
{“a”:1, “b”:2, “c”:3}     {a-1, b-2, c-3}
                          
{}                        {}
                          

and:

JSON object               term (list)
                          
----------------------------------------------------
{“a”:1, “b”:2, “c”:3}     json([a-1, b-2, c-3])
                          
{}                        json([])
                          

For JSON pairs that are three possible representations:

JSON object               term (dash)
                          
----------------------------------------------
{“a”:1, “b”:2, “c”:3}     {a-1, b-2, c-3}
                          

and:

JSON object               term (equal)
                          
----------------------------------------------
{“a”:1, “b”:2, “c”:3}     {a=1, b=2, c=3}
                          

and:

JSON object               term (colon)
                          
----------------------------------------------
{“a”:1, “b”:2, “c”:3}     {a:1, b:2, c:3}
                          

By default, the curly-term representation and the dash pair
representation are used.  The ‘json/3’ parametric object allows
selecting the desired representation choices.  For example:

     | ?- json_lines(curly,dash,atom)::parse(atom('{"a":1, "b":2, "c":3}'), JSONL).
     JSONL = [{a-1, b-2, c-3}]
     yes

     | ?- json_lines(list,equal,atom)::parse(atom('{"a":1, "b":2, "c":3}'), JSONL).
     JSONL = [json([a=1, b=2, c=3])]
     yes

     | ?- json_lines(curly,colon,atom)::parse(atom('{"a":1, "b":2, "c":3}'), JSONL).
     JSONL = [{a:1, b:2, c:3}]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding<8>,  Next: Decoding<8>,  Prev: Representation<13>,  Up: json_lines

6.104.5 Encoding
----------------

Encoding is accomplished using the ‘generate/2’ predicate.  For example:

     | ?- json_lines::generate(codes(Encoding), [a,{b-c}]).
     Encoding = [34,97,34,10,123,34,98,34,58,34,99,34,125,10]
     yes

Alternatively:

     | ?- json_lines::generate(chars(Encoding), [a,{b-c}]).
     Encoding = ['"',a,'"','\n','{','"',b,'"',:,'"',c,'"','}','\n']
     Yes

     | ?- json_lines::generate(atom(Encoding), [a,{b-c}]).
     Encoding = '"a"\n{"b":"c"}\n'
     Yes

Notice that ‘generate/2’ takes, as second argument, a Prolog term that
corresponds to the JSON syntax in Prolog and produces the corresponding
JSON output in the format specified in the first argument:
(‘codes(Variable)’, ‘stream(Stream)’, ‘file(File)’, ‘chars(Variable)’ or
‘atom(Variable)’).


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding<8>,  Next: Known issues<13>,  Prev: Encoding<8>,  Up: json_lines

6.104.6 Decoding
----------------

Decoding is accomplished using the ‘parse/2’ predicate.  For example, to
decode a given json file:

     | ?- json_lines::parse(file('simple/data.jsonl'), Terms).
     Term = [{a-[b]}]
     yes

The ‘parse/2’ predicate first argument must indicate the input source
(‘codes(Codes)’, ‘stream(Stream)’, ‘line(Stream)’, ‘file(Path)’,
‘chars(Chars)’ or ‘atom(Atom)’) containing a JSON payload to be decoded
into the Prolog term in the second argument.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<13>,  Prev: Decoding<8>,  Up: json_lines

6.104.7 Known issues
--------------------

Some tests may fail on backends such as ECLiPSe and GNU Prolog that
don’t support Unicode.


File: TheLogtalkHandbook-3.100.1.info,  Node: json_pointer,  Next: json_rpc,  Prev: json_lines,  Up: Libraries

6.105 ‘json_pointer’
====================

The ‘json_pointer’ library provides predicates for parsing, generating,
and evaluating JSON Pointers as specified by RFC 6901:

   - ‘https://www.rfc-editor.org/rfc/rfc6901’

It supports both the plain string syntax and the URI fragment syntax.
Reference tokens can be represented as atoms, ‘chars(List)’, or
‘codes(List)’.

* Menu:

* API documentation: API documentation<123>.
* Loading: Loading<125>.
* Testing: Testing<117>.
* Representation: Representation<14>.
* Examples: Examples<172>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<123>,  Next: Loading<125>,  Up: json_pointer

6.105.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#json_pointer’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<125>,  Next: Testing<117>,  Prev: API documentation<123>,  Up: json_pointer

6.105.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(json_pointer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<117>,  Next: Representation<14>,  Prev: Loading<125>,  Up: json_pointer

6.105.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(json_pointer(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<14>,  Next: Examples<172>,  Prev: Testing<117>,  Up: json_pointer

6.105.4 Representation
----------------------

The library defines the ‘json_pointer(_Representation_)’ parametric
object where ‘_Representation_’ can be one of:

   - ‘atom’ - reference tokens are represented as atoms

   - ‘chars’ - reference tokens are represented as ‘chars(List)’

   - ‘codes’ - reference tokens are represented as ‘codes(List)’

When using the default ‘json_pointer’ object, reference tokens are
represented as atoms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<172>,  Prev: Representation<14>,  Up: json_pointer

6.105.5 Examples
----------------

Parse and evaluate a pointer:

     | ?- json_pointer::parse(atom('/foo/0'), Pointer),
          json_pointer::evaluate(Pointer, {foo-[bar, baz]}, Value).
     Pointer = [foo, '0']
     Value = bar
     yes

Generate a URI fragment representation:

     | ?- json_pointer::generate_fragment(atom(Fragment), ['a b', 'c/d']).
     Fragment = '#/a%20b/c~1d'
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: json_rpc,  Next: json_schema,  Prev: json_pointer,  Up: Libraries

6.106 ‘json_rpc’
================

JSON-RPC 2.0 protocol encoding and decoding library.  Provides
predicates for constructing, parsing, classifying, and inspecting
JSON-RPC 2.0 messages (requests, notifications, responses, and error
responses).  Also provides stream-based message I/O for implementing
JSON-RPC clients and servers, including Content-Length header framing as
used by the Language Server Protocol (LSP) and the Model Context
Protocol (MCP). Uses the ‘json’ library for JSON parsing and generation.

* Menu:

* API documentation: API documentation<124>.
* Loading: Loading<126>.
* Testing: Testing<118>.
* Usage: Usage<54>.
* API summary::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<124>,  Next: Loading<126>,  Up: json_rpc

6.106.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#json_rpc’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<126>,  Next: Testing<118>,  Prev: API documentation<124>,  Up: json_rpc

6.106.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(json_rpc(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<118>,  Next: Usage<54>,  Prev: Loading<126>,  Up: json_rpc

6.106.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(json_rpc(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<54>,  Next: API summary,  Prev: Testing<118>,  Up: json_rpc

6.106.4 Usage
-------------

* Menu:

* Constructing JSON-RPC 2.0 messages: Constructing JSON-RPC 2 0 messages.
* Standard error constructors::
* Encoding and decoding::
* Message classification::
* Field extraction::
* Stream I/O (client and server API): Stream I/O client and server API.
* Content-Length framed I/O (LSP/MCP protocols): Content-Length framed I/O LSP/MCP protocols.


File: TheLogtalkHandbook-3.100.1.info,  Node: Constructing JSON-RPC 2 0 messages,  Next: Standard error constructors,  Up: Usage<54>

6.106.4.1 Constructing JSON-RPC 2.0 messages
............................................

Construct requests, notifications, responses, and error responses:

     | ?- json_rpc::request(subtract, [42,23], 1, Request).
     Request = {jsonrpc-'2.0', method-subtract, params-[42,23], id-1}.

     | ?- json_rpc::notification(update, [1,2,3], Notification).
     Notification = {jsonrpc-'2.0', method-update, params-[1,2,3]}.

     | ?- json_rpc::response(19, 1, Response).
     Response = {jsonrpc-'2.0', result-19, id-1}.

     | ?- json_rpc::error_response(-32601, 'Method not found', 1, ErrorResponse).


File: TheLogtalkHandbook-3.100.1.info,  Node: Standard error constructors,  Next: Encoding and decoding,  Prev: Constructing JSON-RPC 2 0 messages,  Up: Usage<54>

6.106.4.2 Standard error constructors
.....................................

     | ?- json_rpc::parse_error(Error).
     Error = ...

     | ?- json_rpc::invalid_request(Error).
     Error = ...

     | ?- json_rpc::method_not_found(1, Error).
     Error = ...

     | ?- json_rpc::invalid_params(1, Error).
     Error = ...

     | ?- json_rpc::internal_error(1, Error).
     Error = ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding and decoding,  Next: Message classification,  Prev: Standard error constructors,  Up: Usage<54>

6.106.4.3 Encoding and decoding
...............................

     | ?- json_rpc::request(subtract, [42,23], 1, Request),
        json_rpc::encode(Request, JSON).
     JSON = '{"jsonrpc":"2.0","method":"subtract","params":[42,23],"id":1}'.

     | ?- json_rpc::decode('{"jsonrpc":"2.0","result":19,"id":1}', Term).


File: TheLogtalkHandbook-3.100.1.info,  Node: Message classification,  Next: Field extraction,  Prev: Encoding and decoding,  Up: Usage<54>

6.106.4.4 Message classification
................................

     | ?- json_rpc::is_request(Message).
     ...

     | ?- json_rpc::is_notification(Message).
     ...

     | ?- json_rpc::is_response(Message).
     ...

     | ?- json_rpc::is_error_response(Message).
     ...

     | ?- json_rpc::is_batch(Messages).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Field extraction,  Next: Stream I/O client and server API,  Prev: Message classification,  Up: Usage<54>

6.106.4.5 Field extraction
..........................

     | ?- json_rpc::id(Message, Id).
     ...

     | ?- json_rpc::method(Message, Method).
     ...

     | ?- json_rpc::params(Message, Params).
     ...

     | ?- json_rpc::result(Message, Result).
     ...

     | ?- json_rpc::error_code(Message, Code).
     ...

     | ?- json_rpc::error_message(Message, ErrorMessage).
     ...

     | ?- json_rpc::error_data(Message, Data).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Stream I/O client and server API,  Next: Content-Length framed I/O LSP/MCP protocols,  Prev: Field extraction,  Up: Usage<54>

6.106.4.6 Stream I/O (client and server API)
............................................

Write and read newline-delimited JSON-RPC messages over streams:

     | ?- json_rpc::write_message(Output, Message).
     ...

     | ?- json_rpc::read_message(Input, Message).
     ...

These predicates can be used with any stream, including socket streams
from the ‘sockets’ library, to implement JSON-RPC clients and servers.


File: TheLogtalkHandbook-3.100.1.info,  Node: Content-Length framed I/O LSP/MCP protocols,  Prev: Stream I/O client and server API,  Up: Usage<54>

6.106.4.7 Content-Length framed I/O (LSP/MCP protocols)
.......................................................

Write and read JSON-RPC messages using ‘Content-Length’ header framing
as defined by the Language Server Protocol (LSP) and the Model Context
Protocol (MCP). Each message is preceded by a ‘Content-Length:
N\r\n\r\n’ header where ‘N’ is the byte length of the JSON body:

     | ?- json_rpc::write_framed_message(Output, Message).
     ...

     | ?- json_rpc::read_framed_message(Input, Message).
     ...

‘read_framed_message/2’ fails at end of stream or if the header is
missing or malformed.


File: TheLogtalkHandbook-3.100.1.info,  Node: API summary,  Prev: Usage<54>,  Up: json_rpc

6.106.5 API summary
-------------------

* Menu:

* Message construction::
* Standard error responses::
* Encoding and decoding: Encoding and decoding<2>.
* Message classification: Message classification<2>.
* Field extraction: Field extraction<2>.
* Stream I/O::


File: TheLogtalkHandbook-3.100.1.info,  Node: Message construction,  Next: Standard error responses,  Up: API summary

6.106.5.1 Message construction
..............................

Predicates for building JSON-RPC 2.0 message terms.  Requests include an
‘id’ for matching responses; notifications do not.

   - ‘request(+Method, +Params, +Id, --Request)’ - Construct a request

   - ‘request(+Method, +Id, --Request)’ - Construct a request with no
     parameters

   - ‘notification(+Method, +Params, --Notification)’ - Construct a
     notification

   - ‘notification(+Method, --Notification)’ - Construct a notification
     with no parameters

   - ‘response(+Result, +Id, --Response)’ - Construct a successful
     response

   - ‘error_response(+Code, +Message, +Id, --ErrorResponse)’ - Construct
     an error response

   - ‘error_response(+Code, +Message, +Data, +Id, --ErrorResponse)’ -
     Construct an error response with data


File: TheLogtalkHandbook-3.100.1.info,  Node: Standard error responses,  Next: Encoding and decoding<2>,  Prev: Message construction,  Up: API summary

6.106.5.2 Standard error responses
..................................

Convenience predicates for the five standard JSON-RPC 2.0 error codes.

   - ‘parse_error(--ErrorResponse)’ - Parse error (-32700)

   - ‘invalid_request(--ErrorResponse)’ - Invalid request (-32600)

   - ‘method_not_found(+Id, --ErrorResponse)’ - Method not found
     (-32601)

   - ‘invalid_params(+Id, --ErrorResponse)’ - Invalid params (-32602)

   - ‘internal_error(+Id, --ErrorResponse)’ - Internal error (-32603)


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding and decoding<2>,  Next: Message classification<2>,  Prev: Standard error responses,  Up: API summary

6.106.5.3 Encoding and decoding
...............................

Convert between JSON-RPC message terms and JSON atoms (strings).

   - ‘encode(+Term, --JSON)’ - Encode a JSON-RPC term to a JSON atom

   - ‘decode(+JSON, --Term)’ - Decode a JSON atom to a JSON-RPC term


File: TheLogtalkHandbook-3.100.1.info,  Node: Message classification<2>,  Next: Field extraction<2>,  Prev: Encoding and decoding<2>,  Up: API summary

6.106.5.4 Message classification
................................

Test what kind of JSON-RPC message a term represents.

   - ‘is_request(+Term)’ - Test if a term is a request

   - ‘is_notification(+Term)’ - Test if a term is a notification

   - ‘is_response(+Term)’ - Test if a term is a successful response

   - ‘is_error_response(+Term)’ - Test if a term is an error response

   - ‘is_batch(+Term)’ - Test if a term is a batch (non-empty list)


File: TheLogtalkHandbook-3.100.1.info,  Node: Field extraction<2>,  Next: Stream I/O,  Prev: Message classification<2>,  Up: API summary

6.106.5.5 Field extraction
..........................

Extract individual fields from JSON-RPC message terms.

   - ‘id(+Message, --Id)’ - Extract the id field

   - ‘method(+Message, --Method)’ - Extract the method field

   - ‘params(+Message, --Params)’ - Extract the params field

   - ‘result(+Message, --Result)’ - Extract the result field

   - ‘error(+Message, --Error)’ - Extract the error object

   - ‘error_code(+Message, --Code)’ - Extract the error code

   - ‘error_message(+Message, --ErrorMessage)’ - Extract the error
     message

   - ‘error_data(+Message, --Data)’ - Extract the error data


File: TheLogtalkHandbook-3.100.1.info,  Node: Stream I/O,  Prev: Field extraction<2>,  Up: API summary

6.106.5.6 Stream I/O
....................

Read and write JSON-RPC messages over streams.  The newline-delimited
variants are suitable for socket-based communication.  The
Content-Length framed variants implement the header-based framing used
by the Language Server Protocol (LSP) and the Model Context Protocol
(MCP).

   - ‘write_message(+Output, +Message)’ - Write a newline-delimited
     message

   - ‘read_message(+Input, --Message)’ - Read a newline-delimited
     message

   - ‘write_framed_message(+Output, +Message)’ - Write a message with
     Content-Length framing

   - ‘read_framed_message(+Input, --Message)’ - Read a message with
     Content-Length framing


File: TheLogtalkHandbook-3.100.1.info,  Node: json_schema,  Next: kcenters_clusterer,  Prev: json_rpc,  Up: Libraries

6.107 ‘json_schema’
===================

The ‘json_schema’ library provides predicates for parsing JSON Schema
documents and validating JSON data against schemas.  It is based on the
JSON Schema specification found at:

   - ‘https://json-schema.org/’

This library builds on top of the ‘json’ library for JSON parsing and
uses the same representation choices for JSON data.

* Menu:

* API documentation: API documentation<125>.
* Loading: Loading<127>.
* Testing: Testing<119>.
* Schema Parsing::
* Validation::
* Supported Keywords::
* Known Limitations::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<125>,  Next: Loading<127>,  Up: json_schema

6.107.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#json_schema’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<127>,  Next: Testing<119>,  Prev: API documentation<125>,  Up: json_schema

6.107.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(json_schema(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<119>,  Next: Schema Parsing,  Prev: Loading<127>,  Up: json_schema

6.107.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(json_schema(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Schema Parsing,  Next: Validation,  Prev: Testing<119>,  Up: json_schema

6.107.4 Schema Parsing
----------------------

Schemas can be parsed from various sources using the ‘parse/2’
predicate:

     | ?- json_schema::parse(file('schema.json'), Schema).

     | ?- json_schema::parse(atom('{"type": "string"}'), Schema).

     | ?- json_schema::parse(codes(Codes), Schema).


File: TheLogtalkHandbook-3.100.1.info,  Node: Validation,  Next: Supported Keywords,  Prev: Schema Parsing,  Up: json_schema

6.107.5 Validation
------------------

JSON data can be validated against a schema using the ‘validate/2’ or
‘validate/3’ predicates:

     % Success/failure validation
     | ?- json_schema::parse(atom('{"type": "string"}'), Schema),
          json_schema::validate(Schema, hello).
     yes

     | ?- json_schema::parse(atom('{"type": "string"}'), Schema),
          json_schema::validate(Schema, 42).
     no

     % Validation with error collection
     | ?- json_schema::parse(atom('{"type": "string"}'), Schema),
          json_schema::validate(Schema, 42, Errors).
     Errors = [error([], expected_type(string))]


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported Keywords,  Next: Known Limitations,  Prev: Validation,  Up: json_schema

6.107.6 Supported Keywords
--------------------------

The library supports the following JSON Schema keywords:

'Type validation:'

   - ‘type’ (string, number, integer, boolean, array, object, null)

   - Multiple types: ‘{"type": ["string", "number"]}’

'Generic validation:'

   - ‘enum’ - value must be one of the specified values

   - ‘const’ - value must be exactly the specified value

'String validation:'

   - ‘minLength’ - minimum string length

   - ‘maxLength’ - maximum string length

'Numeric validation:'

   - ‘minimum’ - minimum value (inclusive)

   - ‘maximum’ - maximum value (inclusive)

   - ‘exclusiveMinimum’ - minimum value (exclusive)

   - ‘exclusiveMaximum’ - maximum value (exclusive)

   - ‘multipleOf’ - value must be a multiple of this number

'Array validation:'

   - ‘items’ - schema for array items

   - ‘prefixItems’ - schemas for array items by position

   - ‘minItems’ - minimum number of items

   - ‘maxItems’ - maximum number of items

   - ‘uniqueItems’ - all items must be unique

   - ‘contains’ - at least one item must match the schema

'Object validation:'

   - ‘properties’ - schemas for object properties

   - ‘required’ - list of required property names

   - ‘minProperties’ - minimum number of properties

   - ‘maxProperties’ - maximum number of properties

   - ‘propertyNames’ - schema for property names

'Composition:'

   - ‘allOf’ - value must match all schemas

   - ‘anyOf’ - value must match at least one schema

   - ‘oneOf’ - value must match exactly one schema

   - ‘not’ - value must not match the schema

'Conditional:'

   - ‘if’/‘then’/‘else’ - conditional schema application

'Schema References:'

   - ‘$defs’/‘definitions’ - schema definitions

   - ‘$ref’ - local JSON Pointer references and local file references
     (e.g., ‘#/$defs/name’, ‘address.json’, ‘common.json#/$defs/name’)

'Format validation:'

The ‘format’ keyword validates string formats.  Non-string values pass
format validation.  Unknown formats are ignored per JSON Schema
specification.  Supported formats:

   - ‘email’ - basic email format (<local@domain>)

   - ‘date’ - ISO 8601 date (YYYY-MM-DD)

   - ‘time’ - ISO 8601 time (HH:MM:SS) with optional fractional seconds
     and timezone

   - ‘date-time’ - ISO 8601 combined date and time

   - ‘uri’ - URI with scheme (e.g., ‘http://example.com’)

   - ‘uri-reference’ - URI or relative reference

   - ‘ipv4’ - IPv4 address (dotted decimal notation)

   - ‘ipv6’ - IPv6 address (hex groups with colons, supports ::
     compression)

   - ‘uuid’ - UUID format (8-4-4-4-12 hex pattern)

'Boolean schemas:'

   - ‘true’ - accepts any value

   - ‘false’ - rejects all values


File: TheLogtalkHandbook-3.100.1.info,  Node: Known Limitations,  Prev: Supported Keywords,  Up: json_schema

6.107.7 Known Limitations
-------------------------

The following JSON Schema features are not yet supported:

   - ‘pattern’ - regular expression validation (requires regex support)

   - ‘patternProperties’ - property matching by pattern

   - ‘format’ - formats not listed above (e.g., ‘hostname’, ‘regex’,
     ‘json-pointer’)

   - ‘$ref’ with remote URLs - external schema references require HTTP
     support


File: TheLogtalkHandbook-3.100.1.info,  Node: kcenters_clusterer,  Next: kemeny_young_ranker,  Prev: json_schema,  Up: Libraries

6.108 ‘kcenters_clusterer’
==========================

k-Centers clusterer.  It uses a deterministic farthest-first center
selection heuristic.  Supports continuous attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<126>.
* Loading: Loading<128>.
* Testing: Testing<120>.
* Features: Features<31>.
* Options: Options<30>.
* Diagnostics: Diagnostics<4>.
* Clusterer representation: Clusterer representation<6>.
* References: References<20>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<126>,  Next: Loading<128>,  Up: kcenters_clusterer

6.108.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#kcenters_clusterer’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<128>,  Next: Testing<120>,  Prev: API documentation<126>,  Up: kcenters_clusterer

6.108.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kcenters_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<120>,  Next: Features<31>,  Prev: Loading<128>,  Up: kcenters_clusterer

6.108.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kcenters_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(kcenters_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<31>,  Next: Options<30>,  Prev: Testing<120>,  Up: kcenters_clusterer

6.108.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Farthest-First Center Selection': Uses a deterministic
     farthest-first heuristic to choose centers.

   - 'Deterministic Initialization': Supports ‘first_k’ and
     deterministic ‘spread’ initialization that repeatedly chooses the
     farthest example from the centers selected so far..

   - 'Distance Metrics': Supports Euclidean and Manhattan distances..

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Rich Training Diagnostics': Learned clusterers report training
     example count, selected center count, and the center-selection
     strategy used during learning.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<30>,  Next: Diagnostics<4>,  Prev: Features<31>,  Up: kcenters_clusterer

6.108.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of clusters to learn.  Default is ‘2’.

   - ‘initialization(Initialization)’: Center initialization strategy.
     Options: ‘spread’ (default) or ‘first_k’.

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default) or ‘manhattan’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<4>,  Next: Clusterer representation<6>,  Prev: Options<30>,  Up: kcenters_clusterer

6.108.6 Diagnostics
-------------------

The ‘diagnostics/2’ predicate returns a list containing:

   - ‘model(kcenters_clusterer)’

   - ‘center_count(Count)’

   - ‘training_example_count(Count)’

   - ‘selection_strategy(Strategy)’

   - ‘options(Options)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<6>,  Next: References<20>,  Prev: Diagnostics<4>,  Up: kcenters_clusterer

6.108.7 Clusterer representation
--------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     kcenters_clusterer(Encoders, Centers, Options, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Centers’: List of center vectors in cluster-id order.

   - ‘Options’: Effective training options used to learn the clusterer.

   - ‘Diagnostics’: Training diagnostics metadata returned by the
     ‘diagnostics/2’ predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<20>,  Prev: Clusterer representation<6>,  Up: kcenters_clusterer

6.108.8 References
------------------

  1. Gonzalez (1985) - “Clustering to minimize the maximum intercluster
     distance”.  Theoretical Computer Science, 38, 293-306.


File: TheLogtalkHandbook-3.100.1.info,  Node: kemeny_young_ranker,  Next: kernel_svm_classifier,  Prev: kcenters_clusterer,  Up: Libraries

6.109 ‘kemeny_young_ranker’
===========================

Kemeny-Young pairwise preference ranker.  It aggregates head-to-head
preference weights, then performs an exact branch-and-bound search over
linear orders to maximize the total pairwise agreement score under the
Kemeny-Young criterion.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning an
exact consensus ranker from pairwise preferences, using it to order
candidate items, inspecting the learned consensus ranking and consensus
score, and exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The current implementation requires a well-formed connected
pairwise dataset so that all ranked items remain part of a single
comparison graph.

* Menu:

* API documentation: API documentation<127>.
* Loading: Loading<129>.
* Testing: Testing<121>.
* Features: Features<32>.
* Usage: Usage<55>.
* Options: Options<31>.
* Scoring semantics: Scoring semantics<5>.
* Diagnostics syntax: Diagnostics syntax<12>.
* Ranker representation: Ranker representation<9>.
* Notes: Notes<8>.
* References: References<21>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<127>,  Next: Loading<129>,  Up: kemeny_young_ranker

6.109.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#kemeny_young_ranker’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<129>,  Next: Testing<121>,  Prev: API documentation<127>,  Up: kemeny_young_ranker

6.109.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kemeny_young_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<121>,  Next: Features<32>,  Prev: Loading<129>,  Up: kemeny_young_ranker

6.109.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kemeny_young_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<32>,  Next: Usage<55>,  Prev: Testing<121>,  Up: kemeny_young_ranker

6.109.4 Features
----------------

   - 'Exact Consensus Ranking': Learns one deterministic Kemeny-Young
     consensus order from aggregated pairwise outcomes.

   - 'Branch-and-Bound Search': Uses exact search with pruning over
     linear orders to maximize total pairwise agreement.

   - 'Deterministic Optimal Tie Breaking': Supports both standard
     term-order and dataset declaration-order selection when multiple
     optimal consensus rankings exist.

   - 'Consensus Access': Exposes the learned full-item consensus ranking
     and its maximum agreement score using the ‘consensus_ranking/2’ and
     ‘consensus_score/2’ predicates.

   - 'Deterministic Ranking': Orders candidate items by the selected
     consensus order with deterministic tie-breaking.  When multiple
     optimal Kemeny orders exist, the ‘tie_breaking/1’ option selects
     the deterministic search order used to choose one representative
     consensus ranking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     comparison graphs.

   - 'Training Diagnostics': Learned rankers include dataset summary
     metadata, the effective tie-breaking mode, the selected consensus
     ranking, and the maximum agreement score.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<55>,  Next: Options<31>,  Prev: Features<32>,  Up: kemeny_young_ranker

6.109.5 Usage
-------------

* Menu:

* Learning a ranker: Learning a ranker<9>.
* Inspecting the learned consensus::
* Ranking candidate items: Ranking candidate items<8>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<9>,  Next: Inspecting the learned consensus,  Up: Usage<55>

6.109.5.1 Learning a ranker
...........................

     % Learn from a pairwise ranking dataset object
     | ?- kemeny_young_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with custom optimal-order tie breaking
     | ?- kemeny_young_ranker::learn(my_dataset, Ranker, [tie_breaking(declaration_order)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting the learned consensus,  Next: Ranking candidate items<8>,  Prev: Learning a ranker<9>,  Up: Usage<55>

6.109.5.2 Inspecting the learned consensus
..........................................

     % Inspect the learned full-item consensus ranking
     | ?- kemeny_young_ranker::learn(my_dataset, Ranker),
          kemeny_young_ranker::consensus_ranking(Ranker, ConsensusRanking).
     ConsensusRanking = [...]
     ...

     % Inspect the maximum pairwise agreement score
     | ?- kemeny_young_ranker::learn(my_dataset, Ranker),
          kemeny_young_ranker::consensus_score(Ranker, ConsensusScore).
     ConsensusScore = ...
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<8>,  Prev: Inspecting the learned consensus,  Up: Usage<55>

6.109.5.3 Ranking candidate items
.................................

     % Rank a candidate set from most preferred to least preferred
     | ?- kemeny_young_ranker::learn(my_dataset, Ranker),
          kemeny_young_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<31>,  Next: Scoring semantics<5>,  Prev: Usage<55>,  Up: kemeny_young_ranker

6.109.6 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘tie_breaking(term_order)’: Select the lexicographically earliest
     optimal consensus ranking using the standard term order of the item
     identifiers.

   - ‘tie_breaking(declaration_order)’: Select the earliest optimal
     consensus ranking using the dataset declaration order preserved by
     the pairwise dataset helpers.

The default is ‘tie_breaking(term_order)’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoring semantics<5>,  Next: Diagnostics syntax<12>,  Prev: Options<31>,  Up: kemeny_young_ranker

6.109.7 Scoring semantics
-------------------------

The learned ‘scores/2’ values are reverse consensus positions.  For a
learned consensus order with ‘N’ items, the first item receives score
‘N-1’ and the last item receives score ‘0’.

This positional encoding is a deterministic surrogate used to satisfy
the shared ‘ranker_protocol’ scoring interface.  The authoritative
Kemeny-Young output is the full ‘consensus_ranking/2’ order together
with its ‘consensus_score/2’ agreement value.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<12>,  Next: Ranker representation<9>,  Prev: Scoring semantics<5>,  Up: kemeny_young_ranker

6.109.8 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(kemeny_young_ranker),
         options(Options),
         consensus_ranking(ConsensusRanking),
         consensus_score(ConsensusScore),
         dataset_summary(DatasetSummary)
     ]


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<9>,  Next: Notes<8>,  Prev: Diagnostics syntax<12>,  Up: kemeny_young_ranker

6.109.9 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     kemeny_young_ranker(Items, Scores, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Score’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, selected consensus ranking, maximum agreement score, and
     dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<8>,  Next: References<21>,  Prev: Ranker representation<9>,  Up: kemeny_young_ranker

6.109.10 Notes
--------------

Kemeny-Young optimization is NP-hard in general.  This implementation
uses an exact branch-and-bound search and is intended for small to
moderate item sets.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<21>,  Prev: Notes<8>,  Up: kemeny_young_ranker

6.109.11 References
-------------------

  1. Kemeny, J. G. (1959).  'Mathematics without numbers'.

  2. Young, H. P. (1988).  'Condorcet’s theory of voting'.


File: TheLogtalkHandbook-3.100.1.info,  Node: kernel_svm_classifier,  Next: kernel_pca_projection,  Prev: kemeny_young_ranker,  Up: Libraries

6.110 ‘kernel_svm_classifier’
=============================

Kernel support vector machine classifier using one-vs-rest dual margin
models with linear, polynomial, and radial basis function kernels.  The
implementation encodes tabular datasets using the shared linear encoder
pipeline so mixed continuous and categorical datasets are handled
consistently with the existing linear classifiers.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset, using it to make predictions, estimating
class probabilities, and exporting it as a list of predicate clauses or
to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  Continuous,
categorical, and mixed-feature datasets are supported.

* Menu:

* API documentation: API documentation<128>.
* Loading: Loading<130>.
* Testing: Testing<122>.
* Features: Features<33>.
* Options: Options<32>.
* Usage: Usage<56>.
* Classifier representation: Classifier representation<3>.
* References: References<22>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<128>,  Next: Loading<130>,  Up: kernel_svm_classifier

6.110.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#kernel_svm_classifier’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<130>,  Next: Testing<122>,  Prev: API documentation<128>,  Up: kernel_svm_classifier

6.110.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kernel_svm_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<122>,  Next: Features<33>,  Prev: Loading<130>,  Up: kernel_svm_classifier

6.110.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kernel_svm_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<33>,  Next: Options<32>,  Prev: Testing<122>,  Up: kernel_svm_classifier

6.110.4 Features
----------------

   - 'Binary and Multiclass Classification': Learns one-vs-rest dual
     models and predicts the class with the highest decision score.

   - 'Multiple Kernels': Supports ‘linear’, ‘polynomial(Degree, Gamma,
     Coef0)’, and ‘rbf(Gamma)’ kernels.

   - 'Mixed Features': Reuses the shared tabular encoders for continuous
     and categorical attributes, including missing-value indicators.

   - 'Probability Estimation': Provides class probabilities using a
     softmax over kernel decision scores.

   - 'Regularized Training': Supports configurable learning-rate
     scheduling, tolerance, and L2 regularization.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<32>,  Next: Usage<56>,  Prev: Features<33>,  Up: kernel_svm_classifier

6.110.5 Options
---------------

The ‘learn/3’ predicate supports these options:

   - ‘kernel/1’ - kernel function to use (default: ‘linear’)

   - ‘learning_rate/1’ - base learning rate for the dual optimization
     loop (default: ‘0.5’)

   - ‘learning_schedule/1’ - learning-rate schedule, either ‘constant’
     or ‘inverse_scaling(Power)’ (default: ‘constant’)

   - ‘maximum_iterations/1’ - maximum number of optimization epochs
     (default: ‘25’)

   - ‘tolerance/1’ - convergence threshold for the maximum parameter
     update (default: ‘1.0e-5’)

   - ‘l2_regularization/1’ - L2 penalty factor applied during
     optimization (default: ‘0.001’)

   - ‘feature_scaling/1’ - whether to standardize continuous attributes
     before encoding (default: ‘true’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<56>,  Next: Classifier representation<3>,  Prev: Options<32>,  Up: kernel_svm_classifier

6.110.6 Usage
-------------

* Menu:

* Learning a classifier: Learning a classifier<2>.
* Making predictions: Making predictions<2>.
* Exporting the classifier: Exporting the classifier<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a classifier<2>,  Next: Making predictions<2>,  Up: Usage<56>

6.110.6.1 Learning a classifier
...............................

     | ?- kernel_svm_classifier::learn(weather, Classifier).

     | ?- kernel_svm_classifier::learn(mixed, Classifier, [kernel(rbf(0.5)), maximum_iterations(50)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Making predictions<2>,  Next: Exporting the classifier<2>,  Prev: Learning a classifier<2>,  Up: Usage<56>

6.110.6.2 Making predictions
............................

     | ?- kernel_svm_classifier::learn(mixed, Classifier),
          kernel_svm_classifier::predict(Classifier, [age-35, income-65000, student-yes, credit_rating-fair], Class).

     | ?- kernel_svm_classifier::learn(weather, Classifier),
          kernel_svm_classifier::predict_probabilities(Classifier, [outlook-sunny, temperature-hot, humidity-high, windy-false], Probabilities).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the classifier<2>,  Prev: Making predictions<2>,  Up: Usage<56>

6.110.6.3 Exporting the classifier
..................................

     | ?- kernel_svm_classifier::learn(weather, Classifier),
          kernel_svm_classifier::export_to_clauses(weather, Classifier, classify, Clauses).

     | ?- kernel_svm_classifier::learn(weather, Classifier),
          kernel_svm_classifier::export_to_file(weather, Classifier, classify, 'classifier.pl').


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<3>,  Next: References<22>,  Prev: Usage<56>,  Up: kernel_svm_classifier

6.110.7 Classifier representation
---------------------------------

The learned classifier is represented as a compound term with the form:

     kernel_svm_classifier(Classes, Encoders, Kernel, TrainingRows, Models, Options)

Where:

   - ‘Classes’: list of class labels

   - ‘Encoders’: list of continuous scaling descriptors and categorical
     value encoders

   - ‘Kernel’: selected kernel specification

   - ‘TrainingRows’: encoded feature vectors for the training examples

   - ‘Models’: list of ‘class_model(Class, Bias, Coefficients)’ terms

   - ‘Options’: merged training options used to learn the classifier

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<22>,  Prev: Classifier representation<3>,  Up: kernel_svm_classifier

6.110.8 References
------------------

  1. Cortes, C. and Vapnik, V. (1995).  “Support-Vector Networks”.

  2. Scholkopf, B. and Smola, A.J. (2002).  “Learning with Kernels”.

  3. Bishop, C.M. (2006).  “Pattern Recognition and Machine Learning”.
     Chapter 7.


File: TheLogtalkHandbook-3.100.1.info,  Node: kernel_pca_projection,  Next: kmeans_clusterer,  Prev: kernel_svm_classifier,  Up: Libraries

6.111 ‘kernel_pca_projection’
=============================

Kernel Principal Component Analysis reducer for continuous datasets.
The library implements the ‘dimension_reducer_protocol’ defined in the
‘dimension_reduction_protocols’ library and learns a nonlinear
projection by centering the training data, optionally standardizing
continuous attributes, building a centered kernel Gram matrix, and
extracting deterministic principal directions in sample space using
portable power iteration with deflation.

* Menu:

* API documentation: API documentation<129>.
* Loading: Loading<131>.
* Testing: Testing<123>.
* Features: Features<34>.
* Options: Options<33>.
* Usage: Usage<57>.
* Dimension reducer representation: Dimension reducer representation<2>.
* References: References<23>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<129>,  Next: Loading<131>,  Up: kernel_pca_projection

6.111.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#kernel_pca_projection’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<131>,  Next: Testing<123>,  Prev: API documentation<129>,  Up: kernel_pca_projection

6.111.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kernel_pca_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<123>,  Next: Features<34>,  Prev: Loading<131>,  Up: kernel_pca_projection

6.111.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kernel_pca_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<34>,  Next: Options<33>,  Prev: Testing<123>,  Up: kernel_pca_projection

6.111.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.  Missing or nonnumeric values are rejected.

   - 'Centering and Optional Scaling': Centers all attributes and
     optionally standardizes them before evaluating kernels.

   - 'Configurable Shortfall Handling': Lets callers choose whether a
     component-extraction shortfall raises an error or truncates the
     learned reducer with explicit diagnostics.

   - 'Supported Kernels': Supports linear, polynomial with non-negative
     offset, and radial basis function kernels through the ‘kernel/1’
     option.

   - 'Shared Gram-Centering Helpers': Delegates training Gram-matrix
     centering and out-of-sample Gram-vector centering to the shared
     ‘linear_algebra’ library.

   - 'Portable Eigensolver': Uses deterministic power iteration with
     deflation instead of backend-specific linear algebra libraries.

   - 'Projection API': Transforms a new instance into a list of
     ‘component_N-Value’ pairs using centered kernel evaluations against
     the training rows.

   - 'Model Export': Learned reducers can be exported as predicate
     clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<33>,  Next: Usage<57>,  Prev: Features<34>,  Up: kernel_pca_projection

6.111.5 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘n_components/1’: Number of kernel principal components to extract.
     Requests that exceed ‘SampleCount - 1’ raise
     ‘domain_error(component_count, Requested-Maximum)’.  The default is
     ‘2’.

   - ‘feature_scaling/1’: Whether to standardize continuous attributes
     before evaluating kernels.  Options: ‘true’ (default) or ‘false’.

   - ‘shortfall_policy/1’: Controls what happens when the centered
     kernel Gram matrix yields fewer numerically significant components
     than requested.  Options: ‘truncate’ (default), which returns a
     reducer with fewer components and records a
     ‘shortfall(truncated(Requested, Learned, ResidualEigenvalue,
     Tolerance))’ diagnostic, or ‘error’, which raises
     ‘domain_error(component_count, Requested-Learned)’.

   - ‘kernel/1’: Kernel specification.  Supported values are ‘linear’
     (default), ‘polynomial(Degree, Gamma, Coef0)’ with positive
     ‘Degree’, positive ‘Gamma’, and non-negative ‘Coef0’, and
     ‘rbf(Gamma)’ with positive ‘Gamma’.

   - ‘maximum_iterations/1’: Maximum number of power-iteration steps
     used when estimating each dual principal direction.  The default is
     ‘1000’.

   - ‘tolerance/1’: Positive convergence tolerance used both for
     power-iteration stopping and for deciding when deflated eigenvalues
     are negligible.  The default is ‘1.0e-8’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<57>,  Next: Dimension reducer representation<2>,  Prev: Options<33>,  Up: kernel_pca_projection

6.111.6 Usage
-------------

The following examples use the sample datasets shipped with the
‘dimension_reduction_protocols’ library:

     | ?- logtalk_load(dimension_reduction_protocols('test_datasets/correlated_plane')).

* Menu:

* Learning a reducer: Learning a reducer<2>.
* Transforming new instances: Transforming new instances<2>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a reducer<2>,  Next: Transforming new instances<2>,  Up: Usage<57>

6.111.6.1 Learning a reducer
............................

     | ?- kernel_pca_projection::learn(correlated_plane, DimensionReducer).

     | ?- kernel_pca_projection::learn(correlated_plane, DimensionReducer, [n_components(1), kernel(rbf(0.25))]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transforming new instances<2>,  Next: Exporting and reusing the reducer<2>,  Prev: Learning a reducer<2>,  Up: Usage<57>

6.111.6.2 Transforming new instances
....................................

     | ?- kernel_pca_projection::learn(correlated_plane, DimensionReducer, [n_components(2), kernel(rbf(0.25))]),
          kernel_pca_projection::transform(DimensionReducer, [x-2.0, y-4.0, z-6.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting and reusing the reducer<2>,  Prev: Transforming new instances<2>,  Up: Usage<57>

6.111.6.3 Exporting and reusing the reducer
...........................................

     | ?- kernel_pca_projection::learn(correlated_plane, DimensionReducer, [n_components(1)]),
          kernel_pca_projection::export_to_file(correlated_plane, DimensionReducer, reducer, 'kernel_pca_reducer.pl').

     | ?- logtalk_load('kernel_pca_reducer.pl'),
          reducer(Reducer),
          kernel_pca_projection::transform(Reducer, [x-1.0, y-2.0, z-3.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation<2>,  Next: References<23>,  Prev: Usage<57>,  Up: kernel_pca_projection

6.111.7 Dimension reducer representation
----------------------------------------

The learned dimension reducer is represented by a compound term with the
functor chosen by the implementation and arity 7.  For example:

     kernel_pca_reducer(Encoders, TrainingRows, RowMeans, TotalMean, Components, ExplainedVariances, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘TrainingRows’: Encoded training rows used when evaluating kernels
     for new instances.

   - ‘RowMeans’: Per-training-row kernel means used for centering
     out-of-sample kernel vectors.

   - ‘TotalMean’: Global kernel mean used for centering both the
     training Gram matrix and new kernel vectors.

   - ‘Components’: List of normalized dual projection vectors in
     descending variance order.

   - ‘ExplainedVariances’: List of kernel Gram matrix eigenvalues
     matching the extracted components.

   - ‘Diagnostics’: Learned metadata including the effective training
     options, kernel preprocessing, sample count, explained variances,
     and optional truncate-mode shortfall details.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
reducer term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<23>,  Prev: Dimension reducer representation<2>,  Up: kernel_pca_projection

6.111.8 References
------------------

  1. Schölkopf, B., Smola, A., and Müller, K.-R. (1998) - “Nonlinear
     component analysis as a kernel eigenvalue problem”.

  2. Shawe-Taylor, J. and Cristianini, N. (2004) - “Kernel Methods for
     Pattern Analysis”.


File: TheLogtalkHandbook-3.100.1.info,  Node: kmeans_clusterer,  Next: kmedians_clusterer,  Prev: kernel_pca_projection,  Up: Libraries

6.112 ‘kmeans_clusterer’
========================

k-Means clusterer.  It uses Lloyd’s algorithm with deterministic
initialization.  Supports continuous attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<130>.
* Loading: Loading<132>.
* Testing: Testing<124>.
* Features: Features<35>.
* Options: Options<34>.
* Diagnostics: Diagnostics<5>.
* Clusterer representation: Clusterer representation<7>.
* References: References<24>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<130>,  Next: Loading<132>,  Up: kmeans_clusterer

6.112.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#kmeans_clusterer’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<132>,  Next: Testing<124>,  Prev: API documentation<130>,  Up: kmeans_clusterer

6.112.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kmeans_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<124>,  Next: Features<35>,  Prev: Loading<132>,  Up: kmeans_clusterer

6.112.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kmeans_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(kmeans_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<35>,  Next: Options<34>,  Prev: Testing<124>,  Up: kmeans_clusterer

6.112.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Deterministic Initialization': Supports ‘first_k’ and
     deterministic ‘spread’ initialization that repeatedly chooses the
     farthest example from the centroids selected so far.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Rich Training Diagnostics': Learned clusterers report training
     example count, convergence status, iteration count, and final
     centroid shift.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.

   - 'Stable Empty-Cluster Handling': Empty clusters keep their previous
     centroids instead of failing.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<34>,  Next: Diagnostics<5>,  Prev: Features<35>,  Up: kmeans_clusterer

6.112.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of clusters to learn.  Default is ‘2’.

   - ‘maximum_iterations(Iterations)’: Maximum number of Lloyd
     iterations.  Default is ‘100’.

   - ‘tolerance(Tolerance)’: Maximum centroid shift threshold for
     convergence.  Default is ‘1.0e-6’.

   - ‘initialization(Initialization)’: Centroid initialization strategy.
     Options: ‘spread’ (default) or ‘first_k’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<5>,  Next: Clusterer representation<7>,  Prev: Options<34>,  Up: kmeans_clusterer

6.112.6 Diagnostics
-------------------

The ‘diagnostics/2’ predicate returns a list containing:

   - ‘model(kmeans_clusterer)’

   - ‘centroid_count(Count)’

   - ‘training_example_count(Count)’

   - ‘convergence(Reason)’

   - ‘iterations(Count)’

   - ‘final_shift(Shift)’

   - ‘options(Options)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<7>,  Next: References<24>,  Prev: Diagnostics<5>,  Up: kmeans_clusterer

6.112.7 Clusterer representation
--------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     kmeans_clusterer(Encoders, Centroids, Options, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Centroids’: List of centroid vectors in cluster-id order.

   - ‘Options’: Effective training options used to learn the clusterer.

   - ‘Diagnostics’: Training diagnostics metadata returned by the
     ‘diagnostics/2’ predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<24>,  Prev: Clusterer representation<7>,  Up: kmeans_clusterer

6.112.8 References
------------------

  1. MacQueen (1967) - “Some Methods for Classification and Analysis of
     Multivariate Observations”.  Proceedings of the Fifth Berkeley
     Symposium on Mathematical Statistics and Probability.

  2. Lloyd (1982) - “Least Squares Quantization in PCM”.  IEEE
     Transactions on Information Theory, 28(2), 129-137.


File: TheLogtalkHandbook-3.100.1.info,  Node: kmedians_clusterer,  Next: kmedoids_clusterer,  Prev: kmeans_clusterer,  Up: Libraries

6.113 ‘kmedians_clusterer’
==========================

k-Medians clusterer.  It uses an iterative median-update algorithm with
deterministic initialization.  Supports continuous attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<131>.
* Loading: Loading<133>.
* Testing: Testing<125>.
* Features: Features<36>.
* Options: Options<35>.
* Diagnostics: Diagnostics<6>.
* Clusterer representation: Clusterer representation<8>.
* References: References<25>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<131>,  Next: Loading<133>,  Up: kmedians_clusterer

6.113.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#kmedians_clusterer’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<133>,  Next: Testing<125>,  Prev: API documentation<131>,  Up: kmedians_clusterer

6.113.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kmedians_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<125>,  Next: Features<36>,  Prev: Loading<133>,  Up: kmedians_clusterer

6.113.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kmedians_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(kmedians_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<36>,  Next: Options<35>,  Prev: Testing<125>,  Up: kmedians_clusterer

6.113.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Deterministic Initialization': Supports ‘first_k’ and
     deterministic ‘spread’ initialization that repeatedly chooses the
     farthest example from the medians selected so far.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Manhattan Distance': Uses Manhattan distance for cluster
     assignment and convergence checks.

   - 'Rich Training Diagnostics': Learned clusterers report training
     example count, convergence status, iteration count, and final
     median shift.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.

   - 'Stable Empty-Cluster Handling': Empty clusters keep their previous
     medians instead of failing.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<35>,  Next: Diagnostics<6>,  Prev: Features<36>,  Up: kmedians_clusterer

6.113.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of clusters to learn.  Default is ‘2’.

   - ‘maximum_iterations(Iterations)’: Maximum number of median-update
     iterations.  Default is ‘100’.

   - ‘tolerance(Tolerance)’: Maximum median shift threshold for
     convergence.  Default is ‘1.0e-6’.

   - ‘initialization(Initialization)’: Median initialization strategy.
     Options: ‘spread’ (default) or ‘first_k’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<6>,  Next: Clusterer representation<8>,  Prev: Options<35>,  Up: kmedians_clusterer

6.113.6 Diagnostics
-------------------

The ‘diagnostics/2’ predicate returns a list containing:

   - ‘model(kmedians_clusterer)’

   - ‘median_count(Count)’

   - ‘training_example_count(Count)’

   - ‘convergence(Reason)’

   - ‘iterations(Count)’

   - ‘final_shift(Shift)’

   - ‘options(Options)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<8>,  Next: References<25>,  Prev: Diagnostics<6>,  Up: kmedians_clusterer

6.113.7 Clusterer representation
--------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     kmedians_clusterer(Encoders, Medians, Options, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Medians’: List of median vectors in cluster-id order.

   - ‘Options’: Effective training options used to learn the clusterer.

   - ‘Diagnostics’: Training diagnostics metadata returned by the
     ‘diagnostics/2’ predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<25>,  Prev: Clusterer representation<8>,  Up: kmedians_clusterer

6.113.8 References
------------------

  1. MacQueen (1967) - “Some Methods for Classification and Analysis of
     Multivariate Observations”.  Proceedings of the Fifth Berkeley
     Symposium on Mathematical Statistics and Probability.

  2. Kaufman & Rousseeuw (1990) - “Finding Groups in Data: An
     Introduction to Cluster Analysis”.  Wiley.


File: TheLogtalkHandbook-3.100.1.info,  Node: kmedoids_clusterer,  Next: kmodes_clusterer,  Prev: kmedians_clusterer,  Up: Libraries

6.114 ‘kmedoids_clusterer’
==========================

k-Medoids clusterer.  It uses an iterative medoid-update algorithm with
deterministic initialization and deterministic cluster assignments.
Supports continuous attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<132>.
* Loading: Loading<134>.
* Testing: Testing<126>.
* Features: Features<37>.
* Options: Options<36>.
* Diagnostics: Diagnostics<7>.
* Clusterer representation: Clusterer representation<9>.
* References: References<26>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<132>,  Next: Loading<134>,  Up: kmedoids_clusterer

6.114.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#kmedoids_clusterer’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<134>,  Next: Testing<126>,  Prev: API documentation<132>,  Up: kmedoids_clusterer

6.114.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kmedoids_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<126>,  Next: Features<37>,  Prev: Loading<134>,  Up: kmedoids_clusterer

6.114.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kmedoids_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(kmedoids_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<37>,  Next: Options<36>,  Prev: Testing<126>,  Up: kmedoids_clusterer

6.114.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Distance Metrics': Supports Euclidean and Manhattan distances.

   - 'Deterministic Initialization': Supports ‘first_k’ and
     deterministic ‘spread’ initialization that repeatedly chooses the
     farthest example from the medoids selected so far.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Rich Training Diagnostics': Learned clusterers report training
     example count, convergence status, iteration count, and final
     medoid shift.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.

   - 'Stable Empty-Cluster Handling': Empty clusters keep their previous
     medoids instead of failing.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<36>,  Next: Diagnostics<7>,  Prev: Features<37>,  Up: kmedoids_clusterer

6.114.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of clusters to learn.  Default is ‘2’.

   - ‘maximum_iterations(Iterations)’: Maximum number of medoid-update
     iterations.  Default is ‘100’.

   - ‘tolerance(Tolerance)’: Maximum medoid shift threshold for
     convergence.  Default is ‘1.0e-6’.

   - ‘initialization(Initialization)’: Medoid initialization strategy.
     Options: ‘spread’ (default) or ‘first_k’.

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default) or ‘manhattan’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<7>,  Next: Clusterer representation<9>,  Prev: Options<36>,  Up: kmedoids_clusterer

6.114.6 Diagnostics
-------------------

The ‘diagnostics/2’ predicate returns a list containing:

   - ‘model(kmedoids_clusterer)’

   - ‘medoid_count(Count)’

   - ‘training_example_count(Count)’

   - ‘convergence(Reason)’

   - ‘iterations(Count)’

   - ‘final_shift(Shift)’

   - ‘options(Options)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<9>,  Next: References<26>,  Prev: Diagnostics<7>,  Up: kmedoids_clusterer

6.114.7 Clusterer representation
--------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     kmedoids_clusterer(Encoders, Medoids, Options, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Medoids’: List of medoid vectors in cluster-id order.

   - ‘Options’: Effective training options used to learn the clusterer.

   - ‘Diagnostics’: Training diagnostics metadata returned by the
     ‘diagnostics/2’ predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<26>,  Prev: Clusterer representation<9>,  Up: kmedoids_clusterer

6.114.8 References
------------------

  1. Kaufman & Rousseeuw (1987) - “Clustering by Means of Medoids”.  In
     Statistical Data Analysis Based on the L1-Norm and Related Methods.

  2. Kaufman & Rousseeuw (1990) - “Finding Groups in Data: An
     Introduction to Cluster Analysis”.  Wiley.


File: TheLogtalkHandbook-3.100.1.info,  Node: kmodes_clusterer,  Next: knn_classifier,  Prev: kmedoids_clusterer,  Up: Libraries

6.115 ‘kmodes_clusterer’
========================

k-Modes clusterer.  It uses an iterative mode-update algorithm with
deterministic initialization and deterministic cluster assignments.
Supports discrete attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<133>.
* Loading: Loading<135>.
* Testing: Testing<127>.
* Features: Features<38>.
* Options: Options<37>.
* Diagnostics: Diagnostics<8>.
* Clusterer representation: Clusterer representation<10>.
* References: References<27>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<133>,  Next: Loading<135>,  Up: kmodes_clusterer

6.115.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#kmodes_clusterer’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<135>,  Next: Testing<127>,  Prev: API documentation<133>,  Up: kmodes_clusterer

6.115.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kmodes_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<127>,  Next: Features<38>,  Prev: Loading<135>,  Up: kmodes_clusterer

6.115.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kmodes_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(kmodes_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<38>,  Next: Options<37>,  Prev: Testing<127>,  Up: kmodes_clusterer

6.115.4 Features
----------------

   - 'Discrete Datasets': Accepts datasets containing only discrete
     attributes.

   - 'Deterministic Initialization': Supports ‘first_k’ and
     deterministic ‘spread’ initialization that repeatedly chooses the
     farthest example from the modes selected so far.

   - 'Rich Training Diagnostics': Learned clusterers report training
     example count, convergence status, iteration count, and final mode
     shift.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.

   - 'Stable Empty-Cluster Handling': Empty clusters keep their previous
     modes instead of failing.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<37>,  Next: Diagnostics<8>,  Prev: Features<38>,  Up: kmodes_clusterer

6.115.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of clusters to learn.  Default is ‘2’.

   - ‘maximum_iterations(Iterations)’: Maximum number of mode-update
     iterations.  Default is ‘100’.

   - ‘tolerance(Tolerance)’: Maximum mode shift threshold for
     convergence.  Default is ‘0.0’.

   - ‘initialization(Initialization)’: Mode initialization strategy.
     Options: ‘spread’ (default) or ‘first_k’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<8>,  Next: Clusterer representation<10>,  Prev: Options<37>,  Up: kmodes_clusterer

6.115.6 Diagnostics
-------------------

The ‘diagnostics/2’ predicate returns a list containing:

   - ‘model(kmodes_clusterer)’

   - ‘mode_count(Count)’

   - ‘training_example_count(Count)’

   - ‘convergence(Reason)’

   - ‘iterations(Count)’

   - ‘final_shift(Shift)’

   - ‘options(Options)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<10>,  Next: References<27>,  Prev: Diagnostics<8>,  Up: kmodes_clusterer

6.115.7 Clusterer representation
--------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     kmodes_clusterer(Encoders, Modes, Options, Diagnostics)

Where:

   - ‘Encoders’: List of discrete attribute encoders.

   - ‘Modes’: List of learned categorical modes in cluster-id order.

   - ‘Options’: Effective training options used to learn the clusterer.

   - ‘Diagnostics’: Training diagnostics metadata returned by the
     ‘diagnostics/2’ predicate.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<27>,  Prev: Clusterer representation<10>,  Up: kmodes_clusterer

6.115.8 References
------------------

  1. Huang (1998) - “Extensions to the k-means algorithm for clustering
     large data sets with categorical values”.  Data Mining and
     Knowledge Discovery, 2, 283-304.


File: TheLogtalkHandbook-3.100.1.info,  Node: knn_classifier,  Next: knn_distance_anomaly_detector,  Prev: kmodes_clusterer,  Up: Libraries

6.116 ‘knn_classifier’
======================

k-Nearest Neighbors classifier supporting multiple distance metrics,
weighting schemes, and both categorical and continuous features.  This
is a lazy learning algorithm that classifies instances based on the
majority class among the k nearest training instances.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset, using it to make predictions, and exporting
it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  See ‘test_files’
directory for examples.

* Menu:

* API documentation: API documentation<134>.
* Loading: Loading<136>.
* Testing: Testing<128>.
* Features: Features<39>.
* Usage: Usage<58>.
* Options: Options<38>.
* Classifier representation: Classifier representation<4>.
* References: References<28>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<134>,  Next: Loading<136>,  Up: knn_classifier

6.116.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#knn_classifier’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<136>,  Next: Testing<128>,  Prev: API documentation<134>,  Up: knn_classifier

6.116.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(knn_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<128>,  Next: Features<39>,  Prev: Loading<136>,  Up: knn_classifier

6.116.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(knn_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<39>,  Next: Usage<58>,  Prev: Testing<128>,  Up: knn_classifier

6.116.4 Features
----------------

   - 'Multiple Distance Metrics': Euclidean, Manhattan, Chebyshev,
     Minkowski.

   - 'Flexible Weighting': Uniform, distance-based, and Gaussian
     weighting of neighbors.

   - 'Mixed Features': Automatically handles categorical and continuous
     features.

   - 'Configurable Options': k value, distance metric, and weighting
     scheme via predicate options.

   - 'Probability Estimation': Provides confidence scores for
     predictions.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<58>,  Next: Options<38>,  Prev: Features<39>,  Up: knn_classifier

6.116.5 Usage
-------------

* Menu:

* Learning a Classifier: Learning a Classifier<2>.
* Making Predictions: Making Predictions<2>.
* Exporting the Classifier: Exporting the Classifier<2>.
* Using a learned classifier::


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a Classifier<2>,  Next: Making Predictions<2>,  Up: Usage<58>

6.116.5.1 Learning a Classifier
...............................

     % Learn from a dataset object with default options (k=3, euclidean, uniform)
     | ?- knn_classifier::learn(my_dataset, Classifier).
     ...

     % Learn with custom options
     | ?- knn_classifier::learn(my_dataset, Classifier, [k(5), distance_metric(manhattan)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Making Predictions<2>,  Next: Exporting the Classifier<2>,  Prev: Learning a Classifier<2>,  Up: Usage<58>

6.116.5.2 Making Predictions
............................

     % Predict class for a new instance
     | ?- Instance = [attr1-value1, attr2-value2, ...],
          knn_classifier::learn(my_dataset, Classifier),
          knn_classifier::predict(Classifier, Instance, PredictedClass).
     PredictedClass = ...
     ...

     % Predict with custom options
     | ?- knn_classifier::predict(Classifier, Instance, PredictedClass, [k(5), weight_scheme(distance)]).
     ...

     % Get probability distribution
     | ?- knn_classifier::predict_probabilities(Classifier, Instance, Probabilities).
     Probabilities = [class1-0.67, class2-0.33]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the Classifier<2>,  Next: Using a learned classifier,  Prev: Making Predictions<2>,  Up: Usage<58>

6.116.5.3 Exporting the Classifier
..................................

Learned classifiers can be exported as a list of clauses or to a file
for later use.

     % Export as predicate clauses
     | ?- knn_classifier::learn(my_dataset, Classifier),
          knn_classifier::export_to_clauses(my_dataset, Classifier, my_classifier, Clauses).
     Clauses = [my_classifier(...)]
     ...

     % Export to a file
     | ?- knn_classifier::learn(my_dataset, Classifier),
          knn_classifier::export_to_file(my_dataset, Classifier, my_classifier, 'classifier.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Using a learned classifier,  Prev: Exporting the Classifier<2>,  Up: Usage<58>

6.116.5.4 Using a learned classifier
....................................

Learned and saved classifiers can later be used for predictions without
needing to access the original training dataset.

     % Later, load the file and use the classifier
     | ?- consult('classifier.pl'),
          my_classifier(Classifier),
          Instance = [...],
          knn_classifier::predict(Classifier, Instance, Class).
     Class = ...
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<38>,  Next: Classifier representation<4>,  Prev: Usage<58>,  Up: knn_classifier

6.116.6 Options
---------------

The following options can be passed to the ‘predict/4’ and
‘predict_probabilities/4’ predicates:

   - ‘k(K)’: Number of neighbors to consider (default: 3)

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default), ‘manhattan’, ‘chebyshev’, ‘minkowski’

   - ‘weight_scheme(Scheme)’: Weighting scheme for neighbor votes.
     Options: ‘uniform’ (default), ‘distance’, ‘gaussian’


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<4>,  Next: References<28>,  Prev: Options<38>,  Up: knn_classifier

6.116.7 Classifier representation
---------------------------------

The learned classifier is represented as a compound term:

     knn_classifier(AttributeNames, FeatureTypes, Instances)

Where:

   - ‘AttributeNames’: List of attribute names in order

   - ‘FeatureTypes’: List of types (‘numeric’ or ‘categorical’)

   - ‘Instances’: List of ‘Values-Class’ pairs (the training data in
     compact form)

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<28>,  Prev: Classifier representation<4>,  Up: knn_classifier

6.116.8 References
------------------

  1. Cover, T. & Hart, P. (1967).  “Nearest neighbor pattern
     classification”.  IEEE Transactions on Information Theory.

  2. Hastie, T., Tibshirani, R., & Friedman, J. (2009).  “The Elements
     of Statistical Learning”.  Chapter 13.

  3. Mitchell, T. (1997).  “Machine Learning”.  Chapter 8:
     Instance-Based Learning.


File: TheLogtalkHandbook-3.100.1.info,  Node: knn_distance_anomaly_detector,  Next: knn_regression,  Prev: knn_classifier,  Up: Libraries

6.117 ‘knn_distance_anomaly_detector’
=====================================

k-nearest-neighbor distance anomaly detector supporting multiple
distance metrics, mixed continuous and categorical features, and missing
values.  The detector memorizes the training instances and computes an
anomaly score from normalized distances to the nearest neighbors.
Larger distances indicate more isolated and therefore more anomalous
instances.

The library implements the ‘anomaly_detector_protocol’ defined in the
‘anomaly_detection_protocols’ library.  It learns a compact detector
from a dataset by selecting baseline training examples from the declared
class labels, computes anomaly scores for new instances, predicts
‘normal’ or ‘anomaly’, and exports learned detectors as clauses or
files.

Datasets are represented as objects implementing the
‘anomaly_dataset_protocol’ protocol from the
‘anomaly_detection_protocols’ library.  See the
‘anomaly_detection_protocols/test_datasets’ directory for examples.

* Menu:

* API documentation: API documentation<135>.
* Loading: Loading<137>.
* Testing: Testing<129>.
* Features: Features<40>.
* Options: Options<39>.
* Detector representation: Detector representation<5>.
* References: References<29>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<135>,  Next: Loading<137>,  Up: knn_distance_anomaly_detector

6.117.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#knn_distance_anomaly_detector’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<137>,  Next: Testing<129>,  Prev: API documentation<135>,  Up: knn_distance_anomaly_detector

6.117.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(knn_distance_anomaly_detector(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<129>,  Next: Features<40>,  Prev: Loading<137>,  Up: knn_distance_anomaly_detector

6.117.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(knn_distance_anomaly_detector(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<40>,  Next: Options<39>,  Prev: Testing<129>,  Up: knn_distance_anomaly_detector

6.117.4 Features
----------------

   - 'Distance-based anomaly scoring': supports both distance to the
     k-th neighbor and average distance to the k nearest neighbors.

   - 'Mixed features': automatically handles continuous and categorical
     features declared by the dataset.

   - 'Missing values': ignores missing dimensions while normalizing
     distances (distances are normalized by the number of comparable
     dimensions).

   - 'Baseline training selection': ‘baseline_class_values/1’ declares
     which class labels are admissible for fitting the detector, while
     ‘baseline_selection_policy/1’ controls whether non-baseline
     examples are rejected (default) or filtered before training.

   - 'Multiple metrics': supports Euclidean, Manhattan, Chebyshev, and
     Minkowski distance metrics.

   - 'Detector export': learned detectors can be exported as predicate
     clauses.

   - 'Dataset validation': learning rejects empty datasets with a
     ‘domain_error(non_empty_dataset, Dataset)’ exception.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<39>,  Next: Detector representation<5>,  Prev: Features<40>,  Up: knn_distance_anomaly_detector

6.117.5 Options
---------------

The following options can be passed to the ‘learn/3’ and ‘predict/4’
predicates:

   - ‘k(K)’: Number of neighbors to consider (default: 5)

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default), ‘manhattan’, ‘chebyshev’, ‘minkowski’

   - ‘score_mode(Mode)’: Score computation mode.  Options:
     ‘kth_distance’ (default) and ‘mean_distance’

   - ‘anomaly_threshold(Threshold)’: Threshold for ‘predict/3-4’
     (default: ‘0.5’)

   - ‘baseline_class_values(Classes)’: Learn-time list of admissible
     baseline class labels (default: ‘[normal]’)

   - ‘baseline_selection_policy(Policy)’: Learn-time handling of
     non-baseline examples.  Supported values are ‘reject’ (default) and
     ‘filter’


File: TheLogtalkHandbook-3.100.1.info,  Node: Detector representation<5>,  Next: References<29>,  Prev: Options<39>,  Up: knn_distance_anomaly_detector

6.117.6 Detector representation
-------------------------------

The learned detector is represented by default as:

     knn_distance_detector(TrainingDataset, AttributeNames, FeatureTypes, AttributeScales, Instances, ReferenceScores, Diagnostics)

Where:

   - ‘AttributeNames’: List of attribute names in order

   - ‘FeatureTypes’: List of feature types (‘numeric’ or ‘categorical’)

   - ‘AttributeScales’: Normalization scales for numeric features

   - ‘Instances’: List of retained baseline training ‘Id-Class-Values’
     triples

   - ‘ReferenceScores’: Cached leave-one-out raw training scores for the
     retained baseline training instances

   - ‘Diagnostics’: Learned metadata terms including ‘model/1’,
     ‘training_dataset/1’, ‘attribute_names/1’, ‘feature_types/1’,
     ‘example_count/1’, ‘reference_score_count/1’, and ‘options/1’

The ‘score/3’ predicate always treats its input as a fresh query.  Only
‘score_all/3’ on the original training dataset with the ‘reject’
baseline selection policy reuses the cached leave-one-out
‘ReferenceScores’ for all examples.  With the ‘filter’ policy, retained
baseline training examples reuse the cached leave-one-out scores while
excluded examples are scored as fresh queries against the learned
baseline detector.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
detector term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<29>,  Prev: Detector representation<5>,  Up: knn_distance_anomaly_detector

6.117.7 References
------------------

  1. Angiulli, F. and Pizzuti, C. (2002).  “Fast outlier detection in
     high dimensional spaces”.  PKDD.

  2. Chandola, V., Banerjee, A., and Kumar, V. (2009).  “Anomaly
     detection: A survey”.  ACM Computing Surveys.


File: TheLogtalkHandbook-3.100.1.info,  Node: knn_regression,  Next: kprototypes_clusterer,  Prev: knn_distance_anomaly_detector,  Up: Libraries

6.118 ‘knn_regression’
======================

k-Nearest Neighbors regressor supporting continuous and mixed-feature
datasets.  Learns lazily by storing encoded training rows and predicts
targets as the weighted average of the k nearest neighbors.

The library implements the ‘regressor_protocol’ defined in the
‘regression_protocols’ library, learns lazily by storing encoded
training rows, and predicts numeric targets using the weighted average
of the nearest encoded neighbors.

* Menu:

* API documentation: API documentation<136>.
* Loading: Loading<138>.
* Testing: Testing<130>.
* Features: Features<41>.
* Regressor representation: Regressor representation<5>.
* Diagnostics syntax: Diagnostics syntax<13>.
* Options: Options<40>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<136>,  Next: Loading<138>,  Up: knn_regression

6.118.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#knn_regression’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<138>,  Next: Testing<130>,  Prev: API documentation<136>,  Up: knn_regression

6.118.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(knn_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<130>,  Next: Features<41>,  Prev: Loading<138>,  Up: knn_regression

6.118.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(knn_regression(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(knn_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<41>,  Next: Regressor representation<5>,  Prev: Testing<130>,  Up: knn_regression

6.118.4 Features
----------------

   - 'Distance-Based Regression': Predicts targets using the weighted
     average of the nearest neighbors.

   - 'Multiple Metrics': Supports Euclidean, Manhattan, Chebyshev, and
     Minkowski distance metrics over encoded numeric feature vectors.

   - 'Weighting Schemes': Supports uniform, inverse-distance, and
     Gaussian weighting of neighbors.

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes encoded using reference-level dummy coding
     derived from the declared dataset attribute values.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Missing Values': Missing numeric and categorical values
     represented using anonymous variables are encoded using explicit
     missing-value indicator features.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, encoded feature count, and
     effective options, accessible using the shared regression
     diagnostics predicates.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for representative
     regression datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<5>,  Next: Diagnostics syntax<13>,  Prev: Features<41>,  Up: knn_regression

6.118.5 Regressor representation
--------------------------------

The learned regressor is represented by default as:

   - ‘knn_regressor(Encoders, Rows, Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(Encoders, Rows, Diagnostics)’

In this representation, ‘Rows’ stores encoded feature vectors paired
with numeric targets and ‘Diagnostics’ stores training metadata
including the effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<13>,  Next: Options<40>,  Prev: Regressor representation<5>,  Up: knn_regression

6.118.6 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(knn_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         encoded_feature_count(FeatureCount)
     ]

Where:

   - ‘model(knn_regression)’ identifies the learning algorithm that
     produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘encoded_feature_count(FeatureCount)’ stores the number of numeric
     features induced by the encoder list, including missing-value
     indicator features.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<40>,  Prev: Diagnostics syntax<13>,  Up: knn_regression

6.118.7 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘k/1’: Number of nearest neighbors considered for each prediction.
     Smaller values make predictions more local; larger values smooth
     them by averaging over more training rows.  The default is ‘3’.

   - ‘distance_metric/1’: Distance function used to compare encoded
     feature vectors.  Accepted values are ‘euclidean’, ‘manhattan’,
     ‘chebyshev’, and ‘minkowski’.  The default is ‘euclidean’.

   - ‘weight_scheme/1’: Neighbor weighting policy used when averaging
     targets.  Accepted values are ‘uniform’, ‘distance’, and
     ‘gaussian’.  The default is ‘uniform’.

   - ‘minkowski_power/1’: Exponent used when
     ‘distance_metric(minkowski)’ is selected.  Larger values increase
     the influence of larger coordinate differences.  The default is
     ‘3.0’.

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes before storing rows and encoding prediction requests.
     Accepted values are ‘true’ and ‘false’.  The default is ‘true’.


File: TheLogtalkHandbook-3.100.1.info,  Node: kprototypes_clusterer,  Next: ksuid,  Prev: knn_regression,  Up: Libraries

6.119 ‘kprototypes_clusterer’
=============================

k-Prototypes clusterer.  It uses an iterative prototype-update algorithm
with deterministic initialization and deterministic cluster assignments.
Supports continuous and discrete attributes in the same dataset.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<137>.
* Loading: Loading<139>.
* Testing: Testing<131>.
* Features: Features<42>.
* Options: Options<41>.
* Distance Function::
* Clusterer representation: Clusterer representation<11>.
* References: References<30>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<137>,  Next: Loading<139>,  Up: kprototypes_clusterer

6.119.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#kprototypes_clusterer’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<139>,  Next: Testing<131>,  Prev: API documentation<137>,  Up: kprototypes_clusterer

6.119.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(kprototypes_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<131>,  Next: Features<42>,  Prev: Loading<139>,  Up: kprototypes_clusterer

6.119.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(kprototypes_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(kprototypes_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<42>,  Next: Options<41>,  Prev: Testing<131>,  Up: kprototypes_clusterer

6.119.4 Features
----------------

   - 'Mixed Datasets': Accepts datasets with continuous, discrete, or
     mixed attributes.

   - 'Strict Attribute Validation': Training examples and prediction
     instances must contain each declared attribute exactly once and no
     undeclared attributes.

   - 'Deterministic Initialization': Supports ‘first_k’ and
     deterministic ‘spread’ initialization that repeatedly chooses the
     farthest example from the prototypes selected so far.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Categorical Weighting': Uses a ‘gamma’ mismatch penalty for
     discrete attributes in the mixed distance function.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.

   - 'Stable Empty-Cluster Handling': Empty clusters keep their previous
     prototypes instead of failing.

   - 'Training Diagnostics': Exposes convergence metadata including
     training example count, iteration count, and final prototype shift.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<41>,  Next: Distance Function,  Prev: Features<42>,  Up: kprototypes_clusterer

6.119.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘k(K)’: Number of clusters to learn.  Default is ‘2’.

   - ‘maximum_iterations(Iterations)’: Maximum number of
     prototype-update iterations.  Default is ‘100’.

   - ‘tolerance(Tolerance)’: Maximum prototype shift threshold for
     convergence.  Default is ‘1.0e-6’.

   - ‘initialization(Initialization)’: Prototype initialization
     strategy.  Options: ‘spread’ (default) or ‘first_k’.

   - ‘gamma(Gamma)’: Penalty added for each discrete-feature mismatch.
     Default is ‘1.0’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Distance Function,  Next: Clusterer representation<11>,  Prev: Options<41>,  Up: kprototypes_clusterer

6.119.6 Distance Function
-------------------------

The mixed k-prototypes distance used for both assignment and prototype
spread initialization is:

     D(X, P) = Sum((x_i - p_i)^2) + gamma * M

where the sum is taken over all continuous attributes and ‘M’ is the
number of discrete-attribute mismatches between the instance ‘X’ and the
prototype ‘P’.

For discrete prototype updates, the selected value for each categorical
attribute is the most frequent value among the cluster members.  When
two or more values are tied, the implementation deterministically keeps
the first value in the declared attribute-values list.


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<11>,  Next: References<30>,  Prev: Distance Function,  Up: kprototypes_clusterer

6.119.7 Clusterer representation
--------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 4.  For
example:

     kprototypes_clusterer(Encoders, Prototypes, Options, Diagnostics)

Where:

   - ‘Encoders’: List of continuous and discrete attribute encoders.

   - ‘Prototypes’: List of learned mixed prototypes in cluster-id order.

   - ‘Options’: Effective training options used to learn the clusterer.

   - ‘Diagnostics’: Training metadata including convergence reason,
     iteration count, and final prototype shift.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<30>,  Prev: Clusterer representation<11>,  Up: kprototypes_clusterer

6.119.8 References
------------------

  1. Huang (1997) - “Clustering large data sets with mixed numeric and
     categorical values”.  Proceedings of the First Pacific-Asia
     Conference on Knowledge Discovery and Data Mining.

  2. Huang (1998) - “Extensions to the k-means algorithm for clustering
     large data sets with categorical values”.  Data Mining and
     Knowledge Discovery, 2, 283-304.


File: TheLogtalkHandbook-3.100.1.info,  Node: ksuid,  Next: lasso_regression,  Prev: kprototypes_clusterer,  Up: Libraries

6.120 ‘ksuid’
=============

This library generates random KSUID identifiers:

‘https://github.com/segmentio/ksuid’

'This library requires a backend supporting unbounded integer
arithmetic.'

By default, identifiers are represented as atoms and encoded using the
canonical Base62 alphabet:

     0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz

The generation of random identifiers uses the ‘/dev/urandom’ random
number generator when available.  This includes macOS, Linux, *BSD, and
other POSIX operating systems.  On Windows, a pseudo-random generator is
used, randomized using the current wall time.

Identifiers can be generated as atoms, lists of characters, or lists of
character codes.

See also the ‘cuid2’, ‘ids’, ‘nanoid’, ‘snowflakeid’, ‘uuid’, and ‘ulid’
libraries.

* Menu:

* API documentation: API documentation<138>.
* Loading: Loading<140>.
* Testing: Testing<132>.
* Usage: Usage<59>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<138>,  Next: Loading<140>,  Up: ksuid

6.120.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#ksuid’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<140>,  Next: Testing<132>,  Prev: API documentation<138>,  Up: ksuid

6.120.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ksuid(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<132>,  Next: Usage<59>,  Prev: Loading<140>,  Up: ksuid

6.120.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ksuid(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<59>,  Prev: Testing<132>,  Up: ksuid

6.120.4 Usage
-------------

To generate a KSUID using the default configuration:

     | ?- ksuid::generate(KSUID).
     KSUID = '2YBXxVf8R5A1x6Yx5Y1AL7bEmel'
     yes

To generate a KSUID represented as a list of characters:

     | ?- ksuid(chars, '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')::generate(KSUID).
     KSUID = ['2','Y','B','X','x','V','f','8','R','5','A','1','x','6','Y','x','5','Y','1','A','L','7','b','E','m','e','l']
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: lasso_regression,  Next: lda_classifier,  Prev: ksuid,  Up: Libraries

6.121 ‘lasso_regression’
========================

Lasso regression regressor supporting continuous and mixed-feature
datasets.  Uses cyclic coordinate descent with soft-thresholding updates
for each encoded feature in order to minimize mean squared error plus an
L1 penalty on the encoded coefficient vector.

The library implements the ‘regressor_protocol’ defined in the
‘regression_protocols’ library and learns a linear model using cyclic
coordinate descent with L1 regularization and soft-thresholding updates
for each encoded feature in order to minimize mean squared error plus an
L1 penalty on the encoded coefficient vector.

* Menu:

* API documentation: API documentation<139>.
* Loading: Loading<141>.
* Testing: Testing<133>.
* Features: Features<43>.
* Regressor representation: Regressor representation<6>.
* Diagnostics syntax: Diagnostics syntax<14>.
* Options: Options<42>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<139>,  Next: Loading<141>,  Up: lasso_regression

6.121.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#lasso_regression’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<141>,  Next: Testing<133>,  Prev: API documentation<139>,  Up: lasso_regression

6.121.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(lasso_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<133>,  Next: Features<43>,  Prev: Loading<141>,  Up: lasso_regression

6.121.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(lasso_regression(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(lasso_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<43>,  Next: Regressor representation<6>,  Prev: Testing<133>,  Up: lasso_regression

6.121.4 Features
----------------

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes

   - 'Categorical Attributes Encoding': Uses reference-level dummy
     coding derived from the declared dataset attribute values, with a
     missing-value indicator, and the resulting encoded coefficients are
     regularized independently.

   - 'Feature Scaling': Continuous attributes can be standardized using
     z-score scaling.

   - 'Missing Values': Missing numeric and categorical values
     represented using anonymous variables are encoded using explicit
     missing-value indicator features.

   - 'Unknown Values': Prediction requests containing categorical values
     that are not declared by the dataset raise a domain error.

   - 'Coefficient-wise L1 Shrinkage': Applies soft-thresholding updates
     independently to every encoded feature, including categorical dummy
     and missing-indicator features.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, optimization stop reason, completed
     iterations, final parameter delta, encoded feature count, and
     effective options, accessible using the shared regression
     diagnostics predicates.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for representative
     regression datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<6>,  Next: Diagnostics syntax<14>,  Prev: Features<43>,  Up: lasso_regression

6.121.5 Regressor representation
--------------------------------

The learned regressor is represented by default as:

   - ‘lasso_regressor(Encoders, Bias, Weights, Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(Encoders, Bias, Weights, Diagnostics)’

In this representation, ‘Encoders’ stores the feature encoding metadata,
‘Bias’ stores the intercept, ‘Weights’ stores one coefficient per
encoded feature, and ‘Diagnostics’ stores training metadata including
the effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<14>,  Next: Options<42>,  Prev: Regressor representation<6>,  Up: lasso_regression

6.121.6 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(lasso_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         convergence(Status),
         iterations(Iterations),
         final_delta(FinalDelta),
         encoded_feature_count(FeatureCount)
     ]

Where:

   - ‘model(lasso_regression)’ identifies the learning algorithm that
     produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘convergence(Status)’ records the optimization stop condition.  The
     current values are ‘tolerance’ when the maximum Karush-Kuhn-Tucker
     optimality violation across the intercept and all encoded features
     is within the configured tolerance and
     ‘maximum_iterations_exhausted’ when training stops because the
     iteration cap is reached.

   - ‘iterations(Iterations)’ stores the number of coordinate-descent
     sweeps completed during training.

   - ‘final_delta(FinalDelta)’ stores the maximum Karush-Kuhn-Tucker
     optimality violation measured during the final optimization check.

   - ‘encoded_feature_count(FeatureCount)’ stores the number of numeric
     features induced by the encoder list, including missing-value
     indicator features.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<42>,  Prev: Diagnostics syntax<14>,  Up: lasso_regression

6.121.7 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘maximum_iterations/1’: Maximum number of coordinate-descent sweeps
     to run before stopping even if the tolerance criterion has not been
     met.  The default is ‘2000’.

   - ‘tolerance/1’: Convergence threshold for the maximum
     Karush-Kuhn-Tucker optimality violation in a full
     coordinate-descent sweep.  Training stops early when both the
     intercept condition and all encoded-feature subgradient conditions
     are satisfied within this value.  The default is ‘1.0e-7’.

   - ‘regularization/1’: L1 penalty coefficient applied independently to
     every encoded feature during optimization.  Higher values increase
     shrinkage and can reduce overfitting.  The default is ‘0.01’.

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes before training and prediction.  Accepted values are
     ‘true’ and ‘false’.  The default is ‘true’.


File: TheLogtalkHandbook-3.100.1.info,  Node: lda_classifier,  Next: lda_projection,  Prev: lasso_regression,  Up: Libraries

6.122 ‘lda_classifier’
======================

Linear Discriminant Analysis classifier for continuous datasets using a
shared pooled covariance estimate with diagonal regularization.  The
implementation learns one linear discriminant function per class and
predicts the class with the highest discriminant score.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset, using it to make predictions, inspecting
class scores, and exporting it as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  All dataset
attributes must be declared as ‘continuous’.

* Menu:

* API documentation: API documentation<140>.
* Loading: Loading<142>.
* Testing: Testing<134>.
* Features: Features<44>.
* Options: Options<43>.
* Usage: Usage<60>.
* Classifier representation: Classifier representation<5>.
* References: References<31>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<140>,  Next: Loading<142>,  Up: lda_classifier

6.122.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#lda_classifier’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<142>,  Next: Testing<134>,  Prev: API documentation<140>,  Up: lda_classifier

6.122.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(lda_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<134>,  Next: Features<44>,  Prev: Loading<142>,  Up: lda_classifier

6.122.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(lda_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<44>,  Next: Options<43>,  Prev: Testing<134>,  Up: lda_classifier

6.122.4 Features
----------------

   - 'Continuous Datasets': Accepts only datasets whose attributes are
     all declared as continuous.

   - 'Pooled Covariance Model': Learns a shared covariance matrix and
     class-specific means and priors.

   - 'Regularized Estimation': Applies configurable diagonal
     regularization to stabilize covariance inversion.

   - 'Feature Scaling': Supports optional z-score scaling of continuous
     features before fitting the model.

   - 'Score Inspection': Provides discriminant scores for all classes
     using ‘predict_scores/3’.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<43>,  Next: Usage<60>,  Prev: Features<44>,  Up: lda_classifier

6.122.5 Options
---------------

The ‘learn/3’ predicate supports these options:

   - ‘feature_scaling/1’ - whether to standardize continuous attributes
     before training (default: ‘true’)

   - ‘regularization/1’ - positive diagonal value added to the pooled
     covariance matrix before inversion (default: ‘1.0e-6’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<60>,  Next: Classifier representation<5>,  Prev: Options<43>,  Up: lda_classifier

6.122.6 Usage
-------------

* Menu:

* Learning a classifier: Learning a classifier<3>.
* Making predictions: Making predictions<3>.
* Exporting the classifier: Exporting the classifier<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a classifier<3>,  Next: Making predictions<3>,  Up: Usage<60>

6.122.6.1 Learning a classifier
...............................

     | ?- lda_classifier::learn(iris_small, Classifier).

     | ?- lda_classifier::learn(iris_small, Classifier, [regularization(1.0e-5)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Making predictions<3>,  Next: Exporting the classifier<3>,  Prev: Learning a classifier<3>,  Up: Usage<60>

6.122.6.2 Making predictions
............................

     | ?- lda_classifier::learn(iris_small, Classifier),
          lda_classifier::predict(Classifier, [sepal_length-5.1, sepal_width-3.5, petal_length-1.4, petal_width-0.2], Class).

     | ?- lda_classifier::learn(iris_small, Classifier),
          lda_classifier::predict_scores(Classifier, [sepal_length-6.0, sepal_width-2.9, petal_length-4.5, petal_width-1.5], Scores).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the classifier<3>,  Prev: Making predictions<3>,  Up: Usage<60>

6.122.6.3 Exporting the classifier
..................................

     | ?- lda_classifier::learn(iris_small, Classifier),
          lda_classifier::export_to_clauses(iris_small, Classifier, classify, Clauses).

     | ?- lda_classifier::learn(iris_small, Classifier),
          lda_classifier::export_to_file(iris_small, Classifier, classify, 'classifier.pl').


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<5>,  Next: References<31>,  Prev: Usage<60>,  Up: lda_classifier

6.122.7 Classifier representation
---------------------------------

The learned classifier is represented as a compound term with the form:

     lda_classifier(Encoders, Models, Options)

Where:

   - ‘Encoders’: list of continuous feature encoders with learned
     scaling parameters

   - ‘Models’: list of ‘class_model(Class, Prior, Mean, Weights,
     Offset)’ terms

   - ‘Options’: merged training options used to learn the classifier

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<31>,  Prev: Classifier representation<5>,  Up: lda_classifier

6.122.8 References
------------------

  1. Fisher, R.A. (1936).  “The use of multiple measurements in
     taxonomic problems”.

  2. Hastie, T., Tibshirani, R. and Friedman, J. (2009).  “The Elements
     of Statistical Learning”.  Section 4.3.

  3. Bishop, C.M. (2006).  “Pattern Recognition and Machine Learning”.
     Section 4.1.


File: TheLogtalkHandbook-3.100.1.info,  Node: lda_projection,  Next: linda,  Prev: lda_classifier,  Up: Libraries

6.123 ‘lda_projection’
======================

Linear Discriminant Analysis projection for labeled continuous datasets.
Supports continuous attributes only.

The library implements the ‘dimension_reducer_protocol’ defined in the
‘dimension_reduction_protocols’ library and learns discriminant
directions by centering the training data, optionally standardizing
continuous attributes, building regularized within-class and
between-class scatter matrices, whitening the Fisher criterion using a
Cholesky factorization, and extracting discriminant directions using
deterministic power iteration with deflation.

Requires a dataset implementing
‘supervised_dimension_reduction_dataset_protocol’ and therefore uses
class labels during training.

* Menu:

* API documentation: API documentation<141>.
* Loading: Loading<143>.
* Testing: Testing<135>.
* Features: Features<45>.
* Options: Options<44>.
* Usage: Usage<61>.
* Dimension reducer representation: Dimension reducer representation<3>.
* References: References<32>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<141>,  Next: Loading<143>,  Up: lda_projection

6.123.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#lda_projection’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<143>,  Next: Testing<135>,  Prev: API documentation<141>,  Up: lda_projection

6.123.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(lda_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<135>,  Next: Features<45>,  Prev: Loading<143>,  Up: lda_projection

6.123.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(lda_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<45>,  Next: Options<44>,  Prev: Testing<135>,  Up: lda_projection

6.123.4 Features
----------------

   - 'Supervised Continuous Datasets': Accepts labeled datasets
     implementing ‘supervised_dimension_reduction_dataset_protocol’ and
     containing only continuous attributes.

   - 'Centering and Optional Scaling': Centers all attributes and
     optionally standardizes them before estimating class scatter
     matrices.

   - 'Portable Fisher Eigensolver': Uses regularized within-class
     scatter, Cholesky whitening, and deterministic power iteration
     instead of backend-specific linear algebra libraries.

   - 'Projection API': Transforms a new instance into a list of
     ‘component_N-Value’ pairs.

   - 'Model Export': Learned reducers can be exported as predicate
     clauses or written to a file.

   - 'Missing Values': Missing or nonnumeric values are rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<44>,  Next: Usage<61>,  Prev: Features<45>,  Up: lda_projection

6.123.5 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘n_components/1’: Maximum number of discriminant components to
     extract.  Requests that exceed the minimum of the number of
     features and ‘number_of_classes - 1’ raise
     ‘domain_error(component_count, Requested-Maximum)’.  The default is
     ‘2’.

   - ‘feature_scaling/1’: Whether to standardize continuous attributes
     before estimating scatter matrices.  Options: ‘true’ (default) or
     ‘false’.

   - ‘maximum_iterations/1’: Maximum number of power-iteration steps
     used when estimating each discriminant direction.  The default is
     ‘1000’.

   - ‘tolerance/1’: Positive convergence tolerance used both for
     power-iteration stopping and for deciding when additional
     discriminant directions are numerically negligible.  The default is
     ‘1.0e-8’.

   - ‘regularization/1’: Positive diagonal regularization added to the
     within-class scatter matrix before whitening.  The default is
     ‘1.0e-6’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<61>,  Next: Dimension reducer representation<3>,  Prev: Options<44>,  Up: lda_projection

6.123.6 Usage
-------------

The following examples use the sample labeled dataset shipped with the
‘dimension_reduction_protocols’ library:

     | ?- logtalk_load(dimension_reduction_protocols('test_datasets/labeled_measurements')).

* Menu:

* Learning a reducer: Learning a reducer<3>.
* Transforming new instances: Transforming new instances<3>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a reducer<3>,  Next: Transforming new instances<3>,  Up: Usage<61>

6.123.6.1 Learning a reducer
............................

     | ?- lda_projection::learn(labeled_measurements, DimensionReducer).

     | ?- lda_projection::learn(labeled_measurements, DimensionReducer, [n_components(1), feature_scaling(false), maximum_iterations(250), tolerance(1.0e-7), regularization(1.0e-5)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transforming new instances<3>,  Next: Exporting and reusing the reducer<3>,  Prev: Learning a reducer<3>,  Up: Usage<61>

6.123.6.2 Transforming new instances
....................................

     | ?- lda_projection::learn(labeled_measurements, DimensionReducer),
          lda_projection::transform(DimensionReducer, [length-5.1, width-3.5, height-1.4, weight-0.2], ReducedInstance).

     | ?- lda_projection::learn(labeled_measurements, DimensionReducer, [n_components(1)]),
          lda_projection::transform(DimensionReducer, [length-6.2, width-3.4, height-5.4, weight-2.3], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting and reusing the reducer<3>,  Prev: Transforming new instances<3>,  Up: Usage<61>

6.123.6.3 Exporting and reusing the reducer
...........................................

     | ?- lda_projection::learn(labeled_measurements, DimensionReducer, [n_components(1)]),
          lda_projection::export_to_file(labeled_measurements, DimensionReducer, reducer, 'lda_projection_reducer.pl').

     | ?- logtalk_load('lda_projection_reducer.pl'),
          reducer(Reducer),
          lda_projection::transform(Reducer, [length-5.1, width-3.5, height-1.4, weight-0.2], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation<3>,  Next: References<32>,  Prev: Usage<61>,  Up: lda_projection

6.123.7 Dimension reducer representation
----------------------------------------

The learned dimension reducer is represented by a compound term with the
functor chosen by the implementation and arity 4.  For example:

     lda_projection_reducer(Encoders, Components, ClassValues, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Components’: List of learned discriminant vectors in component
     order.

   - ‘ClassValues’: Ordered list of class labels used during training.

   - ‘Diagnostics’: Learned reducer metadata including the effective
     training options and model details.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
reducer term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<32>,  Prev: Dimension reducer representation<3>,  Up: lda_projection

6.123.8 References
------------------

  1. Fisher, R. A. (1936) - “The use of multiple measurements in
     taxonomic problems”.

  2. Rao, C. R. (1948) - “The utilization of multiple measurements in
     problems of biological classification”.


File: TheLogtalkHandbook-3.100.1.info,  Node: linda,  Next: linear_algebra,  Prev: lda_projection,  Up: Libraries

6.124 ‘linda’
=============

Linda is a classic coordination model for process communication.  This
library provides a Linda tuple-space implementation.  Requires both
multi-threading and sockets support.  It supports SWI-Prolog, Trealla
Prolog, and XVM.

The tuple-space is a shared blackboard where processes can:

   - 'Write' tuples using the ‘out/1-2’ predicates

   - 'Read' tuples (without removing) using the ‘rd/1-2’ and
     ‘rd_noblock/1-2’ predicates

   - 'Remove' tuples using the ‘in/1-2’ and ‘in_noblock/1-2’ predicates

The blocking predicates (‘in/1-2’, ‘rd/1-2’) suspend the process until a
matching tuple becomes available.  The non-blocking variants
(‘in_noblock/1-2’, ‘rd_noblock/1-2’) fail immediately if no matching
tuple is found.  There are also additional predicates for list
operations.  Tuples are matched using unification.

* Menu:

* API documentation: API documentation<142>.
* Loading: Loading<144>.
* Testing: Testing<136>.
* Usage: Usage<62>.
* Examples: Examples<173>.
* API Summary::
* Known issues: Known issues<14>.
* See also: See also<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<142>,  Next: Loading<144>,  Up: linda

6.124.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#linda’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<144>,  Next: Testing<136>,  Prev: API documentation<142>,  Up: linda

6.124.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(linda(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<136>,  Next: Usage<62>,  Prev: Loading<144>,  Up: linda

6.124.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(linda(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<62>,  Next: Examples<173>,  Prev: Testing<136>,  Up: linda

6.124.4 Usage
-------------

The main library entities are the ‘linda_server’ and ‘linda_client’
categories.  These categories provide a clean separation between server
and client code.  For backward compatibility with the previous version
of this library, a ‘linda’ object importing both categories is also
provided.  The usage examples that follow use this object.  An object
importing the ‘linda_server’ category must use the ‘threaded/0’
directive.

* Menu:

* Starting a server::
* Connecting a client::
* Tuple operations::
* Disconnecting::
* Timeout control::


File: TheLogtalkHandbook-3.100.1.info,  Node: Starting a server,  Next: Connecting a client,  Up: Usage<62>

6.124.4.1 Starting a server
...........................

To start a Linda server that prints its address:

     | ?- linda::linda.
     % Server started at localhost:54321
     ...

To start a server with a callback when it starts:

     | ?- linda::linda([(Host:Port)-format('Server at ~w:~w~n', [Host, Port])]).

The server runs until all clients disconnect after a shutdown request.


File: TheLogtalkHandbook-3.100.1.info,  Node: Connecting a client,  Next: Tuple operations,  Prev: Starting a server,  Up: Usage<62>

6.124.4.2 Connecting a client
.............................

To connect to a server:

     | ?- linda::linda_client(localhost:54321).


File: TheLogtalkHandbook-3.100.1.info,  Node: Tuple operations,  Next: Disconnecting,  Prev: Connecting a client,  Up: Usage<62>

6.124.4.3 Tuple operations
..........................

Write a tuple:

     | ?- linda::out(message(hello, world)).

Read a tuple (blocking):

     | ?- linda::rd(message(X, Y)).
     X = hello,
     Y = world

Remove a tuple (blocking):

     | ?- linda::in(message(X, Y)).
     X = hello,
     Y = world

Non-blocking operations:

     | ?- linda::rd_noblock(message(X, Y)).
     no   % if no matching tuple exists

     | ?- linda::in_noblock(message(X, Y)).
     no   % if no matching tuple exists

Wait for one of several tuples:

     | ?- linda::in([task(1, X), task(2, X), done], Tuple).

Alternative syntax using ‘in_list/2’:

     | ?- linda::in_list([task(1, X), task(2, X), done], Tuple).

Similarly for reading:

     | ?- linda::rd_list([status(ready), status(waiting)], Status).

Collect all matching tuples atomically (read without removing):

     | ?- linda::findall_rd_noblock(N, counter(N), Counters).

Collect and remove all matching tuples atomically:

     | ?- linda::findall_in_noblock(X, item(X), Items).


File: TheLogtalkHandbook-3.100.1.info,  Node: Disconnecting,  Next: Timeout control,  Prev: Tuple operations,  Up: Usage<62>

6.124.4.4 Disconnecting
.......................

Close the client connection:

     | ?- linda::close_client.

Request server shutdown (server stops accepting new connections):

     | ?- linda::shutdown_server, linda::close_client.


File: TheLogtalkHandbook-3.100.1.info,  Node: Timeout control,  Prev: Disconnecting,  Up: Usage<62>

6.124.4.5 Timeout control
.........................

Set a timeout for blocking operations:

     | ?- linda::linda_timeout(Old, 5:0).  % 5 seconds timeout

Disable timeout (wait forever):

     | ?- linda::linda_timeout(_, off).


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<173>,  Next: API Summary,  Prev: Usage<62>,  Up: linda

6.124.5 Examples
----------------

* Menu:

* Producer-Consumer::
* Critical Region::
* Synchronization::


File: TheLogtalkHandbook-3.100.1.info,  Node: Producer-Consumer,  Next: Critical Region,  Up: Examples<173>

6.124.5.1 Producer-Consumer
...........................

Producer (client 1):

     producer :-
         produce(X),
         linda::out(item(X)),
         producer.

Consumer (client 2):

     consumer :-
         linda::in(item(X)),
         consume(X),
         consumer.


File: TheLogtalkHandbook-3.100.1.info,  Node: Critical Region,  Next: Synchronization,  Prev: Producer-Consumer,  Up: Examples<173>

6.124.5.2 Critical Region
.........................

     critical_section :-
         linda::in(mutex),  % acquire lock
         do_critical_work,
         linda::out(mutex). % release lock

Initialize the mutex:

     | ?- linda::out(mutex).


File: TheLogtalkHandbook-3.100.1.info,  Node: Synchronization,  Prev: Critical Region,  Up: Examples<173>

6.124.5.3 Synchronization
.........................

Wait for a signal:

     | ?- linda::in(ready).  % blocks until someone does out(ready)

Send a signal:

     | ?- linda::out(ready).


File: TheLogtalkHandbook-3.100.1.info,  Node: API Summary,  Next: Known issues<14>,  Prev: Examples<173>,  Up: linda

6.124.6 API Summary
-------------------

* Menu:

* Server predicates::
* Client predicates::
* Tuple predicates (single/default server): Tuple predicates single/default server.
* Tuple predicates (multiple servers): Tuple predicates multiple servers.


File: TheLogtalkHandbook-3.100.1.info,  Node: Server predicates,  Next: Client predicates,  Up: API Summary

6.124.6.1 Server predicates
...........................

   - ‘linda’ - Start server on automatic port

   - ‘linda(Options)’ - Start server with options


File: TheLogtalkHandbook-3.100.1.info,  Node: Client predicates,  Next: Tuple predicates single/default server,  Prev: Server predicates,  Up: API Summary

6.124.6.2 Client predicates
...........................

   - ‘linda_client(Address)’ - Connect to server at ‘Host:Port’

   - ‘close_client’ - Close connection

   - ‘shutdown_server’ - Request server shutdown

   - ‘linda_timeout(Old, New)’ - Get/set timeout


File: TheLogtalkHandbook-3.100.1.info,  Node: Tuple predicates single/default server,  Next: Tuple predicates multiple servers,  Prev: Client predicates,  Up: API Summary

6.124.6.3 Tuple predicates (single/default server)
..................................................

   - ‘out(Tuple)’ - Add tuple to space

   - ‘in(Tuple)’ - Remove matching tuple (blocking)

   - ‘in_noblock(Tuple)’ - Remove matching tuple (non-blocking)

   - ‘in(TupleList, Tuple)’ - Remove one of several tuples (blocking)

   - ‘in_list(TupleList, Tuple)’ - Remove one of several tuples
     (blocking)

   - ‘rd(Tuple)’ - Read matching tuple (blocking)

   - ‘rd_noblock(Tuple)’ - Read matching tuple (non-blocking)

   - ‘rd(TupleList, Tuple)’ - Read one of several tuples (blocking)

   - ‘rd_list(TupleList, Tuple)’ - Read one of several tuples (blocking)

   - ‘findall_rd_noblock(Template, Tuple, List)’ - Collect all matching
     tuples (atomic read)

   - ‘findall_in_noblock(Template, Tuple, List)’ - Collect and remove
     all matching tuples (atomic remove)


File: TheLogtalkHandbook-3.100.1.info,  Node: Tuple predicates multiple servers,  Prev: Tuple predicates single/default server,  Up: API Summary

6.124.6.4 Tuple predicates (multiple servers)
.............................................

Variants of the predicates above with an additional first argument for
the server address or the server alias (an atom; default is
‘blackboard’).


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<14>,  Next: See also<2>,  Prev: API Summary,  Up: linda

6.124.7 Known issues
--------------------

Recent versions of macOS seem to disable the mapping of ‘localhost’ to
‘127.0.0.1’.  This issue may prevent some functionality from working.
This can be fixed either by editing the ‘/etc/hosts’ file or by using
‘'127.0.0.1'’ as the host argument instead of ‘localhost’.


File: TheLogtalkHandbook-3.100.1.info,  Node: See also<2>,  Prev: Known issues<14>,  Up: linda

6.124.8 See also
----------------

   - SICStus Prolog Linda documentation:
     ‘https://sicstus.sics.se/sicstus/docs/latest4/html/sicstus.html/lib_002dlinda.html’

   - Original Linda papers:

        - Carreiro, N. & Gelernter, D. (1989).  Linda in Context.

        - Carreiro, N. & Gelernter, D. (1989).  How to Write Parallel
          Programs: A Guide to the Perplexed.


File: TheLogtalkHandbook-3.100.1.info,  Node: linear_algebra,  Next: linear_regression,  Prev: linda,  Up: Libraries

6.125 ‘linear_algebra’
======================

This library provides predicates for numeric vectors and matrices,
including vector construction and scaling, general vector norms, matrix
construction and transformation, matrix-matrix products, row Gram
matrices and Gram-centering helpers, offset diagonal helpers,
triangular-part extraction, diagonal shifts, lower- and upper-triangular
matrix solves, direct row and column lookup, tolerance-aware vector
normalization and sign stabilization, generic dense square-system
solves, determinants, matrix inversion, thin QR decomposition, QR-backed
least-squares solving, tolerance-aware rank estimation, real symmetric
eigendecomposition, pseudo-inverse and null-space helpers, covariance
helpers, and Cholesky-based linear solves.

Vectors are represented as lists of numbers.  Matrices are represented
as lists of row lists, where each row is a numeric vector.

Predicates that index into vectors or matrices use one-based indices.
Matrix access predicates use one-based row and column indices.

Square-system predicates include ‘solve_linear_system/3’,
‘solve_linear_systems/3’, ‘determinant/2’, and ‘inverse_matrix/2’.
Rectangular-system predicates include ‘qr_decomposition/3’ and
‘least_squares/3’, ‘pseudo_inverse/2-3’, and ‘null_space/2-3’.
Row-matrix structural predicates include ‘gram_matrix/2’,
‘matrix_row_means/2’, ‘matrix_column_means/2’, ‘center_gram_matrix/4’,
and ‘center_gram_vector/4’.  Diagonal and triangular helpers include
‘matrix_diagonal/2-3’, ‘diagonal_matrix/2-4’,
‘upper_triangular_part/2-3’, and ‘lower_triangular_part/2-3’.  Norm
helpers include ‘vector_norm/3’ and ‘frobenius_norm/2’.  Real symmetric
spectral predicates include ‘symmetric_eigen/3-5’.  Tolerance-sensitive
numerical predicates include ‘normalize_vector/2-3’,
‘first_significant_component/2-3’, ‘stabilize_vector_sign/2-3’,
‘matrix_rank/2-3’, ‘symmetric_eigen/3-5’, ‘pseudo_inverse/2-3’, and
‘null_space/2-3’.

The ‘symmetric_eigen/5’ predicate can be used when callers need to
control the power-iteration budget explicitly instead of relying on the
default iteration bound.

* Menu:

* API documentation: API documentation<143>.
* Loading: Loading<145>.
* Testing: Testing<137>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<143>,  Next: Loading<145>,  Up: linear_algebra

6.125.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#linear_algebra’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<145>,  Next: Testing<137>,  Prev: API documentation<143>,  Up: linear_algebra

6.125.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(linear_algebra(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<137>,  Prev: Loading<145>,  Up: linear_algebra

6.125.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(linear_algebra(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: linear_regression,  Next: linear_svm_classifier,  Prev: linear_algebra,  Up: Libraries

6.126 ‘linear_regression’
=========================

Linear regression regressor supporting continuous and mixed-feature
datasets.  The library implements the ‘regressor_protocol’ defined in
the ‘regression_protocols’ library and learns a linear model using the
shared regression encoding core to build a row-oriented design matrix
with an explicit intercept column before delegating least-squares
solving and rank estimation to the ‘linear_algebra’ library.  The
intercept is always retained and encoded feature columns that are
numerically dependent on the design matrix are assigned zero
coefficients.

* Menu:

* API documentation: API documentation<144>.
* Loading: Loading<146>.
* Testing: Testing<138>.
* Features: Features<46>.
* Regressor representation: Regressor representation<7>.
* Diagnostics syntax: Diagnostics syntax<15>.
* Options: Options<45>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<144>,  Next: Loading<146>,  Up: linear_regression

6.126.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#linear_regression’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<146>,  Next: Testing<138>,  Prev: API documentation<144>,  Up: linear_regression

6.126.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(linear_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<138>,  Next: Features<46>,  Prev: Loading<146>,  Up: linear_regression

6.126.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(linear_regression(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(linear_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<46>,  Next: Regressor representation<7>,  Prev: Testing<138>,  Up: linear_regression

6.126.4 Features
----------------

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes.  -'Categorical Attributes Encoding': Uses
     reference-level dummy coding from the declared dataset attribute
     values.  Encoded columns with no independent signal after
     accounting for the intercept and previously selected features are
     assigned zero coefficients.

   - 'Feature Scaling': Continuous attributes can be standardized using
     z-score scaling.

   - 'Missing Values': Missing numeric and categorical values
     represented using anonymous variables are encoded using explicit
     missing-value indicator features.

   - 'Unknown Values': Prediction requests containing categorical values
     that are not declared by the dataset raise a domain error.

   - 'Rank Handling': Encoded columns that are numerically dependent on
     the intercept or on earlier selected columns are dropped from the
     direct solve and assigned zero coefficients.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, solver name, residual sum of
     squares, effective rank, active feature count, encoded feature
     count, and effective options, accessible using the shared
     regression diagnostics predicates.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for representative
     regression datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<7>,  Next: Diagnostics syntax<15>,  Prev: Features<46>,  Up: linear_regression

6.126.5 Regressor representation
--------------------------------

The learned regressor is represented by default as:

   - ‘linear_regressor(Encoders, Bias, Weights, Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(Encoders, Bias, Weights, Diagnostics)’

In this representation, ‘Encoders’ stores the feature encoding metadata,
‘Bias’ stores the intercept, ‘Weights’ stores one coefficient per
encoded feature, and ‘Diagnostics’ stores training metadata including
the effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<15>,  Next: Options<45>,  Prev: Regressor representation<7>,  Up: linear_regression

6.126.6 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(linear_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         solver(Solver),
         residual_sum_of_squares(ResidualSumOfSquares),
         effective_rank(EffectiveRank),
         active_feature_count(ActiveFeatureCount),
         encoded_feature_count(FeatureCount)
     ]

Where:

   - ‘model(linear_regression)’ identifies the learning algorithm that
     produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘solver(Solver)’ records the direct least-squares solver family
     used for the fit.  The current value is
     ‘modified_gram_schmidt_column_pivoting’, which is now reported by
     the shared regression core while delegating the actual solve to the
     ‘linear_algebra’ library.

   - ‘residual_sum_of_squares(ResidualSumOfSquares)’ stores the training
     residual sum of squares for the fitted regressor.

   - ‘effective_rank(EffectiveRank)’ stores the rank of the fitted
     row-oriented design matrix, including the intercept column.

   - ‘active_feature_count(ActiveFeatureCount)’ stores the number of
     encoded feature columns retained after subtracting the intercept
     contribution from the fitted design-matrix rank.

   - ‘encoded_feature_count(FeatureCount)’ stores the number of numeric
     features induced by the encoder list, including missing-value
     indicator features.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<45>,  Prev: Diagnostics syntax<15>,  Up: linear_regression

6.126.7 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes before training and prediction.  Accepted values are
     ‘true’ and ‘false’.  The default is ‘true’.


File: TheLogtalkHandbook-3.100.1.info,  Node: linear_svm_classifier,  Next: listing,  Prev: linear_regression,  Up: Libraries

6.127 ‘linear_svm_classifier’
=============================

Linear support vector machine classifier supporting both binary and
multiclass classification.  Multiclass classification is implemented
using a one-vs-rest scheme with one linear margin model per class, and
training uses batch subgradient descent to fit each hinge-loss model.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset object, using it to make predictions, and
exporting the learned model as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  Existing datasets
in ‘classification_protocols/test_datasets’ can be used for binary,
multiclass, continuous, categorical, and mixed-feature testing.

* Menu:

* API documentation: API documentation<145>.
* Loading: Loading<147>.
* Testing: Testing<139>.
* Features: Features<47>.
* Options: Options<46>.
* Usage: Usage<63>.
* Classifier representation: Classifier representation<6>.
* References: References<33>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<145>,  Next: Loading<147>,  Up: linear_svm_classifier

6.127.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#linear_svm_classifier’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<147>,  Next: Testing<139>,  Prev: API documentation<145>,  Up: linear_svm_classifier

6.127.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(linear_svm_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<139>,  Next: Features<47>,  Prev: Loading<147>,  Up: linear_svm_classifier

6.127.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(linear_svm_classifier(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(linear_svm_classifier(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<47>,  Next: Options<46>,  Prev: Testing<139>,  Up: linear_svm_classifier

6.127.4 Features
----------------

   - 'Binary and Multiclass Classification': Learns one-vs-rest linear
     margin models and predicts the class with the highest score.

   - 'Continuous Features': Standardizes numeric attributes using
     z-score scaling derived from the training data.

   - 'Categorical Features': Expands discrete attributes using one-hot
     encoding based on the declared dataset attribute values and rejects
     unseen values with a domain error.

   - 'Missing Values': Encodes missing numeric and categorical values
     represented using anonymous variables using explicit missing-value
     indicator features.

   - 'Unknown values': Prediction requests containing categorical values
     that are not declared by the dataset raise a domain error.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses or written to a file.

   - 'Pretty Printing': Prints a compact summary of classes, encoders,
     and learned weight vector sizes.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     covering the ‘weather’, ‘mixed’, ‘iris_small’, ‘missing_mixed’, and
     ‘breast_cancer’ datasets with reported training time and training
     accuracy.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<46>,  Next: Usage<63>,  Prev: Features<47>,  Up: linear_svm_classifier

6.127.5 Options
---------------

The ‘learn/3’ predicate supports these options:

   - ‘learning_rate/1’ - base gradient descent learning rate (default:
     ‘0.1’)

   - ‘maximum_iterations/1’ - maximum number of optimization iterations
     (default: ‘1000’)

   - ‘tolerance/1’ - convergence threshold for the maximum parameter
     update (default: ‘1.0e-6’)

   - ‘l2_regularization/1’ - L2 penalty factor applied to weights
     (default: ‘0.01’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<63>,  Next: Classifier representation<6>,  Prev: Options<46>,  Up: linear_svm_classifier

6.127.6 Usage
-------------

* Menu:

* Learning a classifier: Learning a classifier<4>.
* Making predictions: Making predictions<4>.
* Exporting the classifier: Exporting the classifier<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a classifier<4>,  Next: Making predictions<4>,  Up: Usage<63>

6.127.6.1 Learning a classifier
...............................

     | ?- linear_svm_classifier::learn(weather, Classifier).

     | ?- linear_svm_classifier::learn(iris_small, Classifier, [learning_rate(0.05), maximum_iterations(1500)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Making predictions<4>,  Next: Exporting the classifier<4>,  Prev: Learning a classifier<4>,  Up: Usage<63>

6.127.6.2 Making predictions
............................

     | ?- linear_svm_classifier::learn(mixed, Classifier),
          linear_svm_classifier::predict(Classifier, [age-45, income-75000, student-no, credit_rating-fair], Class).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the classifier<4>,  Prev: Making predictions<4>,  Up: Usage<63>

6.127.6.3 Exporting the classifier
..................................

     | ?- linear_svm_classifier::learn(weather, Classifier),
          linear_svm_classifier::export_to_clauses(weather, Classifier, classify, Clauses).

     | ?- linear_svm_classifier::learn(weather, Classifier),
          linear_svm_classifier::export_to_file(weather, Classifier, classify, 'classifier.pl').


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<6>,  Next: References<33>,  Prev: Usage<63>,  Up: linear_svm_classifier

6.127.7 Classifier representation
---------------------------------

The learned classifier is represented as a compound term with the form:

     linear_svm_classifier(Classes, Encoders, Models, Options)

Where:

   - ‘Classes’: list of class labels

   - ‘Encoders’: list of continuous scaling descriptors and categorical
     value lists

   - ‘Models’: list of ‘class_model(Class, Bias, Weights)’ terms

   - ‘Options’: merged training options used to learn the model

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<33>,  Prev: Classifier representation<6>,  Up: linear_svm_classifier

6.127.8 References
------------------

  1. Cortes, C. and Vapnik, V. (1995).  “Support-Vector Networks”.

  2. Bishop, C.M. (2006).  “Pattern Recognition and Machine Learning”.
     Section 7.1.

  3. Hastie, T., Tibshirani, R. and Friedman, J. (2009).  “The Elements
     of Statistical Learning”.  Section 12.3.


File: TheLogtalkHandbook-3.100.1.info,  Node: listing,  Next: lof_anomaly_detector,  Prev: linear_svm_classifier,  Up: Libraries

6.128 ‘listing’
===============

This library provides support for listing object dynamic predicate
clauses.  The predicates must (also) be declared using a scope directive
to make them visible to the listing predicates.

* Menu:

* API documentation: API documentation<146>.
* Loading: Loading<148>.
* Testing: Testing<140>.
* Usage: Usage<64>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<146>,  Next: Loading<148>,  Up: listing

6.128.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#listing’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<148>,  Next: Testing<140>,  Prev: API documentation<146>,  Up: listing

6.128.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(listing(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<140>,  Next: Usage<64>,  Prev: Loading<148>,  Up: listing

6.128.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(listing(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<64>,  Prev: Testing<140>,  Up: listing

6.128.4 Usage
-------------

This library provides a ‘listing’ category that can be imported by any
number of objects.  The main predicates are declared public.  If you
want to restrict their scope, use protected or private import.  For
example:

     :- object(data_store,
         imports(private::listing)).

         debug :-
             ^^listing(data/4).
         ...

     :- end_object.

The ‘listing’ category provides a bare-bones ‘portray_clause/1’
predicate implementation.  As this predicate is called (by the
‘listing/0-1’ predicates) using the ‘(::)/1’ control construct, the
object importing the category can easily override the inherited
definition with its own or with a call to the backend system native
implementation of the predicate.  For example, assuming a backend that
provides ‘portray_clause/1’ as a built-in predicate, we can write:

     :- object(thing,
         imports(listing)).

         :- uses(user, [portray_clause/1]).
         ...

     :- end_object.

The main predicate, ‘listing/1’, accepts as argument a predicate
indicator, a non-terminal indicator, or a clause head template (to list
only clauses with a matching head).

This library is often useful as a debugging helper.  For example,
assuming that we want to list dynamic predicate clauses for an object
‘data’ compiled (or created) with the ‘complements’ flag set to ‘allow’,
we can hot patch it to add the ‘listing’ category:

     | ?- create_category(patch, [extends(listing),complements(data)], [], []).
     yes

     | ?- data::listing.
     ...

Another example:

     | ?- create_category(
              patch,
              [extends(listing),complements(data)],
              [public(debug/1)],
              [(debug(Key) :- ::listing(p(Key,Datum)))]
          ).
     yes

     | ?- data::debug(k42).
     ...

Note that the semantics of complementing categories require that we use
the ‘(::)/2’ control construct instead of the ‘(^^)/2’ control construct
as a 'super' call would be interpreted as made from the complemented
object.


File: TheLogtalkHandbook-3.100.1.info,  Node: lof_anomaly_detector,  Next: logging,  Prev: listing,  Up: Libraries

6.129 ‘lof_anomaly_detector’
============================

Local Outlier Factor anomaly detector supporting multiple distance
metrics, mixed continuous and categorical features, and missing values.
The detector memorizes the training instances and computes Local Outlier
Factor values by comparing the local reachability density of a query to
the densities of its neighbors.

The library implements the ‘anomaly_detector_protocol’ defined in the
‘anomaly_detection_protocols’ library.  It learns a compact detector
from a dataset by selecting baseline training examples from the declared
class labels, computes normalized anomaly scores for new instances,
predicts ‘normal’ or ‘anomaly’, and exports learned detectors as clauses
or files.

Datasets are represented as objects implementing the
‘anomaly_dataset_protocol’ protocol from the
‘anomaly_detection_protocols’ library.  See the
‘anomaly_detection_protocols/test_datasets’ directory for examples.

* Menu:

* API documentation: API documentation<147>.
* Loading: Loading<149>.
* Testing: Testing<141>.
* Features: Features<48>.
* Options: Options<47>.
* Detector representation: Detector representation<6>.
* References: References<34>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<147>,  Next: Loading<149>,  Up: lof_anomaly_detector

6.129.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#lof_anomaly_detector’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<149>,  Next: Testing<141>,  Prev: API documentation<147>,  Up: lof_anomaly_detector

6.129.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(lof_anomaly_detector(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<141>,  Next: Features<48>,  Prev: Loading<149>,  Up: lof_anomaly_detector

6.129.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(lof_anomaly_detector(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<48>,  Next: Options<47>,  Prev: Testing<141>,  Up: lof_anomaly_detector

6.129.4 Features
----------------

   - 'Density-based anomaly scoring': computes Local Outlier Factor
     scores from local reachability densities.

   - 'Normalized scores': Raw LOF values are normalized to the interval
     ‘[0.0, 1.0]’ by mapping the ideal baseline value ‘1.0’ to ‘0.0’ and
     scaling larger values against the largest training raw score.

   - 'Mixed features': automatically handles continuous and categorical
     features declared by the dataset.

   - 'Missing values': ignores missing dimensions while normalizing
     distances (distances are normalized by the number of comparable
     dimensions).

   - 'Baseline training selection': ‘baseline_class_values/1’ declares
     which class labels are admissible for fitting the detector, while
     ‘baseline_selection_policy/1’ controls whether non-baseline
     examples are rejected (default) or filtered before training.

   - 'Multiple metrics': supports Euclidean, Manhattan, Chebyshev, and
     Minkowski distance metrics.

   - 'Detector export': learned detectors can be exported as predicate
     clauses.

   - 'Dataset validation': learning rejects empty datasets with a
     ‘domain_error(non_empty_dataset, Dataset)’ exception.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<47>,  Next: Detector representation<6>,  Prev: Features<48>,  Up: lof_anomaly_detector

6.129.5 Options
---------------

The following options can be passed to the ‘learn/3’ and ‘predict/4’
predicates:

   - ‘k(K)’: Number of neighbors to consider (default: 5)

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default), ‘manhattan’, ‘chebyshev’, ‘minkowski’

   - ‘anomaly_threshold(Threshold)’: Threshold for ‘predict/3-4’
     (default: ‘0.4’)

   - ‘baseline_class_values(Classes)’: Learn-time list of admissible
     baseline class labels (default: ‘[normal]’)

   - ‘baseline_selection_policy(Policy)’: Learn-time handling of
     non-baseline examples.  Supported values are ‘reject’ (default) and
     ‘filter’


File: TheLogtalkHandbook-3.100.1.info,  Node: Detector representation<6>,  Next: References<34>,  Prev: Options<47>,  Up: lof_anomaly_detector

6.129.6 Detector representation
-------------------------------

The learned detector is represented by default as:

     lof_detector(TrainingDataset, AttributeNames, FeatureTypes, AttributeScales, Instances, ReferenceScores, Diagnostics)

Where:

   - ‘AttributeNames’: List of attribute names in order

   - ‘FeatureTypes’: List of feature types (‘numeric’ or ‘categorical’)

   - ‘AttributeScales’: Normalization scales for numeric features

   - ‘Instances’: List of retained baseline training ‘Id-Class-Values’
     triples

   - ‘ReferenceScores’: Cached leave-one-out raw training scores for the
     retained baseline training instances

   - ‘Diagnostics’: Learned metadata terms including ‘model/1’,
     ‘training_dataset/1’, ‘attribute_names/1’, ‘feature_types/1’,
     ‘example_count/1’, ‘reference_score_count/1’, and ‘options/1’

The ‘score/3’ predicate always treats its input as a fresh query.  Only
‘score_all/3’ on the original training dataset with the ‘reject’
baseline selection policy reuses the cached leave-one-out
‘ReferenceScores’ for all examples.  With the ‘filter’ policy, retained
baseline training examples reuse the cached leave-one-out scores while
excluded examples are scored as fresh queries against the learned
baseline detector.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
detector term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<34>,  Prev: Detector representation<6>,  Up: lof_anomaly_detector

6.129.7 References
------------------

  1. Breunig, M. M., Kriegel, H.-P., Ng, R. T., and Sander, J. (2000).
     “LOF: Identifying density-based local outliers”.  SIGMOD.


File: TheLogtalkHandbook-3.100.1.info,  Node: logging,  Next: logistic_regression_classifier,  Prev: lof_anomaly_detector,  Up: Libraries

6.130 ‘logging’
===============

This library provides support for logging events to files.

* Menu:

* API documentation: API documentation<148>.
* Loading: Loading<150>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<148>,  Next: Loading<150>,  Up: logging

6.130.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#logging’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<150>,  Prev: API documentation<148>,  Up: logging

6.130.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(logging(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: logistic_regression_classifier,  Next: loops,  Prev: logging,  Up: Libraries

6.131 ‘logistic_regression_classifier’
======================================

Logistic regression classifier supporting both binary and multiclass
classification.  Multiclass classification is implemented using batch
gradient descent to train a single multiclass softmax model.  Binary
classification is treated as a two-class special case of the same
objective.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset object, using it to make predictions,
returning class probabilities, and exporting the learned model as a list
of predicate clauses or to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  Existing datasets
in ‘classification_protocols/test_datasets’ can be used for binary,
multiclass, continuous, categorical, and mixed-feature testing.

* Menu:

* API documentation: API documentation<149>.
* Loading: Loading<151>.
* Testing: Testing<142>.
* Features: Features<49>.
* Options: Options<48>.
* Usage: Usage<65>.
* Classifier representation: Classifier representation<7>.
* References: References<35>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<149>,  Next: Loading<151>,  Up: logistic_regression_classifier

6.131.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#logistic_regression_classifier’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<151>,  Next: Testing<142>,  Prev: API documentation<149>,  Up: logistic_regression_classifier

6.131.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(logistic_regression_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<142>,  Next: Features<49>,  Prev: Loading<151>,  Up: logistic_regression_classifier

6.131.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(logistic_regression_classifier(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(logistic_regression_classifier(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<49>,  Next: Options<48>,  Prev: Testing<142>,  Up: logistic_regression_classifier

6.131.4 Features
----------------

   - 'Binary and Multiclass Classification': Learns a joint softmax
     logistic model with one parameter vector per class.

   - 'Continuous Features': Standardizes numeric attributes using
     z-score scaling derived from the training data.

   - 'Categorical Features': Expands discrete attributes using one-hot
     encoding based on the declared dataset attribute values and rejects
     unseen values with a domain error.

   - 'Missing Values': Encodes missing numeric and categorical values
     represented using anonymous variables using explicit missing-value
     indicator features instead of being conflated with baseline feature
     values.

   - 'Unknown values': Prediction requests containing categorical values
     that are not declared by the dataset raise a domain error instead
     of being silently mapped into an existing feature bucket.

   - 'Probability Estimation': Provides class probability distributions
     in addition to class predictions.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     covering the ‘weather’, ‘mixed’, ‘iris_small’, ‘missing_mixed’, and
     ‘breast_cancer’ datasets with reported training time, training
     accuracy, and mean log loss.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<48>,  Next: Usage<65>,  Prev: Features<49>,  Up: logistic_regression_classifier

6.131.5 Options
---------------

The ‘learn/3’ predicate supports these options:

   - ‘learning_rate/1’ - gradient descent learning rate (default: ‘0.1’)

   - ‘maximum_iterations/1’ - maximum number of optimization iterations
     (default: ‘1000’)

   - ‘tolerance/1’ - convergence threshold for the maximum parameter
     update (default: ‘1.0e-6’)

   - ‘l2_regularization/1’ - L2 penalty factor applied to weights
     (default: ‘0.0’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<65>,  Next: Classifier representation<7>,  Prev: Options<48>,  Up: logistic_regression_classifier

6.131.6 Usage
-------------

* Menu:

* Learning a classifier: Learning a classifier<5>.
* Making predictions: Making predictions<5>.
* Exporting the classifier: Exporting the classifier<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a classifier<5>,  Next: Making predictions<5>,  Up: Usage<65>

6.131.6.1 Learning a classifier
...............................

     | ?- logistic_regression_classifier::learn(weather, Classifier).

     | ?- logistic_regression_classifier::learn(iris_small, Classifier, [learning_rate(0.05), maximum_iterations(1500)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Making predictions<5>,  Next: Exporting the classifier<5>,  Prev: Learning a classifier<5>,  Up: Usage<65>

6.131.6.2 Making predictions
............................

     | ?- logistic_regression_classifier::learn(mixed, Classifier),
          logistic_regression_classifier::predict(Classifier, [age-45, income-75000, student-no, credit_rating-fair], Class).

     | ?- logistic_regression_classifier::learn(iris_small, Classifier),
          logistic_regression_classifier::predict_probabilities(Classifier, [sepal_length-6.4, sepal_width-3.0, petal_length-5.8, petal_width-2.2], Probabilities).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the classifier<5>,  Prev: Making predictions<5>,  Up: Usage<65>

6.131.6.3 Exporting the classifier
..................................

     | ?- logistic_regression_classifier::learn(weather, Classifier),
          logistic_regression_classifier::export_to_clauses(weather, Classifier, classify, Clauses).

     | ?- logistic_regression_classifier::learn(weather, Classifier),
          logistic_regression_classifier::export_to_file(weather, Classifier, classify, 'classifier.pl').


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<7>,  Next: References<35>,  Prev: Usage<65>,  Up: logistic_regression_classifier

6.131.7 Classifier representation
---------------------------------

The learned classifier is represented as a compound term with the form:

     lr_classifier(Classes, Encoders, Models, Options)

Where:

   - ‘Classes’: list of class labels

   - ‘Encoders’: list of continuous scaling descriptors and categorical
     value lists

   - ‘Models’: list of ‘class_model(Class, Bias, Weights)’ terms

   - ‘Options’: merged training options used to learn the model

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<35>,  Prev: Classifier representation<7>,  Up: logistic_regression_classifier

6.131.8 References
------------------

  1. Hosmer, D.W., Lemeshow, S. and Sturdivant, R.X. (2013).  “Applied
     Logistic Regression”.

  2. Bishop, C.M. (2006).  “Pattern Recognition and Machine Learning”.
     Chapter 4.

  3. Hastie, T., Tibshirani, R. and Friedman, J. (2009).  “The Elements
     of Statistical Learning”.  Chapter 4.


File: TheLogtalkHandbook-3.100.1.info,  Node: loops,  Next: massey_ranker,  Prev: logistic_regression_classifier,  Up: Libraries

6.132 ‘loops’
=============

This library provides implementations of several kinds of loops typical
of imperative languages.

* Menu:

* API documentation: API documentation<150>.
* Loading: Loading<152>.
* Testing: Testing<143>.
* Usage: Usage<66>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<150>,  Next: Loading<152>,  Up: loops

6.132.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#loops’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<152>,  Next: Testing<143>,  Prev: API documentation<150>,  Up: loops

6.132.2 Loading
---------------

To load the main entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(loops(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<143>,  Next: Usage<66>,  Prev: Loading<152>,  Up: loops

6.132.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(loops(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<66>,  Prev: Testing<143>,  Up: loops

6.132.4 Usage
-------------

See e.g.  the ‘searching’ example.


File: TheLogtalkHandbook-3.100.1.info,  Node: massey_ranker,  Next: mcp_server,  Prev: loops,  Up: Libraries

6.133 ‘massey_ranker’
=====================

Massey pairwise preference ranker.  It builds the Massey coefficient
matrix with diagonal entries ‘games_i’, off-diagonal entries
‘-games_ij’, and a final ‘sum(ratings)=0’ anchoring row, then solves the
linear system using deterministic Gaussian elimination with partial
pivoting and residual validation.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The current implementation requires a well-formed connected
pairwise dataset so that learned rankings remain globally comparable
across all ranked items.

* Menu:

* API documentation: API documentation<151>.
* Loading: Loading<153>.
* Testing: Testing<144>.
* Features: Features<50>.
* Scoring semantics: Scoring semantics<6>.
* Usage: Usage<67>.
* Diagnostics syntax: Diagnostics syntax<16>.
* Ranker representation: Ranker representation<10>.
* References: References<36>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<151>,  Next: Loading<153>,  Up: massey_ranker

6.133.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#massey_ranker’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<153>,  Next: Testing<144>,  Prev: API documentation<151>,  Up: massey_ranker

6.133.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(massey_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<144>,  Next: Features<50>,  Prev: Loading<153>,  Up: massey_ranker

6.133.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(massey_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<50>,  Next: Scoring semantics<6>,  Prev: Testing<144>,  Up: massey_ranker

6.133.4 Features
----------------

   - 'Pairwise Preference Learning': Learns one deterministic rating per
     item from aggregated pairwise outcomes.

   - 'Massey Matrix Fidelity': Solves the standard Massey linear system
     with diagonal entries ‘games_i’, off-diagonal entries ‘-games_ij’,
     and a final anchoring row enforcing ‘sum(ratings) = 0’.

   - 'Numerically Hardened Solver': Uses Gaussian elimination with
     partial pivoting plus residual checks before accepting the learned
     ratings.

   - 'Zero-Sum Ratings': Produces ratings centered at ‘0.0’, where
     positive values indicate above-average aggregate performance and
     negative values indicate below-average aggregate performance.

   - 'Deterministic Ranking': Orders candidate items by learned rating
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     comparison graphs.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Ranking Infrastructure': Reuses the ‘ranking_protocols’
     helpers for dataset validation, diagnostics, export, and candidate
     ranking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoring semantics<6>,  Next: Usage<67>,  Prev: Features<50>,  Up: massey_ranker

6.133.5 Scoring semantics
-------------------------

This implementation aggregates pairwise preferences into matchup totals
and then solves the Massey system

     M r = p

where ‘M_ii = games_i’, ‘M_ij = -games_ij’ for ‘i \= j’, and the final
row of ‘M’ is replaced with ones so that the learned ratings satisfy
‘sum(ratings) = 0’.  The right-hand-side vector ‘p’ is the per-item
signed point-differential total ‘wins_i - losses_i’.

The linear system is solved using deterministic Gaussian elimination
with partial pivoting.  The implementation also verifies that the
recovered solution has a small residual and only clamps negligible
floating-point noise around ‘0.0’.

The resulting ratings are relative rather than probabilistic: only their
differences and ordering matter.  Larger positive values indicate
stronger aggregate pairwise performance against the field.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<67>,  Next: Diagnostics syntax<16>,  Prev: Scoring semantics<6>,  Up: massey_ranker

6.133.6 Usage
-------------

* Menu:

* Learning a ranker: Learning a ranker<10>.
* Inspecting diagnostics: Inspecting diagnostics<8>.
* Ranking candidate items: Ranking candidate items<9>.
* Exporting the ranker: Exporting the ranker<8>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<10>,  Next: Inspecting diagnostics<8>,  Up: Usage<67>

6.133.6.1 Learning a ranker
...........................

     % Learn from a pairwise ranking dataset object
     | ?- massey_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with an explicit empty options list
     | ?- massey_ranker::learn(my_dataset, Ranker, []).
     ...

The current implementation accepts only the empty options list ‘[]’.
Any non-empty options list is rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<8>,  Next: Ranking candidate items<9>,  Prev: Learning a ranker<10>,  Up: Usage<67>

6.133.6.2 Inspecting diagnostics
................................

     % Inspect model and dataset summary metadata
     | ?- massey_ranker::learn(my_dataset, Ranker),
          massey_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<9>,  Next: Exporting the ranker<8>,  Prev: Inspecting diagnostics<8>,  Up: Usage<67>

6.133.6.3 Ranking candidate items
.................................

     % Rank a candidate set from most preferred to least preferred
     | ?- massey_ranker::learn(my_dataset, Ranker),
          massey_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<8>,  Prev: Ranking candidate items<9>,  Up: Usage<67>

6.133.6.4 Exporting the ranker
..............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- massey_ranker::learn(my_dataset, Ranker),
          massey_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(massey_ranker(...))]
     ...

     % Export to a file
     | ?- massey_ranker::learn(my_dataset, Ranker),
          massey_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<16>,  Next: Ranker representation<10>,  Prev: Usage<67>,  Up: massey_ranker

6.133.7 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(massey_ranker),
         options(Options),
         dataset_summary(DatasetSummary)
     ]


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<10>,  Next: References<36>,  Prev: Diagnostics syntax<16>,  Up: massey_ranker

6.133.8 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     massey_ranker(Items, Ratings, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Ratings’: List of ‘Item-Rating’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options and dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<36>,  Prev: Ranker representation<10>,  Up: massey_ranker

6.133.9 References
------------------

  1. Massey, K. (1997).  'Statistical models applied to the rating of
     sports teams'.


File: TheLogtalkHandbook-3.100.1.info,  Node: mcp_server,  Next: memcached,  Prev: massey_ranker,  Up: Libraries

6.134 ‘mcp_server’
==================

MCP (Model Context Protocol) server library for Logtalk applications.
Makes any Logtalk application available as a local MCP server using
stdio transport.  Implements the MCP 2025-06-18 specification (tools,
prompts, resources, elicitation, structured output, and resource links).
Supports version negotiation.

The library uses the ‘json_rpc’ library for JSON-RPC 2.0 message
handling as currently required by the MCP specification.

* Menu:

* API documentation: API documentation<152>.
* Loading: Loading<154>.
* Testing: Testing<145>.
* Usage: Usage<68>.
* Error handling: Error handling<3>.
* Protocol::
* Supported MCP methods::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<152>,  Next: Loading<154>,  Up: mcp_server

6.134.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#mcp_server’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<154>,  Next: Testing<145>,  Prev: API documentation<152>,  Up: mcp_server

6.134.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(mcp_server(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<145>,  Next: Usage<68>,  Prev: Loading<154>,  Up: mcp_server

6.134.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(mcp_server(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<68>,  Next: Error handling<3>,  Prev: Testing<145>,  Up: mcp_server

6.134.4 Usage
-------------

* Menu:

* Implementing the tool protocol::
* Auto-dispatch vs. custom tool_call/3: Auto-dispatch vs custom tool_call/3.
* Output schemas (structured tool output): Output schemas structured tool output.
* Starting the server for debugging::
* MCP client configuration::
* Elicitation (interactive tools): Elicitation interactive tools.
* Prompts (prompt templates): Prompts prompt templates.
* Resources (data exposure): Resources data exposure.


File: TheLogtalkHandbook-3.100.1.info,  Node: Implementing the tool protocol,  Next: Auto-dispatch vs custom tool_call/3,  Up: Usage<68>

6.134.4.1 Implementing the tool protocol
........................................

To expose a Logtalk object as an MCP tool provider, implement the
‘mcp_tool_protocol’ protocol:

     :- object(my_tools,
         implements(mcp_tool_protocol)).

         :- public(factorial/2).
         :- mode(factorial(+integer, -integer), one).
         :- info(factorial/2, [
             comment is 'Computes the factorial of a non-negative integer.',
             argnames is ['N', 'F']
         ]).

         tools([
             tool(factorial, factorial, 2)
         ]).

         factorial(0, 1) :- !.
         factorial(N, F) :-
             N > 0,
             N1 is N - 1,
             factorial(N1, F1),
             F is N * F1.

     :- end_object.

The ‘tools/1’ predicate returns a list of ‘tool(Name, Functor, Arity)’
descriptors that declare which predicates are exposed as MCP tools:

   - ‘Name’ — the MCP tool name (an atom)

   - ‘Functor’ — the predicate functor

   - ‘Arity’ — the predicate arity

Tool descriptions and parameter schemas are automatically derived from
the ‘info/2’ and ‘mode/2’ directives.  This must be accurate to allow
correct derivation of inout and output arguments and types.

A ‘title’ key in the predicate’s ‘info/2’ directive provides a
human-friendly display name for the tool.  If omitted, the predicate
functor is used as the title.

The supported predicates types and their corresponding JSON types are:

Logtalk type     JSON type
                 
---------------------------------
‘integer’        ‘integer’
                 
‘float’          ‘number’
                 
‘number’         ‘number’
                 
‘atom’           ‘string’
                 
‘boolean’        ‘boolean’
                 
‘list’           ‘array’
                 
‘list(_)’        ‘array’
                 
‘compound’       ‘object’
                 
‘nonvar’         ‘string’
                 
‘term’           ‘string’
                 
‘chars’          ‘string’
                 
‘codes’          ‘string’
                 
(other)          ‘string’
                 


File: TheLogtalkHandbook-3.100.1.info,  Node: Auto-dispatch vs custom tool_call/3,  Next: Output schemas structured tool output,  Prev: Implementing the tool protocol,  Up: Usage<68>

6.134.4.2 Auto-dispatch vs. custom ‘tool_call/3’
................................................

By default, when an MCP client calls a tool, the server auto-dispatches:
it calls the corresponding predicate as a message to the application
object, collects output-mode arguments (‘-’ and ‘--’), and returns them
as text content.

For custom result formatting, implement ‘tool_call/3’:

     tool_call(factorial, Arguments, Result) :-
         member('N'-N, Arguments),
         factorial(N, F),
         number_codes(F, Codes),
         atom_codes(FAtom, Codes),
         atom_concat('The factorial is: ', FAtom, Text),
         Result = text(Text).

The ‘Result’ term can be:

   - ‘text(Atom)’ — a text result

   - ‘error(Atom)’ — a tool-level error (sets ‘isError: true’)

   - ‘results(List)’ — a list of content items (‘text(Atom)’,
     ‘error(Atom)’, ‘resource_link(URI, Name)’, or ‘resource_link(URI,
     Name, Description, MimeType)’)

   - ‘structured(StructuredContent)’ — a structured result (the server
     auto-generates a text representation for the ‘content’ field)

   - ‘structured(Items, StructuredContent)’ — a structured result with
     explicit content items for the ‘content’ field


File: TheLogtalkHandbook-3.100.1.info,  Node: Output schemas structured tool output,  Next: Starting the server for debugging,  Prev: Auto-dispatch vs custom tool_call/3,  Up: Usage<68>

6.134.4.3 Output schemas (structured tool output)
.................................................

Tools can declare an output schema by defining ‘output_schema/2’ in
their application object:

     output_schema(divide, {type-object, properties-{quotient-{type-number}}, required-[quotient]}).

When an output schema is declared, the tool descriptor includes an
‘outputSchema’ field.  The tool’s ‘tool_call/3’ can then return
‘structured(StructuredContent)’ or ‘structured(Items,
StructuredContent)’ results.  The ‘StructuredContent’ must be a
curly-term matching the schema.


File: TheLogtalkHandbook-3.100.1.info,  Node: Starting the server for debugging,  Next: MCP client configuration,  Prev: Output schemas structured tool output,  Up: Usage<68>

6.134.4.4 Starting the server for debugging
...........................................

Start the MCP server from a Logtalk top-level or script:

     | ?- mcp_server::start('my-server', my_tools).

With options:

     | ?- mcp_server::start('my-server', my_tools, [version('2.0.0'), server_title('My Server')]).

There should either be no output or only a Prolog backend term input
prompt.  Other than that, any spurious output will break the connection
between a MCP client and the MCP server.


File: TheLogtalkHandbook-3.100.1.info,  Node: MCP client configuration,  Next: Elicitation interactive tools,  Prev: Starting the server for debugging,  Up: Usage<68>

6.134.4.5 MCP client configuration
..................................

To use the server with an MCP client (e.g., VSCode or Claude Desktop),
configure it as a stdio server.  Example ‘claude_desktop_config.json’:

     {
         "mcpServers": {
             "my-server": {
                 "command": "swilgt",
                 "args": [
                     "-q",
                     "-g", "logtalk_load(my_mcp_server(loader))",
                     "-t", "halt"
                 ],
                 "env": {
                     "LOGTALKHOME": "/usr/local/share/logtalk",
                     "LOGTALKUSER": "/Users/jdoe/logtalk"
                 }
             }
         }
     }

The ‘env’ definition of the ‘LOGTALKHOME’ and ‘LOGTALKUSER’ environment
variables may or may not be required (it’s usually necessary on macOS).
When required, replace the values above with the actual values on your
Logtalk setup.

The actual arguments to the integration script (‘swilgt’ in the example
above) depend on the Prolog backend.  For example, XVM requires instead:

     {
         "mcpServers": {
             "my-server": {
                 "command": "xvmlgt",
                 "args": [
                     "-q",
                     "-g", "logtalk_load(my_mcp_server(loader)), halt.",
                 ],
                 "env": {
                     "LOGTALKHOME": "/usr/local/share/logtalk",
                     "LOGTALKUSER": "/Users/jdoe/logtalk"
                 }
             }
         }
     }


File: TheLogtalkHandbook-3.100.1.info,  Node: Elicitation interactive tools,  Next: Prompts prompt templates,  Prev: MCP client configuration,  Up: Usage<68>

6.134.4.6 Elicitation (interactive tools)
.........................................

Tools that need to ask the user questions during execution can use MCP
elicitation 'if' the MCP client supports it (tested and working with
VSCode Copilot).  The application declares the ‘elicitation’ capability
and implements ‘tool_call/4’ instead of ‘tool_call/3’:

     :- object(interactive_tools,
         implements(mcp_tool_protocol)).

         capabilities([elicitation]).

         tools([
             tool(ask_name, ask_name, 0)
         ]).

         :- public(ask_name/0).
         :- info(ask_name/0, [
             comment is 'Asks the user for their name and greets them.'
         ]).

         tool_call(ask_name, _Arguments, Elicit, Result) :-
             Schema = {
                 type-object,
                 properties-{name-{type-string}},
                 required-[name]
             },
             call(Elicit, 'What is your name?', Schema, Answer),
             (   Answer = accept(Content),
                 has_pair(Content, name, Name) ->
                 atom_concat('Hello, ', Name, Greeting),
                 atom_concat(Greeting, '!', Text),
                 Result = text(Text)
             ;   Result = text('No name provided.')
             ).

         has_pair({Pairs}, Key, Value) :-
             curly_member(Key-Value, Pairs).

         curly_member(Pair, (Pair, _)) :- !.
         curly_member(Pair, (_, Rest)) :-
             !, curly_member(Pair, Rest).
         curly_member(Pair, Pair).

     :- end_object.

The ‘Elicit’ closure is called as ‘call(Elicit, Message, Schema,
Answer)’ where:

   - ‘Message’ — an atom with the prompt text

   - ‘Schema’ — a curly-term JSON Schema for the requested input

   - ‘Answer’ — unified with ‘accept(Content)’, ‘decline’, or ‘cancel’

When ‘accept(Content)’ is returned, ‘Content’ is a curly-term with the
user’s response matching the requested schema.

See the ‘examples/birds_mcp/’ example for a complete demonstration of
elicitation with a bird identification expert system.


File: TheLogtalkHandbook-3.100.1.info,  Node: Prompts prompt templates,  Next: Resources data exposure,  Prev: Elicitation interactive tools,  Up: Usage<68>

6.134.4.7 Prompts (prompt templates)
....................................

MCP prompts are templates for structured LLM interactions.  They allow
an application to expose reusable prompt templates that MCP clients can
discover and use.  To add prompts, implement ‘mcp_prompt_protocol’ in
addition to ‘mcp_tool_protocol’, and declare ‘prompts’ in capabilities:

     :- object(my_prompts,
         implements([mcp_tool_protocol, mcp_prompt_protocol])).

         capabilities([prompts]).

         tools([]).

         prompts([
             prompt(code_review, 'Reviews code for potential issues', [
                 argument(code, 'The code to review', true),
                 argument(language, 'The programming language', false)
             ]),
             prompt(summarize, 'Summarizes a given text', [
                 argument(text, 'The text to summarize', true)
             ])
         ]).

         prompt_get(code_review, Arguments, Result) :-
             (   member(code-Code, Arguments) ->
                 atom_concat('Please review the following code for potential issues:\n\n', Code, Text)
             ;   Text = 'Please provide code to review.'
             ),
             Result = messages([message(user, text(Text))]).

         prompt_get(summarize, Arguments, Result) :-
             (   member(text-Text, Arguments) ->
                 atom_concat('Please summarize the following text:\n\n', Text, PromptText)
             ;   PromptText = 'Please provide text to summarize.'
             ),
             Result = messages([message(user, text(PromptText))]).

         :- uses(list, [member/2]).

     :- end_object.

The ‘prompts/1’ predicate returns a list of prompt descriptors:

   - ‘prompt(Name, Description, Arguments)’ — without title

   - ‘prompt(Name, Title, Description, Arguments)’ — with title

Where:

   - ‘Name’ — the MCP prompt name (an atom)

   - ‘Title’ — a human-friendly display name (an atom, optional)

   - ‘Description’ — a human-readable description (an atom)

   - ‘Arguments’ — a list of ‘argument(ArgName, ArgDescription,
     Required)’ terms where ‘Required’ is ‘true’ or ‘false’

The ‘prompt_get/3’ predicate handles prompt get requests.  Its result
term can be:

   - ‘messages(MessageList)’ — a list of prompt messages

   - ‘messages(Description, MessageList)’ — a list of messages with a
     description

Each message in the list is a ‘message(Role, Content)’ term where:

   - ‘Role’ — ‘user’ or ‘assistant’

   - ‘Content’ — ‘text(Text)’ where ‘Text’ is an atom

Multi-turn prompts can return multiple messages:

     prompt_get(debate, Arguments, Result) :-
         member(topic-Topic, Arguments),
         atom_concat('Let us debate: ', Topic, UserText),
         Result = messages([
             message(user, text(UserText)),
             message(assistant, text('I would be happy to debate that topic. What is your position?'))
         ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Resources data exposure,  Prev: Prompts prompt templates,  Up: Usage<68>

6.134.4.8 Resources (data exposure)
...................................

MCP resources expose data and content from the application that MCP
clients can access.  To add resources, implement ‘mcp_resource_protocol’
in addition to ‘mcp_tool_protocol’, and declare ‘resources’ in
capabilities:

     :- object(my_resources,
         implements([mcp_tool_protocol, mcp_resource_protocol])).

         capabilities([resources]).

         tools([]).

         resources([
             resource('logtalk://my-app/config', config, 'Application configuration', 'application/json'),
             resource('logtalk://my-app/readme', readme, 'Application readme', 'text/plain')
         ]).

         resource_read('logtalk://my-app/config', _Arguments, Result) :-
             Result = contents([
                 text_content('logtalk://my-app/config', 'application/json', '{"name": "my-app", "version": "1.0"}')
             ]).

         resource_read('logtalk://my-app/readme', _Arguments, Result) :-
             Result = contents([
                 text_content('logtalk://my-app/readme', 'text/plain', 'Welcome to my application.')
             ]).

     :- end_object.

The ‘resources/1’ predicate returns a list of resource descriptors:

   - ‘resource(URI, Name, Description, MimeType)’ — without title

   - ‘resource(URI, Name, Title, Description, MimeType)’ — with title

Where:

   - ‘URI’ — the resource identifier (an atom, typically a URI like
     ‘logtalk://my-app/data’)

   - ‘Name’ — a human-readable name (an atom)

   - ‘Title’ — a human-friendly display name (an atom, optional)

   - ‘Description’ — a human-readable description (an atom)

   - ‘MimeType’ — the MIME type of the resource content (an atom, e.g.
     ‘'text/plain'’, ‘'application/json'’)

The ‘resource_read/3’ predicate handles resource read requests.  Its
result term must be ‘contents(ContentList)’ where each content item is:

   - ‘text_content(URI, MimeType, Text)’ — for text resources

   - ‘blob_content(URI, MimeType, Base64Data)’ — for binary resources
     encoded as base64

A resource can return multiple content items:

     resource_read('logtalk://my-app/logs', _Arguments, Result) :-
         Result = contents([
             text_content('logtalk://my-app/logs', 'text/plain', 'Log entry 1'),
             text_content('logtalk://my-app/logs', 'text/plain', 'Log entry 2')
         ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Error handling<3>,  Next: Protocol,  Prev: Usage<68>,  Up: mcp_server

6.134.5 Error handling
----------------------

   - Predicate failures result in a tool-level error with ‘isError:
     true’.

   - Predicate exceptions result in a tool-level error with the
     exception term serialized as the error text.

   - Prompt execution failures result in a JSON-RPC error response.

   - Resource read failures result in a JSON-RPC error response.


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol,  Next: Supported MCP methods,  Prev: Error handling<3>,  Up: mcp_server

6.134.6 Protocol
----------------

The ‘mcp_tool_protocol’ protocol defines the following predicates:

   - ‘capabilities/1’ — returns the list of additional capabilities
     needed by the application (e.g.  ‘[elicitation]’, ‘[prompts]’,
     ‘[resources]’, or ‘[prompts, resources, elicitation]’); optional,
     defaults to ‘[]’

   - ‘tools/1’ — returns the list of tool descriptors

   - ‘tool_call/3’ — handles a tool call (optional; auto-dispatch is
     used when not defined)

   - ‘tool_call/4’ — handles a tool call with an elicitation closure
     (optional; requires ‘capabilities([elicitation])’ or
     ‘capabilities([..., elicitation])’)

   - ‘output_schema/2’ — declares a JSON Schema for structured tool
     output (optional; when defined, the tool descriptor includes
     ‘outputSchema’)

The ‘mcp_prompt_protocol’ protocol defines the following predicates:

   - ‘prompts/1’ — returns the list of prompt descriptors

   - ‘prompt_get/3’ — handles a prompt get request

The ‘mcp_resource_protocol’ protocol defines the following predicates:

   - ‘resources/1’ — returns the list of resource descriptors

   - ‘resource_read/3’ — handles a resource read request


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported MCP methods,  Prev: Protocol,  Up: mcp_server

6.134.7 Supported MCP methods
-----------------------------

Method                     Type             Description
                                            
-------------------------------------------------------------------------------
‘initialize’               Request          MCP handshake
                                            
‘initialized’              Notification     Client acknowledgment
                                            
‘ping’                     Request          Server liveness check
                                            
‘tools/list’               Request          Lists available tools
                                            
‘tools/call’               Request          Calls a tool
                                            
‘prompts/list’             Request          Lists available prompts
                                            
‘prompts/get’              Request          Gets a prompt with arguments
                                            
‘resources/list’           Request          Lists available resources
                                            
‘resources/read’           Request          Reads a resource by URI
                                            
‘elicitation/create’       Request (=>)     Asks the client for user input
                                            


File: TheLogtalkHandbook-3.100.1.info,  Node: memcached,  Next: message_pack,  Prev: mcp_server,  Up: Libraries

6.135 ‘memcached’
=================

Portable Memcached client implementing the text (ASCII) protocol.  This
library uses the ‘sockets’ library and supports all backend Prolog
systems supported by that library: ECLiPSe, GNU Prolog, SICStus Prolog,
SWI-Prolog, Trealla Prolog, and XVM.

* Menu:

* API documentation: API documentation<153>.
* Loading: Loading<155>.
* Testing: Testing<146>.
* Protocol Version::
* Features: Features<51>.
* Usage: Usage<69>.
* API Summary: API Summary<2>.
* Error Handling: Error Handling<2>.
* Key Format::
* Expiration Times::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<153>,  Next: Loading<155>,  Up: memcached

6.135.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#memcached’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<155>,  Next: Testing<146>,  Prev: API documentation<153>,  Up: memcached

6.135.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(memcached(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<146>,  Next: Protocol Version,  Prev: Loading<155>,  Up: memcached

6.135.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(memcached(tester)).

Note: Tests require a running Memcached server on ‘localhost’ port
‘11211’ (the default).  To install and start Memcached:

On macOS:

     $ brew install memcached
     $ memcached -d

On Linux (Debian/Ubuntu):

     $ sudo apt-get install memcached
     $ sudo systemctl start memcached

On Linux (RHEL/Fedora):

     $ sudo dnf install memcached
     $ sudo systemctl start memcached


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol Version,  Next: Features<51>,  Prev: Testing<146>,  Up: memcached

6.135.4 Protocol Version
------------------------

This library implements the Memcached text (ASCII) protocol as
documented in the official specification:

‘https://github.com/memcached/memcached/blob/master/doc/protocol.txt’

The text protocol is the standard protocol supported by all Memcached
clients and servers.  All commands use simple text lines terminated by
‘\r\n’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<51>,  Next: Usage<69>,  Prev: Protocol Version,  Up: memcached

6.135.5 Features
----------------

   - Full storage command support: ‘set’, ‘add’, ‘replace’, ‘append’,
     ‘prepend’, ‘cas’

   - Retrieval commands: ‘get’, ‘gets’ (with CAS token), multi-get,
     ‘gat’, ‘gats’

   - Key deletion with ‘delete’

   - Atomic increment/decrement with ‘incr’/‘decr’

   - Item expiration management with ‘touch’, ‘gat’, ‘gats’

   - Server management: ‘flush_all’, ‘version’, ‘stats’

   - Graceful disconnect with ‘quit’

   - Proper handling of all protocol response codes


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<69>,  Next: API Summary<2>,  Prev: Features<51>,  Up: memcached

6.135.6 Usage
-------------

* Menu:

* Connecting to a Memcached server::
* Storing data::
* Retrieving data::
* Check-and-Set (CAS): Check-and-Set CAS.
* Deleting data::
* Increment/Decrement::
* Touch and Get-and-Touch::
* Server management::
* Disconnecting: Disconnecting<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Connecting to a Memcached server,  Next: Storing data,  Up: Usage<69>

6.135.6.1 Connecting to a Memcached server
..........................................

Basic connection to localhost on the default port (11211):

     ?- memcached::connect(localhost, Connection).

Connection to a specific host and port:

     ?- memcached::connect('cache.example.com', 11211, Connection).


File: TheLogtalkHandbook-3.100.1.info,  Node: Storing data,  Next: Retrieving data,  Prev: Connecting to a Memcached server,  Up: Usage<69>

6.135.6.2 Storing data
......................

Store a value unconditionally:

     ?- memcached::set(Connection, my_key, 'Hello, World!').

Store with flags and expiration time (in seconds):

     ?- memcached::set(Connection, my_key, 'Hello!', 0, 3600).

Store only if the key does not exist:

     ?- memcached::add(Connection, new_key, 'New value', 0, 60).

Store only if the key already exists:

     ?- memcached::replace(Connection, existing_key, 'Updated', 0, 60).

Append data to an existing value:

     ?- memcached::append(Connection, my_key, ' World!').

Prepend data to an existing value:

     ?- memcached::prepend(Connection, my_key, 'Hello ').


File: TheLogtalkHandbook-3.100.1.info,  Node: Retrieving data,  Next: Check-and-Set CAS,  Prev: Storing data,  Up: Usage<69>

6.135.6.3 Retrieving data
.........................

Get a value by key:

     ?- memcached::get(Connection, my_key, Value).

Get a value with flags:

     ?- memcached::get(Connection, my_key, Value, Flags).

Get a value with CAS token (for optimistic locking):

     ?- memcached::gets(Connection, my_key, Value, CasUnique).

Get multiple keys at once:

     ?- memcached::mget(Connection, [key1, key2, key3], Items).


File: TheLogtalkHandbook-3.100.1.info,  Node: Check-and-Set CAS,  Next: Deleting data,  Prev: Retrieving data,  Up: Usage<69>

6.135.6.4 Check-and-Set (CAS)
.............................

CAS provides optimistic locking for cache updates:

     ?- memcached::gets(Connection, my_key, Value, CasUnique),
        % ... process value ...
        memcached::cas(Connection, my_key, 'New value', 0, 60, CasUnique).

If another client modifies the value between ‘gets’ and ‘cas’, the ‘cas’
command will throw ‘error(memcached_error(exists), _)’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Deleting data,  Next: Increment/Decrement,  Prev: Check-and-Set CAS,  Up: Usage<69>

6.135.6.5 Deleting data
.......................

Delete an item by key:

     ?- memcached::delete(Connection, my_key).

Fails if the key does not exist.


File: TheLogtalkHandbook-3.100.1.info,  Node: Increment/Decrement,  Next: Touch and Get-and-Touch,  Prev: Deleting data,  Up: Usage<69>

6.135.6.6 Increment/Decrement
.............................

Atomically increment a numeric value:

     ?- memcached::set(Connection, counter, '100'),
        memcached::incr(Connection, counter, 5, NewValue).
     % NewValue = 105

Atomically decrement a numeric value:

     ?- memcached::decr(Connection, counter, 3, NewValue).
     % NewValue = 102

Note: The item must already exist and contain a decimal representation
of a 64-bit unsigned integer.  Decrementing below 0 yields 0.


File: TheLogtalkHandbook-3.100.1.info,  Node: Touch and Get-and-Touch,  Next: Server management,  Prev: Increment/Decrement,  Up: Usage<69>

6.135.6.7 Touch and Get-and-Touch
.................................

Update expiration time without fetching:

     ?- memcached::touch(Connection, my_key, 3600).

Fetch and update expiration time in one operation:

     ?- memcached::gat(Connection, my_key, 3600, Value).

Fetch with CAS and update expiration:

     ?- memcached::gats(Connection, my_key, 3600, Value, CasUnique).


File: TheLogtalkHandbook-3.100.1.info,  Node: Server management,  Next: Disconnecting<2>,  Prev: Touch and Get-and-Touch,  Up: Usage<69>

6.135.6.8 Server management
...........................

Invalidate all items:

     ?- memcached::flush_all(Connection).

Invalidate all items after a delay (in seconds):

     ?- memcached::flush_all(Connection, 30).

Get server version:

     ?- memcached::version(Connection, Version).

Get server statistics:

     ?- memcached::stats(Connection, Stats).

Get specific statistics:

     ?- memcached::stats(Connection, items, Stats).


File: TheLogtalkHandbook-3.100.1.info,  Node: Disconnecting<2>,  Prev: Server management,  Up: Usage<69>

6.135.6.9 Disconnecting
.......................

     ?- memcached::disconnect(Connection).


File: TheLogtalkHandbook-3.100.1.info,  Node: API Summary<2>,  Next: Error Handling<2>,  Prev: Usage<69>,  Up: memcached

6.135.7 API Summary
-------------------

* Menu:

* Connection management::
* Storage commands::
* Retrieval commands::
* Deletion::
* Increment/Decrement: Increment/Decrement<2>.
* Touch::
* Server commands::


File: TheLogtalkHandbook-3.100.1.info,  Node: Connection management,  Next: Storage commands,  Up: API Summary<2>

6.135.7.1 Connection management
...............................

   - ‘connect(+Host, +Port, -Connection)’ - Connect to server

   - ‘connect(+Host, -Connection)’ - Connect to server on default port

   - ‘disconnect(+Connection)’ - Disconnect from server


File: TheLogtalkHandbook-3.100.1.info,  Node: Storage commands,  Next: Retrieval commands,  Prev: Connection management,  Up: API Summary<2>

6.135.7.2 Storage commands
..........................

   - ‘set(+Connection, +Key, +Value, +Flags, +ExpTime)’ - Store
     unconditionally

   - ‘set(+Connection, +Key, +Value)’ - Store with default flags and no
     expiration

   - ‘add(+Connection, +Key, +Value, +Flags, +ExpTime)’ - Store only if
     new

   - ‘replace(+Connection, +Key, +Value, +Flags, +ExpTime)’ - Store only
     if exists

   - ‘append(+Connection, +Key, +Value)’ - Append to existing value

   - ‘prepend(+Connection, +Key, +Value)’ - Prepend to existing value

   - ‘cas(+Connection, +Key, +Value, +Flags, +ExpTime, +CasUnique)’ -
     Check-and-set


File: TheLogtalkHandbook-3.100.1.info,  Node: Retrieval commands,  Next: Deletion,  Prev: Storage commands,  Up: API Summary<2>

6.135.7.3 Retrieval commands
............................

   - ‘get(+Connection, +Key, -Value)’ - Get value

   - ‘get(+Connection, +Key, -Value, -Flags)’ - Get value and flags

   - ‘gets(+Connection, +Key, -Value, -CasUnique)’ - Get with CAS token

   - ‘gets(+Connection, +Key, -Value, -Flags, -CasUnique)’ - Get with
     flags and CAS

   - ‘mget(+Connection, +Keys, -Items)’ - Multi-get


File: TheLogtalkHandbook-3.100.1.info,  Node: Deletion,  Next: Increment/Decrement<2>,  Prev: Retrieval commands,  Up: API Summary<2>

6.135.7.4 Deletion
..................

   - ‘delete(+Connection, +Key)’ - Delete item


File: TheLogtalkHandbook-3.100.1.info,  Node: Increment/Decrement<2>,  Next: Touch,  Prev: Deletion,  Up: API Summary<2>

6.135.7.5 Increment/Decrement
.............................

   - ‘incr(+Connection, +Key, +Amount, -NewValue)’ - Increment

   - ‘decr(+Connection, +Key, +Amount, -NewValue)’ - Decrement


File: TheLogtalkHandbook-3.100.1.info,  Node: Touch,  Next: Server commands,  Prev: Increment/Decrement<2>,  Up: API Summary<2>

6.135.7.6 Touch
...............

   - ‘touch(+Connection, +Key, +ExpTime)’ - Update expiration

   - ‘gat(+Connection, +Key, +ExpTime, -Value)’ - Get and touch

   - ‘gats(+Connection, +Key, +ExpTime, -Value, -CasUnique)’ -
     Get-and-touch with CAS


File: TheLogtalkHandbook-3.100.1.info,  Node: Server commands,  Prev: Touch,  Up: API Summary<2>

6.135.7.7 Server commands
.........................

   - ‘flush_all(+Connection)’ - Invalidate all items

   - ‘flush_all(+Connection, +Delay)’ - Invalidate all items after delay

   - ‘version(+Connection, -Version)’ - Get server version

   - ‘stats(+Connection, -Stats)’ - Get general statistics

   - ‘stats(+Connection, +Argument, -Stats)’ - Get specific statistics


File: TheLogtalkHandbook-3.100.1.info,  Node: Error Handling<2>,  Next: Key Format,  Prev: API Summary<2>,  Up: memcached

6.135.8 Error Handling
----------------------

Most predicates throw ‘error(memcached_error(Reason), Context)’ on
failure.  Common error reasons:

   - ‘connection_failed’ - Could not establish TCP connection

   - ‘not_stored’ - Storage condition not met (e.g.  ‘add’ on existing
     key)

   - ‘exists’ - CAS conflict (item was modified by another client)

   - ‘not_found’ - CAS on non-existent key

   - ‘server_error(Message)’ - Server returned an error

Retrieval predicates (‘get’, ‘gets’, ‘gat’, ‘gats’) fail (rather than
throw) when the requested key is not found.  The ‘delete’, ‘incr’,
‘decr’, and ‘touch’ predicates also fail when the key is not found.


File: TheLogtalkHandbook-3.100.1.info,  Node: Key Format,  Next: Expiration Times,  Prev: Error Handling<2>,  Up: memcached

6.135.9 Key Format
------------------

   - Keys are atoms up to 250 characters

   - Keys must not contain control characters or whitespace

   - Keys are case-sensitive


File: TheLogtalkHandbook-3.100.1.info,  Node: Expiration Times,  Prev: Key Format,  Up: memcached

6.135.10 Expiration Times
-------------------------

   - ‘0’ means the item never expires (may still be evicted by LRU)

   - Values up to 2592000 (30 days) are treated as relative seconds

   - Values over 2592000 are treated as absolute Unix timestamps

   - Negative values cause immediate expiration


File: TheLogtalkHandbook-3.100.1.info,  Node: message_pack,  Next: meta,  Prev: memcached,  Up: Libraries

6.136 ‘message_pack’
====================

The ‘message_pack’ library provides predicates for parsing and
generating data in the MessagePack(1) format based on the current
specification and reference documents found at:

   - ‘https://github.com/msgpack/msgpack/blob/master/spec.md’

   - ‘https://github.com/msgpack/msgpack/blob/master/spec-old.md’

It follows the representation conventions used by the existing binary
and JSON libraries whenever practical.

* Menu:

* API documentation: API documentation<154>.
* Loading: Loading<156>.
* Testing: Testing<147>.
* Representation: Representation<15>.
* Notes: Notes<9>.

   ---------- Footnotes ----------

   (1) https://msgpack.org/


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<154>,  Next: Loading<156>,  Up: message_pack

6.136.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#message_pack’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<156>,  Next: Testing<147>,  Prev: API documentation<154>,  Up: message_pack

6.136.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(message_pack(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<147>,  Next: Representation<15>,  Prev: Loading<156>,  Up: message_pack

6.136.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(message_pack(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<15>,  Next: Notes<9>,  Prev: Testing<147>,  Up: message_pack

6.136.4 Representation
----------------------

The following choices of syntax have been made to represent MessagePack
elements as terms:

   - Maps are represented using curly-bracketed terms, ‘{Pairs}’, where
     each pair uses the representation ‘Key-Value’.

   - Arrays are represented using lists.

   - Strings can be represented as atoms, ‘chars(List)’, or
     ‘codes(List)’.  Use the ‘message_pack/1’ parameterized object with
     the parameter bound to ‘atom’, ‘chars’, or ‘codes’ to select the
     representation used when decoding strings.

   - MessagePack strings are validated using strict UTF-8 decoding and
     encoding.  Invalid UTF-8 byte sequences and invalid Unicode scalar
     values are rejected.

   - Binary data is represented by ‘bytes(List)’.

   - Extension values are represented by ‘ext(Type, bytes(Bytes))’,
     where ‘Type’ is the signed 8-bit extension type and ‘Bytes’ is the
     extension payload.

   - The MessagePack values ‘false’, ‘true’, and ‘nil’ are represented
     by, respectively, the ‘@false’, ‘@true’, and ‘@null’ compound
     terms.

   - IEEE 754 infinities and NaN values are represented by the
     ‘@infinity’, ‘@negative_infinity’, and ‘@not_a_number’ compound
     terms.

   - Only some backends distinguish between positive zero and negative
     zero.  The decoder produces the ‘0.0’ and ‘-0.0’ floats, but
     backends that normalize both values to ‘0.0’ cannot preserve the
     sign of zero when re-encoding.

The following table exemplifies the term equivalents of common
MessagePack elements when using ‘message_pack(atom)’:

MessagePack value     term
                      
--------------------------------------------------
nil                   @null
                      
false                 @false
                      
true                  @true
                      
“foo”                 foo
                      
[1,2,3]               [1,2,3]
                      
{“a”:1,”b”:true}      {a-1, <b-@true>}
                      
bin payload           bytes([…])
                      
extension payload     ext(Type, bytes([…]))
                      


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<9>,  Prev: Representation<15>,  Up: message_pack

6.136.5 Notes
-------------

   - Generated integers always use the smallest valid MessagePack
     integer format.

   - Generated floating point values use the single-precision format
     when it can exactly represent the input value; otherwise, the
     double-precision format is used.

   - Recommended string representation choice depends on the trust
     boundary of the input.  For trusted input, ‘message_pack(atom)’ is
     usually the most convenient choice when the rest of the application
     already works with atoms.  For untrusted input, prefer
     ‘message_pack(codes)’ or ‘message_pack(chars)’ to avoid interning
     arbitrary incoming strings as atoms.

   - For untrusted input, ‘message_pack(codes)’ is generally the best
     default choice.  It avoids atom creation while preserving the exact
     decoded Unicode code points.  ‘message_pack(chars)’ provides the
     same safety with a more readable but less compact representation.

   - The predefined timestamp extension is currently exposed using the
     generic ‘ext(-1, bytes(Bytes))’ representation.

   - The library requires a backend Prolog compiler with unbounded
     integer support, matching the requirements of the existing ‘cbor’,
     ‘avro’, and ‘protobuf’ libraries.


File: TheLogtalkHandbook-3.100.1.info,  Node: meta,  Next: meta_compiler,  Prev: message_pack,  Up: Libraries

6.137 ‘meta’
============

This library provides implementations of common meta-predicates.  The
‘meta’ object implements common meta-predicates like ‘map/3’ and
‘fold_left/4’.

See also the ‘meta_compiler’ library, which provides optimized
compilation of meta-predicate calls.

* Menu:

* API documentation: API documentation<155>.
* Loading: Loading<157>.
* Testing: Testing<148>.
* Usage: Usage<70>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<155>,  Next: Loading<157>,  Up: meta

6.137.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#meta’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<157>,  Next: Testing<148>,  Prev: API documentation<155>,  Up: meta

6.137.2 Loading
---------------

To load the main entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(meta(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<148>,  Next: Usage<70>,  Prev: Loading<157>,  Up: meta

6.137.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(meta(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<70>,  Prev: Testing<148>,  Up: meta

6.137.4 Usage
-------------

See e.g.  the ‘metapredicates’ example and unit tests.


File: TheLogtalkHandbook-3.100.1.info,  Node: meta_compiler,  Next: mime_types,  Prev: meta,  Up: Libraries

6.138 ‘meta_compiler’
=====================

This library supports implementations optimized compilation of
meta-calls for the predicates defined in the ‘meta’ library.

* Menu:

* API documentation: API documentation<156>.
* Loading: Loading<158>.
* Testing: Testing<149>.
* Usage: Usage<71>.
* Known issues: Known issues<15>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<156>,  Next: Loading<158>,  Up: meta_compiler

6.138.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#meta-compiler’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<158>,  Next: Testing<149>,  Prev: API documentation<156>,  Up: meta_compiler

6.138.2 Loading
---------------

To load the main entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(meta_compiler(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<149>,  Next: Usage<71>,  Prev: Loading<158>,  Up: meta_compiler

6.138.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(meta_compiler(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<71>,  Next: Known issues<15>,  Prev: Testing<149>,  Up: meta_compiler

6.138.4 Usage
-------------

If ‘meta_compiler’ is the only hook object you are using, you can set it
as the default hook object (but note that the optimizations are only
applied to entities compiled with the ‘optimize’ flag turned on):

     | ?- set_logtalk_flag(hook, meta_compiler).
     ...

Otherwise, use the ‘hook(meta_compiler)’ and ‘optimize(on)’ compiler
options when compiling and loading the code that you want to optimize.
For example:

     | ?- logtalk_load(my_source_file, [hook(meta_compiler), optimize(on)]).
     ...

See also the ‘metapredicates_compiled’ example and unit tests.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<15>,  Prev: Usage<71>,  Up: meta_compiler

6.138.5 Known issues
--------------------

Goals in clauses containing parameter variables are currently not
expanded by this library and thus not optimized.


File: TheLogtalkHandbook-3.100.1.info,  Node: mime_types,  Next: modified_z_score_anomaly_detector,  Prev: meta_compiler,  Up: Libraries

6.139 ‘mime_types’
==================

The ‘mime_types’ library provides convenience predicates for mapping
file extensions, file names, and URL-like resources to MIME media types
and content encodings.

The current implementation ships with a built-in registry containing a
practical set of common standard mappings plus a smaller set of de-facto
common mappings.  Additional mappings can be loaded at runtime from
‘mime.types’-style files.

Lookup is lenient by default.  The convenience predicates also accept a
boolean ‘Strict’ argument to restrict lookup to strict runtime overlays
plus the built-in standard registry.

The library uses the ‘os’ library ‘decompose_file_name/4’ predicate to
split paths, and recognizes common compound suffixes such as ‘.tgz’ and
‘.svgz’.

* Menu:

* API documentation: API documentation<157>.
* Loading: Loading<159>.
* Testing: Testing<150>.
* Usage: Usage<72>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<157>,  Next: Loading<159>,  Up: mime_types

6.139.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#mime_types’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<159>,  Next: Testing<150>,  Prev: API documentation<157>,  Up: mime_types

6.139.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(mime_types(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<150>,  Next: Usage<72>,  Prev: Loading<159>,  Up: mime_types

6.139.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(mime_types(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<72>,  Prev: Testing<150>,  Up: mime_types

6.139.4 Usage
-------------

Guess the MIME type and content encoding for a file name:

     | ?- mime_types::guess_file_type('archive.tgz', Type, Encoding).
     Type = 'application/x-tar',
     Encoding = gzip
     yes

Lookup a preferred extension for a MIME type:

     | ?- mime_types::guess_extension('application/json', Extension).
     Extension = '.json'
     yes

Read a ‘mime.types’-style file without mutating the runtime registry:

     | ?- mime_types::read_mime_types('mime.types', Pairs).

Load additional runtime mappings from a ‘mime.types’-style file:

     | ?- mime_types::load('mime.types').


File: TheLogtalkHandbook-3.100.1.info,  Node: modified_z_score_anomaly_detector,  Next: mutations,  Prev: mime_types,  Up: Libraries

6.140 ‘modified_z_score_anomaly_detector’
=========================================

Statistical modified Z-score anomaly detector for continuous datasets.
It is a statistical anomaly-detection method based on the modified
Z-score defined by Iglewicz and Hoaglin (1993): for each known
continuous attribute value ‘x’, the detector computes ‘0.6745 * (x -
median) / mad’, where ‘median’ is the learned sample median and ‘mad’ is
the learned median absolute deviation, and then aggregates the
per-attribute modified Z-scores using the selected learn-time
‘score_mode/1’ option.

The library implements the ‘anomaly_detector_protocol’ defined in the
‘anomaly_detection_protocols’ library.  It learns a detector from a
continuous dataset, computes anomaly scores for new instances, predicts
‘normal’ or ‘anomaly’, and exports learned detectors as clauses or
files.

Datasets are represented as objects implementing the
‘anomaly_dataset_protocol’ protocol from the
‘anomaly_detection_protocols’ library.  See the
‘anomaly_detection_protocols/test_datasets’ directory for examples.

* Menu:

* API documentation: API documentation<158>.
* Loading: Loading<160>.
* Testing: Testing<151>.
* Features: Features<52>.
* Options: Options<49>.
* Detector representation: Detector representation<7>.
* Notes: Notes<10>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<158>,  Next: Loading<160>,  Up: modified_z_score_anomaly_detector

6.140.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#modified-z-score’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<160>,  Next: Testing<151>,  Prev: API documentation<158>,  Up: modified_z_score_anomaly_detector

6.140.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(modified_z_score_anomaly_detector(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<151>,  Next: Features<52>,  Prev: Loading<160>,  Up: modified_z_score_anomaly_detector

6.140.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(modified_z_score_anomaly_detector(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<52>,  Next: Options<49>,  Prev: Testing<151>,  Up: modified_z_score_anomaly_detector

6.140.4 Features
----------------

   - 'Statistical method': implements robust anomaly detection based on
     the modified Z-score described by Iglewicz and Hoaglin (1993),
     using the sample median and median absolute deviation of each
     continuous attribute to measure how far new observations deviate
     from the training data distribution.

   - 'Classical per-attribute modified Z-score': for each known
     attribute value ‘x’, the library computes the standard robust score
     ‘0.6745 * (x - median) / mad’, where ‘median’ is the learned sample
     median for that attribute and ‘mad’ is the learned median absolute
     deviation.

   - 'Continuous features only': accepts datasets whose declared
     attributes are all ‘continuous’.

   - 'Robust statistics': reuses the ‘statistics’ library ‘sample’
     object to compute per-attribute medians and the median of absolute
     deviations.

   - 'Baseline training selection': supports learn-time
     ‘baseline_class_values(ClassValues)’ and
     ‘baseline_selection_policy(Policy)’ options.  The default baseline
     class values are ‘[normal]’.  The default ‘reject’ policy throws an
     error if non-baseline examples are present, while ‘filter’ removes
     them before fitting.

   - 'Missing-value tolerant': ignores missing values when fitting
     attribute statistics.  During scoring, queries must provide at
     least one known value.  In the default
     ‘score_mode(root_mean_square)’, the raw score is normalized by the
     number of known values so that scores remain comparable across
     different missing-value patterns.

   - 'Configurable scoring semantics': supports both dense multivariate
     deviation scoring using ‘score_mode(root_mean_square)’ and sparse
     anomaly detection using ‘score_mode(any_feature_extreme)’.  The
     default root-mean-square mode reuses the ‘numberlist’ library
     Euclidean norm predicate as part of the computation.  The
     ‘score_mode/1’ option only controls how the per-attribute modified
     Z-scores are aggregated into a single raw anomaly score.

   - 'Bounded scoring': maps the raw multivariate modified Z-score to
     ‘[0.0, 1.0)’ using ‘Score = Raw / (1 + Raw)’.

   - 'Default threshold': the default
     ‘anomaly_threshold(0.7777777777777778)’ corresponds to the
     classical raw modified Z-score cutoff ‘3.5’ recommended by Iglewicz
     and Hoaglin (1993), while remaining overrideable in ‘learn/3’ and
     ‘predict/4’.

   - 'Learn-time score mode': ‘score_mode/1’ is recorded in the learned
     detector and reused for subsequent scoring and prediction.  Passing
     a ‘score_mode/1’ option to ‘predict/4’ does not override the
     learned mode.

   - 'All-missing queries rejected': scoring and prediction throw a
     ‘domain_error(non_empty_known_values, AttributeNames)’ exception
     when every declared feature is missing in the query.

   - 'Featureless datasets rejected': datasets must declare at least one
     continuous feature; otherwise ‘learn/2-3’ throws a
     ‘domain_error(non_empty_features, Dataset)’ exception.

   - 'Detector export': learned detectors can be exported as predicate
     clauses.

   - 'Explicit validation and diagnostics': supports the shared
     ‘check_anomaly_detector/1’, ‘valid_anomaly_detector/1’,
     ‘diagnostics/2’, ‘diagnostic/2’, and ‘anomaly_detector_options/2’
     predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<49>,  Next: Detector representation<7>,  Prev: Features<52>,  Up: modified_z_score_anomaly_detector

6.140.5 Options
---------------

The following options are supported by the public API:

   - ‘anomaly_threshold(Threshold)’: Threshold for ‘predict/3-4’
     (default: ‘0.7777777777777778’)

   - ‘baseline_class_values(ClassValues)’: Learn-time class labels that
     are admissible for baseline fitting (default: ‘[normal]’)

   - ‘baseline_selection_policy(Policy)’: Learn-time handling of
     examples whose class is not listed in ‘baseline_class_values/1’.
     Supported values are ‘filter’ and ‘reject’ (default: ‘reject’)

   - ‘score_mode(Mode)’: Learn-time score aggregation mode for
     ‘learn/3’.  Supported values are ‘root_mean_square’ and
     ‘any_feature_extreme’ (default: ‘root_mean_square’).  If passed to
     ‘predict/4’, it is ignored and the value stored in the learned
     detector is used.


File: TheLogtalkHandbook-3.100.1.info,  Node: Detector representation<7>,  Next: Notes<10>,  Prev: Options<49>,  Up: modified_z_score_anomaly_detector

6.140.6 Detector representation
-------------------------------

The learned detector is represented by default as:

     modified_z_score_detector(TrainingDataset, Encoders, Diagnostics)

Where:

   - ‘TrainingDataset’: training dataset object identifier

   - ‘Encoders’: list of ‘modified_zscore(Attribute, Median, Scale)’
     records

   - ‘Diagnostics’: learned metadata terms including ‘model/1’,
     ‘training_dataset/1’, ‘attribute_names/1’, ‘feature_count/1’,
     ‘example_count/1’, and ‘options/1’

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
detector term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<10>,  Prev: Detector representation<7>,  Up: modified_z_score_anomaly_detector

6.140.7 Notes
-------------

Scoring has three stages.  First, the detector computes one classical
per-attribute modified Z-score for each known attribute value using
‘0.6745 * (x - median) / mad’.  Second, those per-attribute modified
Z-scores are aggregated into a single raw anomaly score according to the
learned ‘score_mode/1’ option.  Third, the raw score is mapped to the
interval ‘[0.0, 1.0)’ using ‘Score = Raw / (1 + Raw)’.

The ‘score_mode/1’ option does not change the classical per-attribute
formula.  It only changes the aggregation step.  With
‘score_mode(root_mean_square)’, the raw score is the root mean square of
the per-attribute modified Z-scores.  With
‘score_mode(any_feature_extreme)’, the raw score is the maximum absolute
per-attribute modified Z-score.

The ‘baseline_class_values/1’ option declares which dataset class labels
are admissible for fitting the baseline medians and median absolute
deviations.  The ‘baseline_selection_policy/1’ option then controls what
happens when other labels are present in the training data.  The default
‘reject’ policy raises a ‘domain_error(baseline_only_training_data,
Dataset)’ exception when any non-baseline example is found.  The
‘filter’ policy removes non-baseline examples before fitting.

Attributes with zero observed median absolute deviation are assigned a
fallback scale of ‘1.0’.  This keeps the detector well-defined for
singleton datasets or constant columns while still yielding zero score
for matching values and positive scores for deviating values.

The root-mean-square aggregation keeps the default threshold stable as
the number of observed dimensions grows and avoids penalizing partially
observed queries solely for having fewer known attributes.

Use ‘score_mode(any_feature_extreme)’ when a single extreme feature
should be sufficient to flag an anomaly in high-dimensional data.


File: TheLogtalkHandbook-3.100.1.info,  Node: mutations,  Next: multisets,  Prev: modified_z_score_anomaly_detector,  Up: Libraries

6.141 ‘mutations’
=================

Experimental library.  Should not be used in production code.  Details
can be changed without advance notice.

The ‘mutations’ library provides support for generating random mutations
of selected types.  The library defines default mutation algorithms for
the following basic types:

   - ‘atom’

   - ‘integer’

   - ‘float’

   - ‘compound’

   - ‘list’

The user can add additional mutation algorithms for these or other types
by defining objects or categories providing clauses for the ‘mutation/3’
predicate and expanding the entity source files using the
‘mutations_store’ object as the hook object.

This library is expected to eventually be used to support mutation-based
'fuzz testing'.

By default, loading this library loads a set of default mutation
algorithms.  These can be overridden by defining alternative mutations
and a custom loader file.

* Menu:

* API documentation: API documentation<159>.
* Loading: Loading<161>.
* Testing: Testing<152>.
* Usage: Usage<73>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<159>,  Next: Loading<161>,  Up: mutations

6.141.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#mutations’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<161>,  Next: Testing<152>,  Prev: API documentation<159>,  Up: mutations

6.141.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(mutations(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<152>,  Next: Usage<73>,  Prev: Loading<161>,  Up: mutations

6.141.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(mutations(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<73>,  Prev: Testing<152>,  Up: mutations

6.141.4 Usage
-------------

The ‘mutations’ category complements the ‘type’ object and thus its
predicates are accessed via this object.  For example:

     | ?- type::mutation(integer, 123, M).
     M = 1293
     yes

     | type::mutation(integer, 123, M).
     M = 5123
     yes

     | type::mutation(integer, 123, M).
     M = -123
     yes

     | type::mutation(integer, 123, M).
     M = 23
     yes

When there are multiple mutation algorithms for a given type, the
predicate ‘type::mutation/3’ chooses one of them randomly.  We can query
the number of mutation algorithms available per type using the
‘mutations_store::counter/2’ predicate:

     | ?- mutations_store::counter(Type, Count).
     Type = atom,
     Count = 6 ;
     Type = integer,
     Count = 7 ;
     ...

Loading this library also loads the ‘arbitrary’ library, which provides
‘get_seed/1’ and ‘set_seed/1’ predicates that can be used to control the
pseudo-random number generator.


File: TheLogtalkHandbook-3.100.1.info,  Node: multisets,  Next: nanoid,  Prev: mutations,  Up: Libraries

6.142 ‘multisets’
=================

This library provides predicates for generating and querying multisets
over lists.  Multisets are unordered selections of a given length with
element repetition allowed.  The following categories of predicates are
provided:

   - 'Generation operations' - Predicates for generating multisets.

   - 'Ordering variants' - Predicates that support an additional order
     argument (‘default’ or ‘lexicographic’) for controlling output
     order.

   - 'Distinct-value generation' - Predicates for generating multisets
     while deduplicating equal-valued results.

   - 'Indexed access' - Predicates for direct access to multisets at
     specific positions, including order-aware access.

   - 'Counting operations' - Predicates for counting multisets and
     distinct multisets.

   - 'Random selection' - Predicates for randomly selecting and sampling
     multisets and distinct multisets.

   - 'Lexicographic stepping' - Predicates for stepping to the next or
     previous multiset in lexicographic order.

Dedicated ‘arrangements’, ‘cartesian_products’, ‘combinations’,
‘permutations’, ‘derangements’, ‘partitions’, and ‘subsequences’
libraries are also available for focused APIs on related operations.

* Menu:

* API documentation: API documentation<160>.
* Loading: Loading<162>.
* Testing: Testing<153>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<160>,  Next: Loading<162>,  Up: multisets

6.142.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#multisets’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<162>,  Next: Testing<153>,  Prev: API documentation<160>,  Up: multisets

6.142.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(multisets(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<153>,  Prev: Loading<162>,  Up: multisets

6.142.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(multisets(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: nanoid,  Next: naive_bayes_classifier,  Prev: multisets,  Up: Libraries

6.143 ‘nanoid’
==============

This library generates random NanoID identifiers:

‘https://github.com/ai/nanoid’

By default, identifiers are represented as atoms with 21 symbols and use
the standard URL-safe alphabet:

     _-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ

Custom size, alphabet, and representation (atoms, lists of characters,
or lists of character codes) are supported using a parametric object.

The generation of random identifiers uses the ‘/dev/urandom’ random
number generator when available.  This includes macOS, Linux, *BSD, and
other POSIX operating systems.  On Windows, a pseudo-random generator is
used, randomized using the current wall time.

See also the ‘ids’, ‘uuid’, and ‘ulid’ libraries.

* Menu:

* API documentation: API documentation<161>.
* Loading: Loading<163>.
* Testing: Testing<154>.
* Usage: Usage<74>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<161>,  Next: Loading<163>,  Up: nanoid

6.143.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#nanoid’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<163>,  Next: Testing<154>,  Prev: API documentation<161>,  Up: nanoid

6.143.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(nanoid(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<154>,  Next: Usage<74>,  Prev: Loading<163>,  Up: nanoid

6.143.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(nanoid(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<74>,  Prev: Testing<154>,  Up: nanoid

6.143.4 Usage
-------------

To generate an identifier using the default configuration:

     | ?- nanoid::generate(NanoID).
     NanoID = 'V1StGXR8_Z5jdHi6B-myT'
     yes

To generate a 10-symbol identifier represented as a list of characters:

     | ?- nanoid(chars, 10, 'abcdef012345')::generate(NanoID).
     NanoID = ['4','b','d','f','a','0','3','2','1','e']
     yes

To generate a 32-symbol identifier represented as a list of character
codes:

     | ?- nanoid(codes, 32, [0'a,0'b,0'c,0'd,0'e,0'f,0'0,0'1,0'2,0'3])::generate(NanoID).
     NanoID = [49,97,99,100,48,102,98,101,50,51,48,101,99,102,49,50,98,100,49,97,48,51,101,98,100,99,49,102,48,97,50,100]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: naive_bayes_classifier,  Next: nearest_centroid_classifier,  Prev: nanoid,  Up: Libraries

6.144 ‘naive_bayes_classifier’
==============================

Naive Bayes probabilistic classifier based on Bayes theorem with strong
(naive) independence assumptions between features and supporting both
categorical and continuous (Gaussian) features with Laplace smoothing.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset, using it to make predications, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  See ‘test_files’
directory for examples.

* Menu:

* API documentation: API documentation<162>.
* Loading: Loading<164>.
* Testing: Testing<155>.
* Features: Features<53>.
* Usage: Usage<75>.
* Classifier representation: Classifier representation<8>.
* References: References<37>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<162>,  Next: Loading<164>,  Up: naive_bayes_classifier

6.144.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#naive_bayes_classifier’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<164>,  Next: Testing<155>,  Prev: API documentation<162>,  Up: naive_bayes_classifier

6.144.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(naive_bayes_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<155>,  Next: Features<53>,  Prev: Loading<164>,  Up: naive_bayes_classifier

6.144.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(naive_bayes_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<53>,  Next: Usage<75>,  Prev: Testing<155>,  Up: naive_bayes_classifier

6.144.4 Features
----------------

   - 'Categorical Features': Handles discrete-valued features with
     Laplace smoothing

   - 'Continuous Features': Uses Gaussian (normal) distribution for
     numeric features

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses

   - 'Probability Estimation': Provides both class predictions and
     probability distributions


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<75>,  Next: Classifier representation<8>,  Prev: Features<53>,  Up: naive_bayes_classifier

6.144.5 Usage
-------------

* Menu:

* Learning a Classifier: Learning a Classifier<3>.
* Making Predictions: Making Predictions<3>.
* Exporting the Classifier: Exporting the Classifier<3>.
* Using a learned classifier: Using a learned classifier<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a Classifier<3>,  Next: Making Predictions<3>,  Up: Usage<75>

6.144.5.1 Learning a Classifier
...............................

     % Learn from a dataset object
     | ?- naive_bayes_classifier::learn(my_dataset, Classifier).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Making Predictions<3>,  Next: Exporting the Classifier<3>,  Prev: Learning a Classifier<3>,  Up: Usage<75>

6.144.5.2 Making Predictions
............................

     % Predict class for a new instance and the probability distribution
     | ?- Instance = [...],
          naive_bayes_classifier::learn(my_dataset, Classifier),
          naive_bayes_classifier::predict(Classifier, Instance, PredictedClass),
          naive_bayes_classifier::predict_probability(Classifier, Instance, Probabilities).
     PredictedClass = ...,
     Probabilities = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the Classifier<3>,  Next: Using a learned classifier<2>,  Prev: Making Predictions<3>,  Up: Usage<75>

6.144.5.3 Exporting the Classifier
..................................

Learned classifiers can be exported as a list of clauses or to a file
for later use.

     % Export as predicate clauses
     | ?- naive_bayes_classifier::learn(my_dataset, Classifier),
          naive_bayes_classifier::export_to_clauses(Classifier, my_classifier, Clauses).
     Clauses = [my_classifier(...)]
     ...

     % Export to a file
     | ?- naive_bayes_classifier::learn(my_dataset, Classifier),
          naive_bayes_classifier::export_to_file(Classifier, my_classifier, 'classifier.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Using a learned classifier<2>,  Prev: Exporting the Classifier<3>,  Up: Usage<75>

6.144.5.4 Using a learned classifier
....................................

Learned and saved classifiers can later be used for predictions without
needing to access the original training dataset.

     % Later, load the file and use the classifier
     | ?- consult('classifier.pl'),
          my_classifier(Classifier),
          Instance = [...],
          naive_bayes_classifier::predict(Classifier, Instance, Class).
     Class = ...
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<8>,  Next: References<37>,  Prev: Usage<75>,  Up: naive_bayes_classifier

6.144.6 Classifier representation
---------------------------------

The learned classifier is represented as a compound term:

     nb_classifier(Classes, ClassPriors, AttributeNames, FeatureTypes, FeatureParams)

Where:

   - ‘Classes’: List of class labels

   - ‘ClassPriors’: List of ‘Class-Prior’ probability pairs

   - ‘AttributeNames’: List of attribute names in order

   - ‘FeatureTypes’: List of types (‘categorical’ or ‘continuous’)

   - ‘FeatureParams’: List of learned parameters for each feature

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<37>,  Prev: Classifier representation<8>,  Up: naive_bayes_classifier

6.144.7 References
------------------

  1. Rish, I. (2001).  “An empirical study of the naive Bayes
     classifier”.

  2. Russell, S. & Norvig, P. (2020).  “Artificial Intelligence: A
     Modern Approach”.

  3. Mitchell, T. (1997).  “Machine Learning”.  Chapter 6: Bayesian
     Learning.


File: TheLogtalkHandbook-3.100.1.info,  Node: nearest_centroid_classifier,  Next: nested_dictionaries,  Prev: naive_bayes_classifier,  Up: Libraries

6.145 ‘nearest_centroid_classifier’
===================================

Nearest Centroid classifier.  Assigns to an instance the class of the
training samples whose mean (centroid) is closest to the instance.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset, using it to make predictions, and exporting
it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  See ‘test_files’
directory for examples.

* Menu:

* API documentation: API documentation<163>.
* Loading: Loading<165>.
* Testing: Testing<156>.
* Features: Features<54>.
* Usage: Usage<76>.
* Options: Options<50>.
* Classifier representation: Classifier representation<9>.
* References: References<38>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<163>,  Next: Loading<165>,  Up: nearest_centroid_classifier

6.145.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#nearest_centroid_classifier’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<165>,  Next: Testing<156>,  Prev: API documentation<163>,  Up: nearest_centroid_classifier

6.145.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(nearest_centroid_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<156>,  Next: Features<54>,  Prev: Loading<165>,  Up: nearest_centroid_classifier

6.145.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(nearest_centroid_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<54>,  Next: Usage<76>,  Prev: Testing<156>,  Up: nearest_centroid_classifier

6.145.4 Features
----------------

   - 'Multiple Distance Metrics': Euclidean, Manhattan, cosine

   - 'Mixed Features': Automatically handles categorical and continuous
     features

   - 'Configurable Option': distance metric via predicate options

   - 'Probability Estimation': Provides confidence scores for
     predictions

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<76>,  Next: Options<50>,  Prev: Features<54>,  Up: nearest_centroid_classifier

6.145.5 Usage
-------------

* Menu:

* Learning a Classifier: Learning a Classifier<4>.
* Making Predictions: Making Predictions<4>.
* Exporting the Classifier: Exporting the Classifier<4>.
* Using a learned classifier: Using a learned classifier<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a Classifier<4>,  Next: Making Predictions<4>,  Up: Usage<76>

6.145.5.1 Learning a Classifier
...............................

     % Learn from a dataset object with default options (euclidean distance)
     | ?- nearest_centroid_classifier::learn(my_dataset, Classifier).
     ...

     % Learn with custom options
     | ?- nearest_centroid_classifier::learn(my_dataset, Classifier, [distance_metric(manhattan)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Making Predictions<4>,  Next: Exporting the Classifier<4>,  Prev: Learning a Classifier<4>,  Up: Usage<76>

6.145.5.2 Making Predictions
............................

     % Predict class for a new instance
     | ?- Instance = [attr1-value1, attr2-value2, ...],
          nearest_centroid_classifier::learn(my_dataset, Classifier),
          nearest_centroid_classifier::predict(Classifier, Instance, PredictedClass).
     PredictedClass = ...
     ...

     % Predict with custom options
     | ?- nearest_centroid_classifier::predict(Classifier, Instance, PredictedClass, [distance_metric(cosine)]).
     ...

     % Get probability distribution
     | ?- nearest_centroid_classifier::predict_probabilities(Classifier, Instance, Probabilities).
     Probabilities = [class1-0.67, class2-0.33]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the Classifier<4>,  Next: Using a learned classifier<3>,  Prev: Making Predictions<4>,  Up: Usage<76>

6.145.5.3 Exporting the Classifier
..................................

Learned classifiers can be exported as a list of clauses or to a file
for later use.

     % Export as predicate clauses
     | ?- nearest_centroid_classifier::learn(my_dataset, Classifier),
          nearest_centroid_classifier::export_to_clauses(my_dataset, Classifier, my_classifier, Clauses).
     Clauses = [my_classifier(...)]
     ...

     % Export to a file
     | ?- nearest_centroid_classifier::learn(my_dataset, Classifier),
          nearest_centroid_classifier::export_to_file(my_dataset, Classifier, my_classifier, 'classifier.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Using a learned classifier<3>,  Prev: Exporting the Classifier<4>,  Up: Usage<76>

6.145.5.4 Using a learned classifier
....................................

Learned and saved classifiers can later be used for predictions without
needing to access the original training dataset.

     % Later, load the file and use the classifier
     | ?- consult('classifier.pl'),
          my_classifier(AttributeNames, FeatureTypes, Centroids),
          Instance = [...],
          nearest_centroid_classifier::predict(my_classifier(AttributeNames, FeatureTypes, Centroids), Instance, Class).
     Class = ...
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<50>,  Next: Classifier representation<9>,  Prev: Usage<76>,  Up: nearest_centroid_classifier

6.145.6 Options
---------------

The following options can be passed to the ‘predict/4’ and
‘predict_probabilities/4’ predicates:

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default), ‘manhattan’, ‘cosine’


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<9>,  Next: References<38>,  Prev: Options<50>,  Up: nearest_centroid_classifier

6.145.7 Classifier representation
---------------------------------

The learned classifier is represented as a compound term:

     nc_classifier(AttributeNames, FeatureTypes, Centroids)

Where:

   - ‘AttributeNames’: List of attribute names in order

   - ‘FeatureTypes’: List of types (‘numeric’ or ‘categorical’)

   - ‘Centroids’: List of computed ‘Class-Centroid’ pairs

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<38>,  Prev: Classifier representation<9>,  Up: nearest_centroid_classifier

6.145.8 References
------------------

  1. Manning, Raghavan & Schütze (2008) - “Introduction to Information
     Retrieval”.  Cambridge University Press.

  2. Tibshirani, Hastie, Narasimhan & Chu (2002) - “Diagnosis of
     multiple cancer types by shrunken centroids of gene expression”.
     Proceedings of the National Academy of Sciences, 99(10), 6567-6572.

  3. Hastie, Tibshirani & Friedman (2009) - “The Elements of Statistical
     Learning: Data Mining, Inference, and Prediction” (2nd Edition).
     Springer.


File: TheLogtalkHandbook-3.100.1.info,  Node: nested_dictionaries,  Next: Raw Sentence Representation,  Prev: nearest_centroid_classifier,  Up: Libraries

6.146 ‘nested_dictionaries’
===========================

This library provides nested dictionary implementations based on private
extensions to the ‘dictionaries’ library objects.  The representations
of a nested dictionary should be regarded as opaque terms and only
accessed using the library predicates.

This library is experimental, a work in progress, and future versions
can introduce incompatible changes.

* Menu:

* API documentation: API documentation<164>.
* Loading: Loading<166>.
* Testing: Testing<157>.
* Usage: Usage<77>.
* Curly term representation::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<164>,  Next: Loading<166>,  Up: nested_dictionaries

6.146.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#nested-dictionaries’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<166>,  Next: Testing<157>,  Prev: API documentation<164>,  Up: nested_dictionaries

6.146.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(nested_dictionaries(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<157>,  Next: Usage<77>,  Prev: Loading<166>,  Up: nested_dictionaries

6.146.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(nested_dictionaries(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<77>,  Next: Curly term representation,  Prev: Testing<157>,  Up: nested_dictionaries

6.146.4 Usage
-------------

First, select the nested dictionary implementation that you want to use.
For cases where the number of elements is relatively small and
performance is not critical, ‘nbintree’ can be a good choice.  For other
cases, ‘navltree’ or ‘nrbtree’ are likely better choices.  If you want
to compare the performance of the implementations, either define an
object alias or use a ‘uses/2’ directive so that you can switch between
implementations by simply changing the alias definition or the first
argument of the directive.  Note that you can switch between
implementations at runtime without code changes by using a parameter
variable in the first argument of a ‘uses/2’ directive.

To create an empty nested dictionary, you can use the ‘new/1’ predicate.
For example:

     | ?- navltree::new(Dictionary).
     Dictionary = ...
     yes

You can also create a new nested dictionary from a 'curly bracketed term
representation' (see below) by using the predicate
‘as_nested_dictionary/2’.  For example:

     | ?- navltree::as_nested_dictionary(
             {a-1, b-{c-3, d-{e-7,f-8}}},
             Dictionary
          ).

     Dictionary = ...
     yes

Several predicates are provided to insert, lookup, update, and delete
key-value pairs given a list of keys interpreted as an 'access path' to
a nested dictionary.  For example:

     | ?- navltree::as_nested_dictionary(
             {a-1, b-{c-3, d-{e-7,f-8}}},
             Dictionary
          ),
          navltree::lookup_in([b,d,f], Value, Dictionary).

     Dictionary = ...
     Value = 8
     yes

For details on these and other provided predicates, consult the library
API documentation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Curly term representation,  Prev: Usage<77>,  Up: nested_dictionaries

6.146.5 Curly term representation
---------------------------------

To simplify importing and exporting data into a nested dictionary, the
library provides ‘as_nested_dictionary/2’ and ‘as_curly_bracketed/2’
predicates that work with a 'curly term representation'.  This format is
based on the JSON data interchange format.

A dictionary is represented by the ‘{Pairs}’ term where Pairs is a
conjunction of ‘Key-Value’ or ‘Key:Value’ pairs and ‘Value’ can be a
nested dictionary or lists of pairs.  An empty dictionary is represented
using the ‘{}’ term.  the raw parsed term.

   - ‘data/2’ maps supported sentence types into typed semantic terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Raw Sentence Representation,  Next: Typed data/2 Results,  Prev: nested_dictionaries,  Up: Libraries

6.147 Raw Sentence Representation
=================================

Parsed sentences are represented as:

     nmea_sentence(Talker, Type, Fields, checksum(Provided, Computed))

Where:

   - ‘Talker’ is a normalized lowercase talker atom such as ‘gp’ or ‘gn’

   - proprietary ‘$P...’ sentences use the atom ‘proprietary’

   - ‘Type’ is the normalized lowercase sentence type atom

   - ‘Fields’ is the ordered list of field atoms after the sentence
     identifier

   - ‘Provided’ is either a normalized uppercase hexadecimal checksum
     atom or ‘missing’

   - ‘Computed’ is the normalized uppercase hexadecimal checksum atom
     computed from the sentence payload


File: TheLogtalkHandbook-3.100.1.info,  Node: Typed data/2 Results,  Next: Date Rule,  Prev: Raw Sentence Representation,  Up: Libraries

6.148 Typed ‘data/2’ Results
============================

The library currently provides semantic decoding for these sentence
types:

   - ‘gga(Time, Coordinate, fix(FixQuality, SatellitesUsed, HDOP),
     altitude(AntennaAltitudeMeters, GeoidSeparationMeters),
     dgps(DifferentialAgeSeconds, StationId))’

   - ‘rmc(Time, Status, Coordinate, movement(SpeedKnots, CourseDegrees),
     Date, MagneticVariation, Mode)’

   - ‘gsa(SelectionMode, FixType, SatelliteIds, dop(PDOP, HDOP, VDOP),
     SystemId)’

   - ‘gsv(MessageCount, MessageNumber, SatellitesInView, Satellites)’

   - ‘vtg(track(TrueCourseDegrees, MagneticCourseDegrees),
     speed(SpeedKnots, SpeedKph), Mode)’

   - ‘gll(Coordinate, Time, Status, Mode)’

Shared semantic subterms include:

   - ‘geographic(Latitude, Longitude)’

   - ‘utc_time(Hour, Minute, Second, fraction(Numerator, Denominator))’

   - ‘date(Year, Month, Day)’

   - ‘magnetic_variation(Degrees, east|west)’

   - ‘satellite(PRN, ElevationDegrees, AzimuthDegrees, SnrDbHz)’

   - ‘missing’


File: TheLogtalkHandbook-3.100.1.info,  Node: Date Rule,  Next: Current Scope,  Prev: Typed data/2 Results,  Up: Libraries

6.149 Date Rule
===============

Two-digit ‘RMC’ years are expanded using a fixed GPS-era rule:

   - ‘80..99’ map to ‘1980..1999’

   - ‘00..79’ map to ‘2000..2079’


File: TheLogtalkHandbook-3.100.1.info,  Node: Current Scope,  Next: nmf_projection,  Prev: Date Rule,  Up: Libraries

6.150 Current Scope
===================

Implemented in this first version:

   - raw parsing from text sources

   - configurable checksum handling

   - proprietary ‘$P...’ sentence passthrough

   - semantic decoding for ‘GGA’, ‘RMC’, ‘GSA’, ‘GSV’, ‘VTG’, and ‘GLL’

Deliberately out of scope for this first version:

   - sentence generation

   - AIS ‘!’ sentences

   - serial or socket transport helpers

   - corrupted-stream resynchronization

   - ‘GSV’ multi-fragment aggregation

   - typed proprietary sentence decoding


File: TheLogtalkHandbook-3.100.1.info,  Node: nmf_projection,  Next: optics_clusterer,  Prev: Current Scope,  Up: Libraries

6.151 ‘nmf_projection’
======================

This library implements Non-negative Matrix Factorization (NMF) for
continuous datasets whose attribute values are all non-negative.  It
learns a non-negative basis using deterministic multiplicative updates
and represents each transformed instance as a list of non-negative
component weights.

* Menu:

* API documentation: API documentation<165>.
* Loading: Loading<167>.
* Testing: Testing<158>.
* Features: Features<55>.
* Options: Options<51>.
* Usage: Usage<78>.
* Dimension reducer representation: Dimension reducer representation<4>.
* References: References<39>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<165>,  Next: Loading<167>,  Up: nmf_projection

6.151.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#nmf_projection’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<167>,  Next: Testing<158>,  Prev: API documentation<165>,  Up: nmf_projection

6.151.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(nmf_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<158>,  Next: Features<55>,  Prev: Loading<167>,  Up: nmf_projection

6.151.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(nmf_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<55>,  Next: Options<51>,  Prev: Testing<158>,  Up: nmf_projection

6.151.4 Features
----------------

   - Implements deterministic multiplicative-update training for NMF.

   - Requires all training and inference attribute values to be
     non-negative.

   - Supports exporting learned reducers and reloading them for later
     use.

   - Records diagnostics including convergence status, iteration count,
     final update delta, and reconstruction error.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<51>,  Next: Usage<78>,  Prev: Features<55>,  Up: nmf_projection

6.151.5 Options
---------------

   - ‘n_components/1’

     Number of latent components to learn.  The current implementation
     requires the requested count to not exceed the minimum of the
     sample count and the number of features.  Larger requests raise
     ‘domain_error(component_count, Requested-Maximum)’.

   - ‘center/1’

     Always ‘false’.  Centering is intentionally disabled because NMF
     requires non-negative features.

   - ‘feature_scaling/1’

     When ‘true’, each continuous attribute is divided by its maximum
     observed training value.  When ‘false’, raw non-negative values are
     used.

   - ‘maximum_iterations/1’

     Maximum number of multiplicative-update iterations used during both
     training and per-instance coefficient inference.

   - ‘tolerance/1’

     Stop iteration when the maximum absolute update delta is less than
     or equal to this value.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<78>,  Next: Dimension reducer representation<4>,  Prev: Options<51>,  Up: nmf_projection

6.151.6 Usage
-------------

Assuming a dataset object ‘parts_based_measurements’ implementing the
‘dimension_reduction_dataset_protocol’ protocol:

     | ?- nmf_projection::learn(parts_based_measurements, DimensionReducer).

     | ?- nmf_projection::learn(parts_based_measurements, DimensionReducer, [n_components(2), feature_scaling(true), maximum_iterations(250), tolerance(1.0e-7)]).

     | ?- nmf_projection::learn(parts_based_measurements, DimensionReducer),
          nmf_projection::transform(DimensionReducer, [f1-3.0, f2-0.0, f3-1.5, f4-0.0], ReducedInstance).

     | ?- nmf_projection::learn(parts_based_measurements, DimensionReducer, [n_components(2)]),
          nmf_projection::export_to_file(parts_based_measurements, DimensionReducer, reducer, 'nmf_reducer.pl').

     | ?- logtalk_load('nmf_reducer.pl'),
          reducer(Reducer),
          nmf_projection::transform(Reducer, [f1-3.0, f2-0.0, f3-1.5, f4-0.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation<4>,  Next: References<39>,  Prev: Usage<78>,  Up: nmf_projection

6.151.7 Dimension reducer representation
----------------------------------------

Learned NMF reducers use the representation:

     nmf_reducer(Encoders, Components, Diagnostics)

where ‘Encoders’ stores the continuous attribute encoders used to map
instances into a non-negative feature vector, ‘Components’ stores the
learned non-negative basis vectors, and ‘Diagnostics’ stores metadata
about the learned reducer.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<39>,  Prev: Dimension reducer representation<4>,  Up: nmf_projection

6.151.8 References
------------------

   - Daniel D. Lee and H. Sebastian Seung.  'Algorithms for Non-negative
     Matrix Factorization'.  Advances in Neural Information Processing
     Systems 13, 2001.


File: TheLogtalkHandbook-3.100.1.info,  Node: optics_clusterer,  Next: optionals,  Prev: nmf_projection,  Up: Libraries

6.152 ‘optics_clusterer’
========================

OPTICS clusterer.  It uses deterministic OPTICS ordering with
epsilon-based cluster extraction for the fixed clusterer protocol.
Supports continuous attributes only.

The library implements the ‘clusterer_protocol’ defined in the
‘clustering_protocols’ library.  It provides predicates for learning a
clusterer from a dataset, assigning new instances to clusters, and
exporting the learned clusterer as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the
‘clustering_dataset_protocol’ protocol from the ‘clustering_protocols’
library.

* Menu:

* API documentation: API documentation<166>.
* Loading: Loading<168>.
* Testing: Testing<159>.
* Features: Features<56>.
* Options: Options<52>.
* Clusterer representation: Clusterer representation<12>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<166>,  Next: Loading<168>,  Up: optics_clusterer

6.152.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#optics_clusterer’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<168>,  Next: Testing<159>,  Prev: API documentation<166>,  Up: optics_clusterer

6.152.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(optics_clusterer(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<159>,  Next: Features<56>,  Prev: Loading<168>,  Up: optics_clusterer

6.152.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(optics_clusterer(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(optics_clusterer(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<56>,  Next: Options<52>,  Prev: Testing<159>,  Up: optics_clusterer

6.152.4 Features
----------------

   - 'OPTICS Ordering': Learns a deterministic ordering using
     density-based reachability over continuous datasets.

   - 'Adaptive Neighborhood Indexing': Uses a low-dimensional
     epsilon-grid index when it is likely to be cheaper and otherwise
     falls back to a deterministic metric tree for neighborhood search
     during ordering construction.  The search backend can also be
     selected explicitly.

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Distance Metrics': Supports Euclidean and Manhattan distances.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling.

   - 'Epsilon-Based Extraction': Extracts clusters from the ordering
     using a configurable extraction epsilon threshold.

   - 'Noise Detection': New instances not reachable from an extracted
     core cluster within the extraction threshold are assigned to
     ‘noise’.

   - 'Prediction Pruning': Classification reuses per-cluster core-point
     bounds to prune clusters that cannot beat the current best
     reachable match.

   - 'Portable Export': Learned clusterers can be exported as clauses or
     files and reused later.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<52>,  Next: Clusterer representation<12>,  Prev: Features<56>,  Up: optics_clusterer

6.152.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘ordering_and_extraction_epsilons(MaximumOrderingEpsilon,
     ExtractionEpsilon)’: Pair of epsilon thresholds where
     ‘MaximumOrderingEpsilon’ is the neighborhood radius used while
     constructing the OPTICS ordering and ‘ExtractionEpsilon’ is the
     threshold used when extracting clusters from the learned ordering
     and when classifying new instances.  Default is
     ‘ordering_and_extraction_epsilons(1.0, 1.0)’.  ‘ExtractionEpsilon’
     must not be greater than ‘MaximumOrderingEpsilon’.

   - ‘search_index(SearchIndex)’: Search backend selection used while
     constructing the OPTICS ordering.  Options are ‘auto’ (default),
     ‘grid’, and ‘metric_tree’.

   - ‘minimum_points(MinimumPoints)’: Minimum neighborhood size required
     for a point to be considered a core point.  Default is ‘2’.

   - ‘distance_metric(Metric)’: Distance metric to use.  Options:
     ‘euclidean’ (default) or ‘manhattan’.

   - ‘feature_scaling(FeatureScaling)’: Whether to standardize
     continuous attributes before clustering.  Options: ‘on’ (default)
     or ‘off’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Clusterer representation<12>,  Prev: Options<52>,  Up: optics_clusterer

6.152.6 Clusterer representation
--------------------------------

The learned clusterer is represented as a compound term with the functor
chosen by the user when exporting the clusterer and arity 5.  For
example:

     optics_clusterer(Encoders, Ordering, Clusters, Noise, Options)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Ordering’: List of ordered points annotated with reachability and
     core-distance information.

   - ‘Clusters’: List of extracted clusters in cluster-id order.

   - ‘Noise’: List of extracted noise points.

   - ‘Options’: Effective training options used to learn the clusterer.


File: TheLogtalkHandbook-3.100.1.info,  Node: optionals,  Next: options,  Prev: optics_clusterer,  Up: Libraries

6.153 ‘optionals’
=================

This library provides an implementation of 'optional terms' with an API
modeled after the Java 8 ‘Optional’ class (originally due to requests by
users working in Logtalk/Java hybrid applications).  An optional term is
an opaque compound term that may or may not hold a value.  Optional
terms avoid forcing the user to define a representation for the absence
of a value by providing an API with predicates that depend on the
presence or absence of a value.  Optional terms also allow separating
the code that constructs optional terms from the code that processes
them, which is then free to deal if necessary and at its convenience
with any case where the values held by optional terms are not present.

* Menu:

* API documentation: API documentation<167>.
* Loading: Loading<169>.
* Testing: Testing<160>.
* Usage: Usage<79>.
* See also: See also<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<167>,  Next: Loading<169>,  Up: optionals

6.153.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#optionals’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<169>,  Next: Testing<160>,  Prev: API documentation<167>,  Up: optionals

6.153.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(optionals(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<160>,  Next: Usage<79>,  Prev: Loading<169>,  Up: optionals

6.153.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(optionals(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<79>,  Next: See also<3>,  Prev: Testing<160>,  Up: optionals

6.153.4 Usage
-------------

The ‘optional’ object provides constructors for optional terms.  For
example:

     | ?- optional::of(1, Optional).
     ...

The created optional terms can then be passed as parameters to the
‘optional/1’ parametric object.  For example:

     | ?- optional::of(1, Optional), optional(Optional)::or_else(Term, 0).
     Optional = optional(1),
     Term = 1
     yes

     | ?- optional::empty(Optional), optional(Optional)::or_else(Term, 0).
     Optional = empty,
     Term = 0
     yes

The ‘maybe’ object provides types and predicates for type-checking of
the term held by optional terms.  It also provides some predicates for
handling lists of optional terms, including ‘sequence/2’ and
‘traverse/3’.

The ‘optional/1’ parametric object also provides ‘map_or_else/3’ for
applying a closure to the value held by the optional term if not empty,
returning a default value otherwise:

     | ?- optional::of(a, Optional),
          optional(Optional)::map_or_else(char_code, 0, Value).
     Value = 97
     yes

     | ?- optional::empty(Optional),
          optional(Optional)::map_or_else(char_code, 0, Value).
     Value = 0
     yes

The ‘zip/3’ predicate combines two optional terms using a closure when
both are not empty:

     | ?- optional::of(1, O1), optional::of(3, O2),
          optional(O1)::zip([X,Y,Z]>>(Z is X+Y), O2, NewOptional).
     NewOptional = optional(4)
     yes

     | ?- optional::of(1, O1), optional::empty(O2),
          optional(O1)::zip([X,Y,Z]>>(Z is X+Y), O2, NewOptional).
     NewOptional = empty
     yes

The ‘flatten/1’ predicate unwraps a nested optional term:

     | ?- optional::of(1, Inner), optional::of(Inner, Outer),
          optional(Outer)::flatten(NewOptional).
     NewOptional = optional(1)
     yes

     | ?- optional::empty(Inner), optional::of(Inner, Outer),
          optional(Outer)::flatten(NewOptional).
     NewOptional = empty
     yes

The ‘to_expected/2’ predicate converts an optional to an expected term:

     | ?- optional::of(1, Optional),
          optional(Optional)::to_expected(missing, Expected).
     Expected = expected(1)
     yes

     | ?- optional::empty(Optional),
          optional(Optional)::to_expected(missing, Expected).
     Expected = unexpected(missing)
     yes

The ‘from_goal/3’ and ‘from_goal/2’ constructors silently convert goal
exceptions to empty optional terms.  Use ‘from_goal_or_throw/3’ or
‘from_goal_or_throw/2’ if exceptions should be propagated instead:

     | ?- optional::from_goal_or_throw(Y is 1+2, Y, Optional).
     Optional = optional(3)
     yes

     | ?- optional::from_goal_or_throw(2 is 3, _, Optional).
     Optional = empty
     yes

     | ?- catch(
            optional::from_goal_or_throw(Y is _, Y, _),
            Error,
            true
          ).
     Error = error(instantiation_error, ...)
     yes

Examples:

     | ?- optional::of(1, O1), optional::of(2, O2),
          maybe::sequence([O1, O2], Optional).
     Optional = optional([1,2])
     yes

     | ?- maybe::traverse({optional}/[X,O]>>optional::of(X, O), [1,2], Optional).
     Optional = optional([1,2])
     yes

     | ?- maybe::traverse({optional}/[X,O]>>(
            integer(X) -> optional::of(X, O)
          ; optional::empty(O)
          ), [1,a,2], Optional).
     Optional = empty
     yes

     | ?- optional::of(1, O1), optional::empty(O2),
          maybe::sequence([O1, O2], Optional).
     Optional = empty
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: See also<3>,  Prev: Usage<79>,  Up: optionals

6.153.5 See also
----------------

The ‘expecteds’ and ‘validations’ libraries.


File: TheLogtalkHandbook-3.100.1.info,  Node: options,  Next: os,  Prev: optionals,  Up: Libraries

6.154 ‘options’
===============

This library provides useful predicates for managing developer tool and
application options.

* Menu:

* API documentation: API documentation<168>.
* Loading: Loading<170>.
* Testing: Testing<161>.
* Usage: Usage<80>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<168>,  Next: Loading<170>,  Up: options

6.154.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#options’ file in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<170>,  Next: Testing<161>,  Prev: API documentation<168>,  Up: options

6.154.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ utility
file:

     | ?- logtalk_load(options(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<161>,  Next: Usage<80>,  Prev: Loading<170>,  Up: options

6.154.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(options(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<80>,  Prev: Testing<161>,  Up: options

6.154.4 Usage
-------------

The ‘options’ category is usually imported by the root object of the
developer tool or application.  The importing object should define the
‘default_option/1’ predicate and, if option type-checking is required,
the ‘valid_option/1’ predicate must be defined for each option.  This
library requires options to be represented by compound terms where the
functor is the option name (e.g., ‘trim(true)’ or (‘box(0,2)’)).  The
‘option/2-3’ can be used to get or test an option given a list of
options.  When an option appears multiple times in a list, the
‘option/2-3’ predicates get or test the first (leftmost) occurrence.

The library also supports a user-defined ‘fix_option/2’ predicate.  A
usage example is when an option value can be a relative file path that
should be expanded before use.  Another usage example would be
converting from a user-friendly option to a form more suitable for
internal processing.  When a call to the ‘fix_option/2’ predicate fails,
the option is used as-is.

A simple example:

     :- object(foo,
         imports(options)).

         :- uses(type, [
             valid/2
         ]).

         :- public(p/0).
         p :-
             % use default options
             p([]).

         :- public(p/1).
         p(UserOptions) :-
             ^^check_options(UserOptions),
             % construct the full set of options from
             % the user options and the default options
             ^^merge_options(UserOptions, Options),
             ...
             % query an option
             ^^option(baz(Boolean), Options),
             q(Boolean),
             ...

         default_option(baz(true)).
         ...

         valid_option(baz(Boolean)) :-
             valid(boolean, Boolean).
         ...

     :- end_object.

Note that you can use protected or private import of the ‘options’
category if you don’t want to add its public predicates to the object
protocol.


File: TheLogtalkHandbook-3.100.1.info,  Node: os,  Next: partitions,  Prev: options,  Up: Libraries

6.155 ‘os’
==========

This library provides a 'portable' operating-system interface for the
supported backend Prolog compilers.

The ‘os_types’ category defines some useful operating-system types for
type-checking when using with the ‘type’ library object.

* Menu:

* API documentation: API documentation<169>.
* Loading: Loading<171>.
* Testing: Testing<162>.
* Known issues: Known issues<16>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<169>,  Next: Loading<171>,  Up: os

6.155.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#os’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<171>,  Next: Testing<162>,  Prev: API documentation<169>,  Up: os

6.155.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(os(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<162>,  Next: Known issues<16>,  Prev: Loading<171>,  Up: os

6.155.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(os(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<16>,  Prev: Testing<162>,  Up: os

6.155.4 Known issues
--------------------

Some predicates may only be supported by a subset of backend Prolog
compilers on a subset of operating-systems.  They should be used with
care and fully tested in your application domain, as some backend Prolog
compilers have buggy and inconsistent interfaces, notably across
operating-systems.  See the remarks section in the ‘os’ object
documentation for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: partitions,  Next: pattern_mining_protocols,  Prev: os,  Up: Libraries

6.156 ‘partitions’
==================

This library provides predicates for generating and querying set
partitions of lists.  A set partition divides a list into non-empty,
non-overlapping blocks whose union is the original list.  The following
categories of predicates are provided:

   - 'Generation operations' - Predicates for generating all set
     partitions and set partitions with an exact number of blocks.

   - 'Ordering variants' - Predicates that support an additional order
     argument (‘default’ or ‘lexicographic’) for controlling output
     order.

   - 'Distinct-value generation' - Predicates for generating set
     partitions while deduplicating equal-valued partitions after
     canonicalizing block order.

   - 'Indexed access' - Predicates for retrieving partitions and
     distinct partitions by zero-based index and for recovering the
     index of a partition.

   - 'Random selection' - Predicates for selecting random partitions and
     taking random samples, with distinct-value and exact-block-count
     variants.

   - 'Lexicographic stepping' - Predicates for moving to the next or
     previous distinct partition value in lexicographic order.

   - 'Counting operations' - Predicates for counting set partitions and
     distinct set partitions, including exact-block counts.

Base predicates are position-sensitive, matching the existing
combinatorics libraries.  Inputs with repeated values can therefore
yield duplicate-valued partitions.  Distinct predicates collapse those
equal-valued results.

The lexicographic stepping predicates operate on the distinct partition
view, using the same canonical block ordering as the distinct generation
predicates.

The counting predicates are connected to Bell numbers (for all
partitions of an N-element list) and Stirling numbers of the second kind
(for partitions with an exact number of blocks).

Dedicated ‘arrangements’, ‘cartesian_products’, ‘combinations’,
‘derangements’, ‘multisets’, ‘permutations’, and ‘subsequences’
libraries are also available for focused APIs on related operations.

* Menu:

* API documentation: API documentation<170>.
* Loading: Loading<172>.
* Testing: Testing<163>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<170>,  Next: Loading<172>,  Up: partitions

6.156.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#partitions’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<172>,  Next: Testing<163>,  Prev: API documentation<170>,  Up: partitions

6.156.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(partitions(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<163>,  Prev: Loading<172>,  Up: partitions

6.156.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(partitions(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: pattern_mining_protocols,  Next: pca_projection,  Prev: partitions,  Up: Libraries

6.157 ‘pattern_mining_protocols’
================================

This library provides the generic core entities used in the
implementation of machine learning pattern-finding algorithms.
Pattern-mining algorithm implementations typically import the
‘pattern_miner_common’ category, which implements the
‘pattern_miner_protocol’ protocol and provides shared defaults, option
handling, diagnostics accessors, and export helpers.

The family-specific dataset protocols and bundled smoke-test datasets
are provided by the ‘frequent_pattern_mining_protocols’ and
‘sequential_pattern_mining_protocols’ support libraries.

* Menu:

* API documentation: API documentation<171>.
* Loading: Loading<173>.
* Testing: Testing<164>.
* Common options: Common options<2>.
* Diagnostics: Diagnostics<9>.
* Related support libraries::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<171>,  Next: Loading<173>,  Up: pattern_mining_protocols

6.157.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#pattern_mining_protocols’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<173>,  Next: Testing<164>,  Prev: API documentation<171>,  Up: pattern_mining_protocols

6.157.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(pattern_mining_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<164>,  Next: Common options<2>,  Prev: Loading<173>,  Up: pattern_mining_protocols

6.157.3 Testing
---------------

To run the library smoke tests, load the ‘tester.lgt’ file:

     | ?- logtalk_load(pattern_mining_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Common options<2>,  Next: Diagnostics<9>,  Prev: Testing<164>,  Up: pattern_mining_protocols

6.157.4 Common options
----------------------

The ‘pattern_miner_common’ category supports the following options used
by importing pattern miners to control support thresholds and pattern
length filtering:

   - ‘minimum_support(0.5)’ sets the relative minimum support threshold
     as a proportion in the interval ‘]0.0, 1.0]’.

   - ‘minimum_support_count(N)’ sets the absolute minimum support count.
     If both support options are provided, this option takes precedence.

   - ‘maximum_pattern_length(1000)’ sets the maximum pattern length to
     mine.  The effective value is capped by the longest transaction or
     sequence in the dataset.

   - ‘minimum_pattern_length(1)’ sets the minimum pattern length
     retained in the mined result.

The current ‘apriori_pattern_miner’, ‘eclat_pattern_miner’,
‘fp_growth_pattern_miner’, and ‘prefix_span_pattern_miner’ libraries all
use these shared defaults.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<9>,  Next: Related support libraries,  Prev: Common options<2>,  Up: pattern_mining_protocols

6.157.5 Diagnostics
-------------------

The ‘pattern_miner_protocol’ protocol also defines the ‘diagnostics/2’,
‘diagnostic/2’, and ‘pattern_miner_options/2’ predicates.  These expose
representation-independent metadata about mined results.

All pattern miners now provide at least the following generic
diagnostics terms:

   - ‘model(Model)’

   - ‘options(Options)’

   - ‘item_domain_size(Size)’

   - ‘pattern_count(Count)’

   - ‘pattern_length_histogram(Histogram)’

   - ‘support_range(MinimumSupport, MaximumSupport)’

Each miner also provides algorithm-specific diagnostics terms describing
its mining strategy and support representation, such as
candidate-generation style, projected-database growth, closure
filtering, or vertical support layout.


File: TheLogtalkHandbook-3.100.1.info,  Node: Related support libraries,  Prev: Diagnostics<9>,  Up: pattern_mining_protocols

6.157.6 Related support libraries
---------------------------------

   - ‘frequent_pattern_mining_protocols’: Provides the
     ‘transaction_dataset_protocol’ protocol plus bundled transaction
     smoke-test datasets for frequent itemset miners.

   - ‘sequential_pattern_mining_protocols’: Provides the
     ‘sequence_dataset_protocol’ protocol plus bundled sequence
     smoke-test datasets for sequential pattern miners.


File: TheLogtalkHandbook-3.100.1.info,  Node: pca_projection,  Next: permutations,  Prev: pattern_mining_protocols,  Up: Libraries

6.158 ‘pca_projection’
======================

Principal Component Analysis reducer for continuous datasets.  The
library implements the ‘dimension_reducer_protocol’ defined in the
‘dimension_reduction_protocols’ library and learns a linear projection
by centering the training data, optionally standardizing continuous
attributes, computing the covariance matrix, and extracting principal
components using deterministic power iteration with deflation.

* Menu:

* API documentation: API documentation<172>.
* Loading: Loading<174>.
* Testing: Testing<165>.
* Features: Features<57>.
* Options: Options<53>.
* Usage: Usage<81>.
* Dimension reducer representation: Dimension reducer representation<5>.
* References: References<40>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<172>,  Next: Loading<174>,  Up: pca_projection

6.158.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#pca_projection’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<174>,  Next: Testing<165>,  Prev: API documentation<172>,  Up: pca_projection

6.158.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(pca_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<165>,  Next: Features<57>,  Prev: Loading<174>,  Up: pca_projection

6.158.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(pca_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<57>,  Next: Options<53>,  Prev: Testing<165>,  Up: pca_projection

6.158.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.

   - 'Centering and Optional Scaling': Centers all attributes and
     optionally standardizes them before extracting principal
     directions.

   - 'Portable Eigensolver': Uses deterministic power iteration with
     deflation instead of backend-specific linear algebra libraries.

   - 'Projection API': Transforms a new instance into a list of
     ‘component_N-Value’ pairs.

   - 'Model Export': Learned reducers can be exported as predicate
     clauses or written to a file.

   - 'Missing Values': Missing or nonnumeric values are rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<53>,  Next: Usage<81>,  Prev: Features<57>,  Up: pca_projection

6.158.5 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘n_components/1’: Number of principal components to extract.
     Requests that exceed the number of features raise
     ‘domain_error(component_count, Requested-Maximum)’.  The default is
     ‘2’.

   - ‘feature_scaling/1’: Whether to standardize continuous attributes
     before extracting components.  Options: ‘true’ (default) or
     ‘false’.

   - ‘maximum_iterations/1’: Maximum number of power-iteration steps
     used when estimating each principal direction.  The default is
     ‘1000’.

   - ‘tolerance/1’: Positive convergence tolerance used both for
     power-iteration stopping and for deciding when deflated eigenvalues
     are negligible.  The default is ‘1.0e-8’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<81>,  Next: Dimension reducer representation<5>,  Prev: Options<53>,  Up: pca_projection

6.158.6 Usage
-------------

The following examples use the sample datasets shipped with the
‘dimension_reduction_protocols’ library:

     | ?- logtalk_load(dimension_reduction_protocols('test_datasets/correlated_plane')),
          logtalk_load(dimension_reduction_protocols('test_datasets/high_dimensional_measurements')).

* Menu:

* Learning a reducer: Learning a reducer<4>.
* Transforming new instances: Transforming new instances<4>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a reducer<4>,  Next: Transforming new instances<4>,  Up: Usage<81>

6.158.6.1 Learning a reducer
............................

     | ?- pca_projection::learn(correlated_plane, DimensionReducer).

     | ?- pca_projection::learn(correlated_plane, DimensionReducer, [n_components(1), feature_scaling(false), maximum_iterations(200), tolerance(1.0e-7)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transforming new instances<4>,  Next: Exporting and reusing the reducer<4>,  Prev: Learning a reducer<4>,  Up: Usage<81>

6.158.6.2 Transforming new instances
....................................

     | ?- pca_projection::learn(high_dimensional_measurements, DimensionReducer),
          pca_projection::transform(DimensionReducer, [f1-0.9, f2-1.1, f3-1.0, f4-2.0, f5-2.2, f6-2.1], ReducedInstance).

     | ?- pca_projection::learn(correlated_plane, DimensionReducer, [n_components(1)]),
          pca_projection::transform(DimensionReducer, [x-1.0, y-2.0, z-3.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting and reusing the reducer<4>,  Prev: Transforming new instances<4>,  Up: Usage<81>

6.158.6.3 Exporting and reusing the reducer
...........................................

     | ?- pca_projection::learn(correlated_plane, DimensionReducer, [n_components(1)]),
          pca_projection::export_to_file(correlated_plane, DimensionReducer, reducer, 'pca_reducer.pl').

     | ?- logtalk_load('pca_reducer.pl'),
          reducer(Reducer),
          pca_projection::transform(Reducer, [x-1.0, y-2.0, z-3.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation<5>,  Next: References<40>,  Prev: Usage<81>,  Up: pca_projection

6.158.7 Dimension reducer representation
----------------------------------------

The learned dimension reducer is represented by a compound term with the
functor chosen by the implementation and arity 4.  For example:

     pca_reducer(Encoders, Components, ExplainedVariances, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Components’: List of principal direction vectors in descending
     variance order.

   - ‘ExplainedVariances’: List of eigenvalues matching the extracted
     components.

   - ‘Diagnostics’: Learned reducer metadata including the effective
     training options and learned model details.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
reducer term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<40>,  Prev: Dimension reducer representation<5>,  Up: pca_projection

6.158.8 References
------------------

  1. Pearson, K. (1901) - “On lines and planes of closest fit to systems
     of points in space”.

  2. Hotelling, H. (1933) - “Analysis of a complex of statistical
     variables into principal components”.


File: TheLogtalkHandbook-3.100.1.info,  Node: permutations,  Next: plackett_luce_ranker,  Prev: pca_projection,  Up: Libraries

6.159 ‘permutations’
====================

This library provides predicates for generating and querying
permutations over lists.  The following categories of predicates are
provided:

   - 'Generation operations' - Predicates for generating permutations
     and k-permutations.

   - 'Ordering variants' - Predicates that support an additional order
     argument (‘default’, ‘lexicographic’, or ‘shortlex’) for
     controlling output order.

   - 'Distinct-value generation' - Predicates for generating
     permutations while deduplicating equal-valued results.

   - 'Lexicographic stepping' - Predicates for navigating permutations
     in lexicographic order.

   - 'Indexed access' - Predicates for direct access to permutations at
     specific positions, including distinct permutations.

   - 'Counting operations' - Predicates for counting permutations and
     distinct permutations.

   - 'Random selection' - Predicates for randomly selecting and sampling
     permutations and distinct permutations.

Dedicated ‘arrangements’, ‘cartesian_products’, ‘combinations’,
‘derangements’, ‘multisets’, ‘partitions’, and ‘subsequences’ libraries
are also available for focused APIs on related operations.  The
‘arrangements’ library is the repetition-allowed counterpart to this
library.

* Menu:

* API documentation: API documentation<173>.
* Loading: Loading<175>.
* Testing: Testing<166>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<173>,  Next: Loading<175>,  Up: permutations

6.159.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#permutations’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<175>,  Next: Testing<166>,  Prev: API documentation<173>,  Up: permutations

6.159.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(permutations(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<166>,  Prev: Loading<175>,  Up: permutations

6.159.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(permutations(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: plackett_luce_ranker,  Next: plackett_luce_last_ranker,  Prev: permutations,  Up: Libraries

6.160 ‘plackett_luce_ranker’
============================

Tie-aware Plackett-Luce grouped-ranking ranker.  It processes each group
as a sequence of top-choice selections from highest relevance to lowest
relevance, using grouped tie blocks and a deterministic fixed-point
update on positive item strengths.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from grouped rankings, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘ranking_dataset_protocol’ protocol from the ‘ranking_protocols’
library.  See the ‘test_datasets’ directory for examples.  The training
dataset must declare each group once, use only declared groups and items
in relevance judgments, assign non-negative integer relevance values,
and induce a strongly connected directed strict-order graph across
groups so that a finite Plackett-Luce maximum-likelihood estimate
exists.

* Menu:

* API documentation: API documentation<174>.
* Loading: Loading<176>.
* Testing: Testing<167>.
* Features: Features<58>.
* Dataset requirements: Dataset requirements<2>.
* Usage: Usage<82>.
* Diagnostics syntax: Diagnostics syntax<17>.
* Options: Options<54>.
* Ranker representation: Ranker representation<11>.
* See also: See also<4>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<174>,  Next: Loading<176>,  Up: plackett_luce_ranker

6.160.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#plackett_luce_ranker’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<176>,  Next: Testing<167>,  Prev: API documentation<174>,  Up: plackett_luce_ranker

6.160.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(plackett_luce_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<167>,  Next: Features<58>,  Prev: Loading<176>,  Up: plackett_luce_ranker

6.160.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(plackett_luce_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<58>,  Next: Dataset requirements<2>,  Prev: Testing<167>,  Up: plackett_luce_ranker

6.160.4 Features
----------------

   - 'Grouped Top-Choice Learning': Learns positive item strengths from
     grouped rankings by processing each group from highest relevance to
     lowest relevance.

   - 'Tie-Aware Likelihood': Uses grouped tie blocks so equal relevance
     judgments are handled as unordered top-choice blocks instead of
     being broken arbitrarily.  Each tie block contributes a
     size-constrained choice likelihood term against the remaining
     lower-relevance items.

   - 'Deterministic Ranking': Orders candidate items by learned strength
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects malformed grouped datasets,
     unsupported options, duplicate candidates, and invalid ranker
     terms.

   - 'Regular MLE Fidelity': Rejects grouped datasets whose strict-order
     graph does not admit a finite Plackett-Luce maximum-likelihood
     estimate instead of masking non-identifiability with implicit
     regularization.

   - 'Missing relevance semantics': Missing relevance facts are treated
     as zero by default using the ‘missing_relevance(zero)’ option and
     can be rejected using the ‘missing_relevance(error)’ option.

   - 'Training Diagnostics': Learned rankers include convergence,
     iteration, final update delta, and dataset summary metadata
     accessible using the ‘diagnostics/2’ predicate.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Grouped Infrastructure': Reuses the shared grouped
     tie-block representation and iterative positive-strength
     scaffolding from the ‘ranking_protocols’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dataset requirements<2>,  Next: Usage<82>,  Prev: Features<58>,  Up: plackett_luce_ranker

6.160.5 Dataset requirements
----------------------------

This implementation requires more than grouped-dataset well-formedness.
In order to admit a finite Plackett-Luce maximum-likelihood estimate,
the directed strict-order graph induced by the grouped rankings must be
strongly connected.  Intuitively, no partition of the items may dominate
all others in only one direction across the observed groups.

Unlike ‘borda_ranker’, this model therefore rejects grouped datasets
that consist of disconnected query universes or one-way dominance
chains, because those data do not identify a finite global strength
scale.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<82>,  Next: Diagnostics syntax<17>,  Prev: Dataset requirements<2>,  Up: plackett_luce_ranker

6.160.6 Usage
-------------

* Menu:

* Learning a ranker: Learning a ranker<11>.
* Inspecting diagnostics: Inspecting diagnostics<9>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<11>,  Next: Inspecting diagnostics<9>,  Up: Usage<82>

6.160.6.1 Learning a ranker
...........................

     % Learn from a grouped ranking dataset object
     | ?- plackett_luce_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with custom iteration and missing-relevance options
     | ?- plackett_luce_ranker::learn(my_dataset, Ranker, [maximum_iterations(500), tolerance(1.0e-7), missing_relevance(error)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<9>,  Prev: Learning a ranker<11>,  Up: Usage<82>

6.160.6.2 Inspecting diagnostics
................................

     % Inspect convergence and dataset summary metadata
     | ?- plackett_luce_ranker::learn(my_dataset, Ranker),
          plackett_luce_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<17>,  Next: Options<54>,  Prev: Usage<82>,  Up: plackett_luce_ranker

6.160.7 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(plackett_luce_ranker),
         options(Options),
         convergence(Status),
         iterations(Iterations),
         final_delta(FinalDelta),
         dataset_summary(DatasetSummary)
     ]

Where:

   - ‘model(plackett_luce_ranker)’ identifies the learning algorithm
     that produced the ranker.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘convergence(Status)’ records the training stop condition.  The
     current values are ‘converged’ and ‘maximum_iterations_exhausted’.

   - ‘iterations(Iterations)’ stores the number of update iterations
     that were executed.

   - ‘final_delta(FinalDelta)’ stores the maximum absolute strength
     update in the last iteration.

   - ‘dataset_summary(DatasetSummary)’ stores a summary list describing
     the validated training dataset.

Use the ‘ranking_protocols’ ‘diagnostic/2’ and ‘ranker_options/2’ helper
predicates when you only need a single metadata term or the effective
options.

* Menu:

* Ranking candidate items: Ranking candidate items<10>.
* Exporting the ranker: Exporting the ranker<9>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<10>,  Next: Exporting the ranker<9>,  Up: Diagnostics syntax<17>

6.160.7.1 Ranking candidate items
.................................

     % Rank a candidate set from most preferred to least preferred
     | ?- plackett_luce_ranker::learn(my_dataset, Ranker),
          plackett_luce_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<9>,  Prev: Ranking candidate items<10>,  Up: Diagnostics syntax<17>

6.160.7.2 Exporting the ranker
..............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- plackett_luce_ranker::learn(my_dataset, Ranker),
          plackett_luce_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(plackett_luce_ranker(...))]
     ...

     % Export to a file
     | ?- plackett_luce_ranker::learn(my_dataset, Ranker),
          plackett_luce_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<54>,  Next: Ranker representation<11>,  Prev: Diagnostics syntax<17>,  Up: plackett_luce_ranker

6.160.8 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘maximum_iterations(MaximumIterations)’: Positive integer iteration
     bound.

   - ‘tolerance(Tolerance)’: Positive convergence tolerance.

   - ‘missing_relevance(zero|error)’: Policy used when a declared item
     in a group has no explicit relevance judgment.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<11>,  Next: See also<4>,  Prev: Options<54>,  Up: plackett_luce_ranker

6.160.9 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     plackett_luce_ranker(Items, Strengths, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of normalized ‘Item-Strength’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, convergence status, iteration count, final update delta,
     and dataset summary.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
ranker term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: See also<4>,  Prev: Ranker representation<11>,  Up: plackett_luce_ranker

6.160.10 See also
-----------------

For the complementary grouped last-choice variant over the same dataset
protocol, see the ‘plackett_luce_last_ranker’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: plackett_luce_last_ranker,  Next: pls_projection,  Prev: plackett_luce_ranker,  Up: Libraries

6.161 ‘plackett_luce_last_ranker’
=================================

Tie-aware Plackett-Luce-last grouped-ranking ranker.  It processes each
group as a sequence of last-choice eliminations from lowest relevance to
highest relevance, using grouped tie blocks and a deterministic
fixed-point update on positive item strengths.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from grouped rankings, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘ranking_dataset_protocol’ protocol from the ‘ranking_protocols’
library.  See the ‘test_datasets’ directory for examples.  The training
dataset must declare each group once, use only declared groups and items
in relevance judgments, assign non-negative integer relevance values,
and induce a strongly connected directed strict-order graph across
groups so that a finite Plackett-Luce-last maximum-likelihood estimate
exists.

* Menu:

* API documentation: API documentation<175>.
* Loading: Loading<177>.
* Testing: Testing<168>.
* Features: Features<59>.
* Dataset requirements: Dataset requirements<3>.
* Usage: Usage<83>.
* Diagnostics syntax: Diagnostics syntax<18>.
* Options: Options<55>.
* Ranker representation: Ranker representation<12>.
* See also: See also<5>.
* References: References<41>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<175>,  Next: Loading<177>,  Up: plackett_luce_last_ranker

6.161.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#plackett_luce_last_ranker’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<177>,  Next: Testing<168>,  Prev: API documentation<175>,  Up: plackett_luce_last_ranker

6.161.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(plackett_luce_last_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<168>,  Next: Features<59>,  Prev: Loading<177>,  Up: plackett_luce_last_ranker

6.161.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(plackett_luce_last_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<59>,  Next: Dataset requirements<3>,  Prev: Testing<168>,  Up: plackett_luce_last_ranker

6.161.4 Features
----------------

   - 'Grouped Last-Choice Learning': Learns positive item strengths from
     grouped rankings by processing each group from lowest relevance to
     highest relevance.

   - 'Tie-Aware Likelihood': Uses grouped tie blocks so equal relevance
     judgments are handled as unordered last-choice blocks instead of
     being broken arbitrarily.  Each tie block contributes a
     size-constrained last-choice likelihood term against the remaining
     higher-relevance items.

   - 'Deterministic Ranking': Orders candidate items by learned strength
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects malformed grouped datasets,
     unsupported options, duplicate candidates, and invalid ranker
     terms.

   - 'Regular MLE Fidelity': Rejects grouped datasets whose strict-order
     graph does not admit a finite Plackett-Luce-last maximum-likelihood
     estimate instead of masking non-identifiability with implicit
     regularization.

   - 'Missing relevance semantics': Missing relevance facts are treated
     as zero by default using the ‘missing_relevance(zero)’ option and
     can be rejected using ‘missing_relevance(error)’.

   - 'Training Diagnostics': Learned rankers include convergence,
     iteration, final update delta, and dataset summary metadata
     accessible using the ‘diagnostics/2’ predicate.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Grouped Infrastructure': Reuses the shared grouped
     tie-block representation and iterative positive-strength
     scaffolding from the ‘ranking_protocols’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dataset requirements<3>,  Next: Usage<83>,  Prev: Features<59>,  Up: plackett_luce_last_ranker

6.161.5 Dataset requirements
----------------------------

This implementation requires more than grouped-dataset well-formedness.
In order to admit a finite Plackett-Luce-last maximum-likelihood
estimate, the directed strict-order graph induced by the grouped
rankings must be strongly connected.  Intuitively, no partition of the
items may dominate all others in only one direction across the observed
groups.

Unlike ‘borda_ranker’, this model therefore rejects grouped datasets
that consist of disconnected query universes or one-way dominance
chains, because those data do not identify a finite global strength
scale.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<83>,  Next: Diagnostics syntax<18>,  Prev: Dataset requirements<3>,  Up: plackett_luce_last_ranker

6.161.6 Usage
-------------

* Menu:

* Learning a ranker: Learning a ranker<12>.
* Inspecting diagnostics: Inspecting diagnostics<10>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<12>,  Next: Inspecting diagnostics<10>,  Up: Usage<83>

6.161.6.1 Learning a ranker
...........................

     % Learn from a grouped ranking dataset object
     | ?- plackett_luce_last_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with custom iteration and missing-relevance options
     | ?- plackett_luce_last_ranker::learn(my_dataset, Ranker, [maximum_iterations(500), tolerance(1.0e-7), missing_relevance(error)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<10>,  Prev: Learning a ranker<12>,  Up: Usage<83>

6.161.6.2 Inspecting diagnostics
................................

     % Inspect convergence and dataset summary metadata
     | ?- plackett_luce_last_ranker::learn(my_dataset, Ranker),
          plackett_luce_last_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<18>,  Next: Options<55>,  Prev: Usage<83>,  Up: plackett_luce_last_ranker

6.161.7 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(plackett_luce_last_ranker),
         options(Options),
         convergence(Status),
         iterations(Iterations),
         final_delta(FinalDelta),
         dataset_summary(DatasetSummary)
     ]

Where:

   - ‘model(plackett_luce_last_ranker)’ identifies the learning
     algorithm that produced the ranker.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘convergence(Status)’ records the training stop condition.  The
     current values are ‘converged’ and ‘maximum_iterations_exhausted’.

   - ‘iterations(Iterations)’ stores the number of update iterations
     that were executed.

   - ‘final_delta(FinalDelta)’ stores the maximum absolute strength
     update in the last iteration.

   - ‘dataset_summary(DatasetSummary)’ stores a summary list describing
     the validated training dataset.

Use the ‘ranking_protocols’ ‘diagnostic/2’ and ‘ranker_options/2’ helper
predicates when you only need a single metadata term or the effective
options.

* Menu:

* Ranking candidate items: Ranking candidate items<11>.
* Exporting the ranker: Exporting the ranker<10>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<11>,  Next: Exporting the ranker<10>,  Up: Diagnostics syntax<18>

6.161.7.1 Ranking candidate items
.................................

     % Rank a candidate set from most preferred to least preferred
     | ?- plackett_luce_last_ranker::learn(my_dataset, Ranker),
          plackett_luce_last_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<10>,  Prev: Ranking candidate items<11>,  Up: Diagnostics syntax<18>

6.161.7.2 Exporting the ranker
..............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- plackett_luce_last_ranker::learn(my_dataset, Ranker),
          plackett_luce_last_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(plackett_luce_last_ranker(...))]
     ...

     % Export to a file
     | ?- plackett_luce_last_ranker::learn(my_dataset, Ranker),
          plackett_luce_last_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<55>,  Next: Ranker representation<12>,  Prev: Diagnostics syntax<18>,  Up: plackett_luce_last_ranker

6.161.8 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘maximum_iterations(MaximumIterations)’: Positive integer iteration
     bound.

   - ‘tolerance(Tolerance)’: Positive convergence tolerance.

   - ‘missing_relevance(zero|error)’: Policy used when a declared item
     in a group has no explicit relevance judgment.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<12>,  Next: See also<5>,  Prev: Options<55>,  Up: plackett_luce_last_ranker

6.161.9 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     plackett_luce_last_ranker(Items, Strengths, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of normalized ‘Item-Strength’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, convergence status, iteration count, final update delta,
     and dataset summary.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
ranker term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: See also<5>,  Next: References<41>,  Prev: Ranker representation<12>,  Up: plackett_luce_last_ranker

6.161.10 See also
-----------------

For the complementary grouped top-choice variant over the same dataset
protocol, see the ‘plackett_luce_ranker’ library.  For a deterministic
non-probabilistic grouped-ranking baseline over the same dataset
protocol, see the ‘borda_ranker’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<41>,  Prev: See also<5>,  Up: plackett_luce_last_ranker

6.161.11 References
-------------------

  1. Plackett, R. L. (1975).  The analysis of permutations.  'Applied
     Statistics', 24(2), 193-202.

  2. Luce, R. D. (1959).  'Individual Choice Behavior: A Theoretical
     Analysis'.  Wiley.

  3. Hunter, D. R. (2004).  MM algorithms for generalized Bradley-Terry
     models.  'The Annals of Statistics', 32(1), 384-406.


File: TheLogtalkHandbook-3.100.1.info,  Node: pls_projection,  Next: prefix_span_pattern_miner,  Prev: plackett_luce_last_ranker,  Up: Libraries

6.162 ‘pls_projection’
======================

Partial Least Squares projection reducer for target-valued continuous
datasets.  The library implements the ‘dimension_reducer_protocol’
defined in the ‘dimension_reduction_protocols’ library and learns a
deterministic PLS1 projection by centering the training data, optionally
standardizing continuous attributes, centering the numeric target,
extracting latent directions using repeated cross-covariance
maximization with sequential deflation, and storing the resulting direct
projection rotations for future transforms.

Requires a dataset implementing
‘target_supervised_dimension_reduction_dataset_protocol’ and therefore
uses a numeric target during training.

* Menu:

* API documentation: API documentation<176>.
* Loading: Loading<178>.
* Testing: Testing<169>.
* Features: Features<60>.
* Options: Options<56>.
* Usage: Usage<84>.
* Dimension reducer representation: Dimension reducer representation<6>.
* References: References<42>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<176>,  Next: Loading<178>,  Up: pls_projection

6.162.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#pls_projection’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<178>,  Next: Testing<169>,  Prev: API documentation<176>,  Up: pls_projection

6.162.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(pls_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<169>,  Next: Features<60>,  Prev: Loading<178>,  Up: pls_projection

6.162.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(pls_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<60>,  Next: Options<56>,  Prev: Testing<169>,  Up: pls_projection

6.162.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes and rejects datasets that also declare the target name
     as an input feature.  Missing or nonnumeric values are also
     rejected.

   - 'Target-Supervised Learning': Uses a numeric target attribute
     declared by datasets implementing
     ‘target_supervised_dimension_reduction_dataset_protocol’.

   - 'Centering and Optional Scaling': Centers all attributes and
     optionally standardizes them before learning latent directions.

   - 'Deterministic Components': Learns components deterministically
     from feature-target cross-covariance without stochastic
     initialization.

   - 'Configurable Shortfall Handling': Lets callers choose whether an
     extraction shortfall raises an error or truncates the learned
     reducer with explicit diagnostics.

   - 'Projection API': Transforms a new instance into a list of
     ‘component_N-Value’ pairs using the learned direct PLS rotation
     vectors.

   - 'Model Export': Learned reducers can be exported as predicate
     clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<56>,  Next: Usage<84>,  Prev: Features<60>,  Up: pls_projection

6.162.5 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘n_components/1’: Number of latent PLS components to extract.
     Requests that exceed ‘min(FeatureCount, SampleCount - 1)’ raise
     ‘domain_error(component_count, Requested-Maximum)’.  The default is
     ‘2’.

   - ‘feature_scaling/1’: Whether to standardize continuous attributes
     before projection.  Options: ‘true’ (default) or ‘false’.

   - ‘shortfall_policy/1’: Controls what happens when residual
     feature-target cross-covariance becomes negligible before all
     requested components are extracted.  Options: ‘truncate’ (default),
     which returns a reducer with fewer components and records a
     ‘shortfall(truncated(Requested, Learned, ScoreEnergy, Tolerance))’
     diagnostic, or ‘error’, which raises ‘domain_error(component_count,
     Requested-Learned)’.

   - ‘tolerance/1’: Positive numerical tolerance used to stop extracting
     components when the residual feature-target cross-covariance
     becomes negligible.  The default is ‘1.0e-8’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<84>,  Next: Dimension reducer representation<6>,  Prev: Options<56>,  Up: pls_projection

6.162.6 Usage
-------------

The following example uses the sample target-valued dataset shipped with
the ‘dimension_reduction_protocols’ library:

     | ?- logtalk_load(dimension_reduction_protocols('test_datasets/target_latent_measurements')).

* Menu:

* Learning a reducer: Learning a reducer<5>.
* Transforming new instances: Transforming new instances<5>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a reducer<5>,  Next: Transforming new instances<5>,  Up: Usage<84>

6.162.6.1 Learning a reducer
............................

     | ?- pls_projection::learn(target_latent_measurements, DimensionReducer).

     | ?- pls_projection::learn(target_latent_measurements, DimensionReducer, [n_components(1), feature_scaling(false)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transforming new instances<5>,  Next: Exporting and reusing the reducer<5>,  Prev: Learning a reducer<5>,  Up: Usage<84>

6.162.6.2 Transforming new instances
....................................

     | ?- pls_projection::learn(target_latent_measurements, DimensionReducer, [n_components(2)]),
          pls_projection::transform(DimensionReducer, [f1-4.0, f2-8.0, f3-2.0, f4-(-2.0)], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting and reusing the reducer<5>,  Prev: Transforming new instances<5>,  Up: Usage<84>

6.162.6.3 Exporting and reusing the reducer
...........................................

     | ?- pls_projection::learn(target_latent_measurements, DimensionReducer, [n_components(2)]),
          pls_projection::export_to_file(target_latent_measurements, DimensionReducer, reducer, 'pls_projection_reducer.pl').

     | ?- logtalk_load('pls_projection_reducer.pl'),
          reducer(Reducer),
          pls_projection::transform(Reducer, [f1-4.0, f2-8.0, f3-2.0, f4-(-2.0)], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation<6>,  Next: References<42>,  Prev: Usage<84>,  Up: pls_projection

6.162.7 Dimension reducer representation
----------------------------------------

The learned dimension reducer is represented by a compound term with the
functor chosen by the implementation and arity 3.  For example:

     pls_projection_reducer(Encoders, Rotations, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Rotations’: List of direct PLS projection vectors derived from the
     learned latent weights and loadings.

   - ‘Diagnostics’: Learned metadata including the effective training
     options, target information, target loadings, and optional
     truncate-mode shortfall details.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
reducer term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<42>,  Prev: Dimension reducer representation<6>,  Up: pls_projection

6.162.8 References
------------------

  1. Wold, H. (1975) - “Soft modelling by latent variables; the
     nonlinear iterative partial least squares (NIPALS) approach”.

  2. Geladi, P. and Kowalski, B. R. (1986) - “Partial least-squares
     regression: a tutorial”.


File: TheLogtalkHandbook-3.100.1.info,  Node: prefix_span_pattern_miner,  Next: probabilistic_pca_projection,  Prev: pls_projection,  Up: Libraries

6.163 ‘prefix_span_pattern_miner’
=================================

PrefixSpan sequential pattern miner for sequence datasets.  The library
depends on the ‘sequential_pattern_mining_protocols’ support library,
implements the generic ‘pattern_miner_protocol’ defined in the
‘pattern_mining_protocols’ core library, and mines frequent sequential
patterns using recursive projected databases with both same-event and
next-event extensions.

Requires a dataset implementing ‘sequence_dataset_protocol’ with
sequences represented as ordered lists of canonical sorted itemsets over
a declared item domain.

* Menu:

* API documentation: API documentation<177>.
* Loading: Loading<179>.
* Testing: Testing<170>.
* Features: Features<61>.
* Options: Options<57>.
* Pattern miner representation: Pattern miner representation<6>.
* References: References<43>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<177>,  Next: Loading<179>,  Up: prefix_span_pattern_miner

6.163.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#prefix_span_pattern_miner’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<179>,  Next: Testing<170>,  Prev: API documentation<177>,  Up: prefix_span_pattern_miner

6.163.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(prefix_span_pattern_miner(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<170>,  Next: Features<61>,  Prev: Loading<179>,  Up: prefix_span_pattern_miner

6.163.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(prefix_span_pattern_miner(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<61>,  Next: Options<57>,  Prev: Testing<170>,  Up: prefix_span_pattern_miner

6.163.4 Features
----------------

   - 'Projected Database Mining': Mines sequential patterns by
     recursively projecting suffix databases.

   - 'Itemset and Sequence Extensions': Supports both extending the last
     itemset and appending a new singleton itemset.

   - 'Canonical Sequences': Validates that itemsets are sorted,
     duplicate-free, non-empty, and restricted to declared items.

   - 'Flexible Support Thresholds': Supports minimum support specified
     either as a relative proportion or as an absolute count.

   - 'Model Export': Mined pattern collections can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<57>,  Next: Pattern miner representation<6>,  Prev: Features<61>,  Up: prefix_span_pattern_miner

6.163.5 Options
---------------

The ‘mine/3’ predicate accepts the following options:

   - ‘minimum_support/1’: Relative minimum support threshold in the
     interval ‘]0.0, 1.0]’.  The default is ‘0.5’.

   - ‘minimum_support_count/1’: Absolute minimum support count.  When
     both support options are provided, this option takes precedence.

   - ‘maximum_pattern_length/1’: Maximum total number of items in a
     mined sequential pattern.  The default is ‘1000’, effectively
     capped by the longest sequence in the dataset.

   - ‘minimum_pattern_length/1’: Minimum total number of items retained
     in the mined result.  The default is ‘1’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pattern miner representation<6>,  Next: References<43>,  Prev: Options<57>,  Up: prefix_span_pattern_miner

6.163.6 Pattern miner representation
------------------------------------

The mined pattern miner result is represented by a compound term with
the functor chosen by the implementation and arity 3.  For example:

     prefix_span_pattern_miner(ItemDomain, Patterns, Options)

Where:

   - ‘ItemDomain’: Canonical sorted list of declared dataset items.

   - ‘Patterns’: List of ‘sequence_pattern(Pattern, SupportCount)’ terms
     ordered first by total item count and then lexicographically.

   - ‘Options’: Effective mining options used to mine the frequent
     sequential patterns.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<43>,  Prev: Pattern miner representation<6>,  Up: prefix_span_pattern_miner

6.163.7 References
------------------

  1. Pei, J., Han, J., Mortazavi-Asl, B., et al.  (2001) - “PrefixSpan:
     Mining sequential patterns efficiently by prefix-projected pattern
     growth”.


File: TheLogtalkHandbook-3.100.1.info,  Node: probabilistic_pca_projection,  Next: process,  Prev: prefix_span_pattern_miner,  Up: Libraries

6.164 ‘probabilistic_pca_projection’
====================================

Probabilistic Principal Component Analysis reducer for continuous
datasets.  The library implements the ‘dimension_reducer_protocol’
defined in the ‘dimension_reduction_protocols’ library and learns a
linear latent-variable projection by centering the training data,
optionally standardizing continuous attributes, estimating the sample
covariance matrix, extracting deterministic leading eigenvectors using
portable power iteration with deflation, and converting them into the
closed-form maximum-likelihood PPCA loading matrix and posterior latent
projection.

* Menu:

* API documentation: API documentation<178>.
* Loading: Loading<180>.
* Testing: Testing<171>.
* Features: Features<62>.
* Options: Options<58>.
* Usage: Usage<85>.
* Dimension reducer representation: Dimension reducer representation<7>.
* References: References<44>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<178>,  Next: Loading<180>,  Up: probabilistic_pca_projection

6.164.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#probabilistic_pca_projection’
link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<180>,  Next: Testing<171>,  Prev: API documentation<178>,  Up: probabilistic_pca_projection

6.164.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(probabilistic_pca_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<171>,  Next: Features<62>,  Prev: Loading<180>,  Up: probabilistic_pca_projection

6.164.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(probabilistic_pca_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<62>,  Next: Options<58>,  Prev: Testing<171>,  Up: probabilistic_pca_projection

6.164.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.  Missing or nonnumeric values are rejected.

   - 'Centering and Optional Scaling': Centers all attributes and
     optionally standardizes them before fitting the covariance model.

   - 'Probabilistic Latent Model': Estimates the PPCA loading matrix and
     isotropic observation noise variance from the learned covariance
     eigensystem.

   - 'Configurable Shortfall Handling': Lets callers choose whether a
     numerical-rank shortfall raises an error or returns a truncated
     reducer with explicit diagnostics.

   - 'Projection API': Transforms a new instance into posterior latent
     means returned as ‘component_N-Value’ pairs.

   - 'Model Export': Learned reducers can be exported as predicate
     clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<58>,  Next: Usage<85>,  Prev: Features<62>,  Up: probabilistic_pca_projection

6.164.5 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘n_components/1’: Number of latent dimensions to extract.  Requests
     that exceed the structural PPCA limit ‘min(FeatureCount,
     SampleCount - 1)’ raise ‘domain_error(component_count,
     Requested-Maximum)’.  The default is ‘2’.

   - ‘feature_scaling/1’: Whether to standardize continuous attributes
     before fitting the covariance model.  Options: ‘true’ (default) or
     ‘false’.

   - ‘shortfall_policy/1’: Controls what happens when the covariance
     matrix yields fewer numerically significant components than
     requested after passing the structural PPCA bound above.  Options:
     ‘truncate’ (default), which returns a reducer with fewer components
     and records a ‘shortfall(truncated(Requested, Learned,
     ResidualEigenvalue, Tolerance))’ diagnostic, or ‘error’, which
     raises ‘domain_error(component_count, Requested-Learned)’.

   - ‘maximum_iterations/1’: Maximum number of power-iteration steps
     used when estimating each covariance eigenvector.  The default is
     ‘1000’.

   - ‘tolerance/1’: Positive convergence tolerance used both for
     power-iteration stopping and for deciding when residual eigenvalues
     are negligible.  The default is ‘1.0e-8’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<85>,  Next: Dimension reducer representation<7>,  Prev: Options<58>,  Up: probabilistic_pca_projection

6.164.6 Usage
-------------

The following examples use the sample datasets shipped with the
‘dimension_reduction_protocols’ library:

     | ?- logtalk_load(dimension_reduction_protocols('test_datasets/correlated_plane')).

* Menu:

* Learning a reducer: Learning a reducer<6>.
* Transforming new instances: Transforming new instances<6>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a reducer<6>,  Next: Transforming new instances<6>,  Up: Usage<85>

6.164.6.1 Learning a reducer
............................

     | ?- probabilistic_pca_projection::learn(correlated_plane, DimensionReducer).

     | ?- probabilistic_pca_projection::learn(correlated_plane, DimensionReducer, [n_components(1), feature_scaling(false), shortfall_policy(error)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transforming new instances<6>,  Next: Exporting and reusing the reducer<6>,  Prev: Learning a reducer<6>,  Up: Usage<85>

6.164.6.2 Transforming new instances
....................................

     | ?- probabilistic_pca_projection::learn(correlated_plane, DimensionReducer, [n_components(2)]),
          probabilistic_pca_projection::transform(DimensionReducer, [x-2.0, y-4.0, z-6.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting and reusing the reducer<6>,  Prev: Transforming new instances<6>,  Up: Usage<85>

6.164.6.3 Exporting and reusing the reducer
...........................................

     | ?- probabilistic_pca_projection::learn(correlated_plane, DimensionReducer, [n_components(1)]),
          probabilistic_pca_projection::export_to_file(correlated_plane, DimensionReducer, reducer, 'probabilistic_pca_reducer.pl').

     | ?- logtalk_load('probabilistic_pca_reducer.pl'),
          reducer(Reducer),
          probabilistic_pca_projection::transform(Reducer, [x-1.0, y-2.0, z-3.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation<7>,  Next: References<44>,  Prev: Usage<85>,  Up: probabilistic_pca_projection

6.164.7 Dimension reducer representation
----------------------------------------

The learned dimension reducer is represented by a compound term with the
functor chosen by the implementation and arity 6.  For example:

     probabilistic_pca_reducer(Encoders, Components, Loadings, NoiseVariance, ExplainedVariances, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Components’: List of posterior latent projection vectors in
     descending explained-variance order.

   - ‘Loadings’: List of maximum-likelihood PPCA loading vectors aligned
     with the extracted latent dimensions.

   - ‘NoiseVariance’: Estimated isotropic observation noise variance.

   - ‘ExplainedVariances’: List of retained covariance eigenvalues
     matching the extracted latent dimensions.

   - ‘Diagnostics’: Learned metadata including the effective training
     options, sample count, retained explained variances, estimated
     noise variance, preprocessing details, and optional truncate-mode
     shortfall details.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
reducer term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<44>,  Prev: Dimension reducer representation<7>,  Up: probabilistic_pca_projection

6.164.8 References
------------------

  1. Tipping, M. E. and Bishop, C. M. (1999) - “Probabilistic Principal
     Component Analysis”.

  2. Bishop, C. M. (2006) - “Pattern Recognition and Machine Learning”.
     Section 12.2.


File: TheLogtalkHandbook-3.100.1.info,  Node: process,  Next: protobuf,  Prev: probabilistic_pca_projection,  Up: Libraries

6.165 ‘process’
===============

This library provides a portable abstraction over process handling
predicates found in some backend Prolog systems.  Currently supports
ECLiPSe, GNU Prolog, SICStus Prolog, SWI-Prolog, Trealla Prolog, and
XVM.

* Menu:

* API documentation: API documentation<179>.
* Loading: Loading<181>.
* Testing: Testing<172>.
* Usage: Usage<86>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<179>,  Next: Loading<181>,  Up: process

6.165.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#process’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<181>,  Next: Testing<172>,  Prev: API documentation<179>,  Up: process

6.165.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(process(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<172>,  Next: Usage<86>,  Prev: Loading<181>,  Up: process

6.165.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(process(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<86>,  Prev: Testing<172>,  Up: process

6.165.4 Usage
-------------

The ‘process’ object provides the following predicates for portable
process handling:

   - ‘create(Executable, Arguments, Options)’ - Creates a new process

   - ‘wait(Process, Status)’ - Waits for a process to terminate

   - ‘kill(Process, Signal)’ - Terminates a process with a specific
     signal

   - ‘kill(Process)’ - Terminates a process using the default signal
     (SIGKILL)

The ‘create/3’ predicate supports the following options:

   - ‘process(Pid)’ - Unifies Pid with the process identifier (an opaque
     ground term)

   - ‘stdin(Stream)’ - Binds Stream to the process standard input

   - ‘stdout(Stream)’ - Binds Stream to the process standard output

   - ‘stderr(Stream)’ - Binds Stream to the process standard error

Note: Process identifiers (PIDs) should be treated as opaque ground
terms.  Their internal representation varies between backend Prolog
systems.

Example:

     | ?- process::create('/bin/echo', ['hello.'], [stdout(Out), process(PID)]),
          read_term(Out, Term, []),
          close(Out).
     Out = ..., PID = ..., Term = hello.


File: TheLogtalkHandbook-3.100.1.info,  Node: protobuf,  Next: qda_classifier,  Prev: process,  Up: Libraries

6.166 ‘protobuf’
================

The ‘protobuf’ library implements predicates for reading (parsing) and
writing (generating) data in the Google Protocol Buffers binary format.

This implementation is based on the Protocol Buffers Language Guide
(proto3) and the Protocol Buffers Encoding specification:

   - ‘https://protobuf.dev/programming-guides/proto3/’

   - ‘https://protobuf.dev/programming-guides/encoding/’

'This library requires a backend supporting unbounded integer
arithmetic.'

* Menu:

* API documentation: API documentation<180>.
* Loading: Loading<182>.
* Testing: Testing<173>.
* Protocol Buffers Overview::
* Schema Representation::
* Data Representation::
* Encoding: Encoding<9>.
* Decoding: Decoding<9>.
* Wire Format Details::
* Binary Format Compatibility::
* Examples and Test Files::
* Further Reading::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<180>,  Next: Loading<182>,  Up: protobuf

6.166.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#avro’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<182>,  Next: Testing<173>,  Prev: API documentation<180>,  Up: protobuf

6.166.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(avro(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<173>,  Next: Protocol Buffers Overview,  Prev: Loading<182>,  Up: protobuf

6.166.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(avro(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol Buffers Overview,  Next: Schema Representation,  Prev: Testing<173>,  Up: protobuf

6.166.4 Protocol Buffers Overview
---------------------------------

Protocol Buffers (protobuf) is a language-neutral, platform-neutral
extensible mechanism for serializing structured data.  It is widely used
for data storage, communication protocols, and more.


File: TheLogtalkHandbook-3.100.1.info,  Node: Schema Representation,  Next: Data Representation,  Prev: Protocol Buffers Overview,  Up: protobuf

6.166.5 Schema Representation
-----------------------------

In this library, Protocol Buffers schemas (normally defined in ‘.proto’
files) are represented as Logtalk terms.  The schema representation uses
a curly-bracketed syntax similar to JSON representation.

A message schema is represented as:

     {message-MessageName, fields-FieldList}

Where ‘FieldList’ is a list of field definitions, each with:

     {number-FieldNumber, name-FieldName, type-FieldType}

* Menu:

* Supported Types::
* Schema Examples: Schema Examples<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported Types,  Next: Schema Examples<2>,  Up: Schema Representation

6.166.5.1 Supported Types
.........................

* Menu:

* Scalar Value Types::
* Complex Types::


File: TheLogtalkHandbook-3.100.1.info,  Node: Scalar Value Types,  Next: Complex Types,  Up: Supported Types

6.166.5.2 Scalar Value Types
............................

   - ‘int32’ - Uses variable-length encoding.  Inefficient for negative
     numbers (use ‘sint32’ instead).

   - ‘int64’ - Uses variable-length encoding.  Inefficient for negative
     numbers (use ‘sint64’ instead).

   - ‘uint32’ - Uses variable-length encoding.

   - ‘uint64’ - Uses variable-length encoding.

   - ‘sint32’ - Uses variable-length encoding with ZigZag encoding.
     More efficient for negative numbers.

   - ‘sint64’ - Uses variable-length encoding with ZigZag encoding.
     More efficient for negative numbers.

   - ‘bool’ - Boolean value: ‘true’ or ‘false’.

   - ‘fixed32’ - Always four bytes.  More efficient than ‘uint32’ if
     values are often greater than 2^28.

   - ‘fixed64’ - Always eight bytes.  More efficient than ‘uint64’ if
     values are often greater than 2^56.

   - ‘sfixed32’ - Always four bytes.  Signed fixed-width integer.

   - ‘sfixed64’ - Always eight bytes.  Signed fixed-width integer.

   - ‘float’ - 32-bit IEEE 754 floating point.

   - ‘double’ - 64-bit IEEE 754 floating point.

   - ‘string’ - UTF-8 encoded text.

   - ‘bytes’ - Arbitrary byte sequence.


File: TheLogtalkHandbook-3.100.1.info,  Node: Complex Types,  Prev: Scalar Value Types,  Up: Supported Types

6.166.5.3 Complex Types
.......................

   - ‘{message-Name, fields-Fields}’ - Embedded message (nested
     structure).


File: TheLogtalkHandbook-3.100.1.info,  Node: Schema Examples<2>,  Prev: Supported Types,  Up: Schema Representation

6.166.5.4 Schema Examples
.........................

Simple primitive type schemas:

   - ‘int32’

   - ‘string’

   - ‘bool’

Message schema example:

     {message-'Person', fields-[
         {number-1, name-name, type-string},
         {number-2, name-id, type-int32},
         {number-3, name-email, type-string}
     ]}

Nested message schema:

     {message-'AddressBook', fields-[
         {number-1, name-people, type-{message-'Person', fields-[
             {number-1, name-name, type-string},
             {number-2, name-id, type-int32}
         ]}}
     ]}


File: TheLogtalkHandbook-3.100.1.info,  Node: Data Representation,  Next: Encoding<9>,  Prev: Schema Representation,  Up: protobuf

6.166.6 Data Representation
---------------------------

Data to be serialized is represented as a list of field name-value pairs
using the ‘-’ operator.  For example:

     [name-'John Doe', id-42, email-'john@example.com']

For primitive types, data is represented directly as Logtalk values:

   - Integers: ‘42’, ‘-17’

   - Booleans: ‘true’, ‘false’

   - Floats: ‘3.14’, ‘-273.15’

   - Strings: ‘'Hello World'’, ‘hello’

   - Bytes: ‘[0x48, 0x65, 0x6c, 0x6c, 0x6f]’


File: TheLogtalkHandbook-3.100.1.info,  Node: Encoding<9>,  Next: Decoding<9>,  Prev: Data Representation,  Up: protobuf

6.166.7 Encoding
----------------

Encoding is accomplished using the ‘generate/3’ or ‘generate/4’
predicates.

* Menu:

* Simple Value Encoding::
* Message Encoding::
* Including Schema in Output::


File: TheLogtalkHandbook-3.100.1.info,  Node: Simple Value Encoding,  Next: Message Encoding,  Up: Encoding<9>

6.166.7.1 Simple Value Encoding
...............................

For example, encoding an integer using the ‘int32’ schema:

     | ?- protobuf::generate(bytes(Bytes), int32, 150).
     Bytes = [150, 1]
     yes

Encoding a string:

     | ?- protobuf::generate(bytes(Bytes), string, 'testing').
     Bytes = [116, 101, 115, 116, 105, 110, 103]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Message Encoding,  Next: Including Schema in Output,  Prev: Simple Value Encoding,  Up: Encoding<9>

6.166.7.2 Message Encoding
..........................

To encode a complete message:

     | ?- Schema = {message-'Person', fields-[
     |        {number-1, name-name, type-string},
     |        {number-2, name-id, type-int32}
     |    ]},
     |    Data = [name-'John', id-42],
     |    protobuf::generate(bytes(Bytes), Schema, Data).

     Schema = {...},
     Data = [name-'John', id-42],
     Bytes = [10, 4, 74, 111, 104, 110, 16, 84]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Including Schema in Output,  Prev: Message Encoding,  Up: Encoding<9>

6.166.7.3 Including Schema in Output
....................................

To include the schema in the output (as a custom wrapper message), use
the ‘generate/4’ predicate with the second argument set to ‘true’:

     | ?- protobuf::generate(file('output.pb'), true, Schema, Data).
     yes

This generates a wrapper message with:

   - Field 1: schema (as a JSON string)

   - Field 2: data (as encoded bytes)


File: TheLogtalkHandbook-3.100.1.info,  Node: Decoding<9>,  Next: Wire Format Details,  Prev: Encoding<9>,  Up: protobuf

6.166.8 Decoding
----------------

Decoding is accomplished using the ‘parse/2’ or ‘parse/3’ predicates.

* Menu:

* Parsing with Schema Embedded::
* Parsing with Known Schema::
* Parsing from Different Sources::


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing with Schema Embedded,  Next: Parsing with Known Schema,  Up: Decoding<9>

6.166.8.1 Parsing with Schema Embedded
......................................

When parsing a file that includes a schema (wrapper message format), use
‘parse/2’ which returns a ‘Schema-Data’ pair:

     | ?- protobuf::parse(file('input.pb'), Schema-Data).

When the schema is not present in the file, ‘Schema’ is unified with
‘false’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing with Known Schema,  Next: Parsing from Different Sources,  Prev: Parsing with Schema Embedded,  Up: Decoding<9>

6.166.8.2 Parsing with Known Schema
...................................

When the schema is known and not embedded in the file, use ‘parse/3’:

     | ?- Schema = {message-'Person', fields-[
     |        {number-1, name-name, type-string},
     |        {number-2, name-id, type-int32}
     |    ]},
     |    protobuf::parse(file('person.pb'), Schema, Data).

     Schema = {...},
     Data = [name-'Alice', id-123]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing from Different Sources,  Prev: Parsing with Known Schema,  Up: Decoding<9>

6.166.8.3 Parsing from Different Sources
........................................

The library supports three types of sources:

   - ‘bytes(List)’ - Parse from a list of bytes

   - ‘stream(Stream)’ - Parse from an open binary stream

   - ‘file(Path)’ - Parse from a file


File: TheLogtalkHandbook-3.100.1.info,  Node: Wire Format Details,  Next: Binary Format Compatibility,  Prev: Decoding<9>,  Up: protobuf

6.166.9 Wire Format Details
---------------------------

Protocol Buffers uses an efficient binary wire format with the following
wire types:

   - '0 (Varint)': ‘int32’, ‘int64’, ‘uint32’, ‘uint64’, ‘sint32’,
     ‘sint64’, ‘bool’

   - '1 (64-bit)': ‘fixed64’, ‘sfixed64’, ‘double’

   - '2 (Length-delimited)': ‘string’, ‘bytes’, embedded messages

   - '5 (32-bit)': ‘fixed32’, ‘sfixed32’, ‘float’

Each field is encoded with a tag (field number and wire type) followed
by the value.


File: TheLogtalkHandbook-3.100.1.info,  Node: Binary Format Compatibility,  Next: Examples and Test Files,  Prev: Wire Format Details,  Up: protobuf

6.166.10 Binary Format Compatibility
------------------------------------

The binary format produced by this library is compatible with:

   - Official Protocol Buffers implementations (C++, Java, Python, Go,
     etc.)

   - Other third-party implementations that follow the protobuf
     specification

Note: This library implements the core binary encoding format.  Advanced
features like ‘oneof’, ‘map’, ‘enum’, and ‘repeated’ fields are not yet
supported in this initial version.


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples and Test Files,  Next: Further Reading,  Prev: Binary Format Compatibility,  Up: protobuf

6.166.11 Examples and Test Files
--------------------------------

The ‘test_files’ subdirectory contains example schemas and data files
that demonstrate the library’s capabilities:

* Menu:

* person.proto: person proto.
* addressbook.proto: addressbook proto.
* Performance Considerations::


File: TheLogtalkHandbook-3.100.1.info,  Node: person proto,  Next: addressbook proto,  Up: Examples and Test Files

6.166.11.1 person.proto
.......................

A simple Person message schema.  This is a classic Protocol Buffers
example demonstrating basic field types:

   - 'Source': Adapted from the official Protocol Buffers tutorial

   - 'URL': ‘https://protobuf.dev/getting-started/’

   - 'License': Apache License 2.0 (compatible with Protocol Buffers
     documentation)


File: TheLogtalkHandbook-3.100.1.info,  Node: addressbook proto,  Next: Performance Considerations,  Prev: person proto,  Up: Examples and Test Files

6.166.11.2 addressbook.proto
............................

An AddressBook schema demonstrating nested messages.  Shows how to
represent complex hierarchical data structures:

   - 'Source': Adapted from the official Protocol Buffers tutorial

   - 'URL': ‘https://protobuf.dev/getting-started/’

   - 'License': Apache License 2.0


File: TheLogtalkHandbook-3.100.1.info,  Node: Performance Considerations,  Prev: addressbook proto,  Up: Examples and Test Files

6.166.11.3 Performance Considerations
.....................................

Protocol Buffers binary format is designed for:

   - 'Compactness': Variable-length encoding for integers

   - 'Speed': Simple encoding/decoding rules

   - 'Forward/backward compatibility': Unknown fields can be skipped

For optimal performance:

   - Use ‘sint32’/‘sint64’ for negative numbers

   - Use ‘fixed32’/‘fixed64’ for large numbers

   - Keep field numbers low (1-15 use only 1 byte for tags)


File: TheLogtalkHandbook-3.100.1.info,  Node: Further Reading,  Prev: Examples and Test Files,  Up: protobuf

6.166.12 Further Reading
------------------------

   - Protocol Buffers Language Guide:
     ‘https://protobuf.dev/programming-guides/proto3/’

   - Protocol Buffers Encoding Guide:
     ‘https://protobuf.dev/programming-guides/encoding/’

   - Protocol Buffers Tutorials: ‘https://protobuf.dev/getting-started/’


File: TheLogtalkHandbook-3.100.1.info,  Node: qda_classifier,  Next: queues,  Prev: protobuf,  Up: Libraries

6.167 ‘qda_classifier’
======================

Quadratic Discriminant Analysis classifier for continuous datasets using
class-specific covariance estimates with diagonal regularization.  The
implementation learns one quadratic discriminant model per class and
predicts the class with the highest class-specific score.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset, using it to make predictions, inspecting
class scores, and exporting it as a list of predicate clauses or to a
file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  All dataset
attributes must be declared as ‘continuous’.

* Menu:

* API documentation: API documentation<181>.
* Loading: Loading<183>.
* Testing: Testing<174>.
* Features: Features<63>.
* Options: Options<59>.
* Usage: Usage<87>.
* Classifier representation: Classifier representation<10>.
* References: References<45>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<181>,  Next: Loading<183>,  Up: qda_classifier

6.167.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#qda_classifier’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<183>,  Next: Testing<174>,  Prev: API documentation<181>,  Up: qda_classifier

6.167.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(qda_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<174>,  Next: Features<63>,  Prev: Loading<183>,  Up: qda_classifier

6.167.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(qda_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<63>,  Next: Options<59>,  Prev: Testing<174>,  Up: qda_classifier

6.167.4 Features
----------------

   - 'Continuous Datasets': Accepts only datasets whose attributes are
     all declared as continuous.

   - 'Class-Specific Covariances': Learns one covariance matrix, mean
     vector, and prior per class.

   - 'Regularized Estimation': Applies configurable diagonal
     regularization to each class covariance matrix before inversion.

   - 'Feature Scaling': Supports optional z-score scaling of continuous
     features before training.

   - 'Score Inspection': Provides class scores for all classes using
     ‘predict_scores/3’.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<59>,  Next: Usage<87>,  Prev: Features<63>,  Up: qda_classifier

6.167.5 Options
---------------

The ‘learn/3’ predicate supports these options:

   - ‘feature_scaling/1’ - whether to standardize continuous attributes
     before training (default: ‘true’)

   - ‘regularization/1’ - positive diagonal value added to each class
     covariance matrix before inversion (default: ‘1.0e-6’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<87>,  Next: Classifier representation<10>,  Prev: Options<59>,  Up: qda_classifier

6.167.6 Usage
-------------

* Menu:

* Learning a classifier: Learning a classifier<6>.
* Making predictions: Making predictions<6>.
* Exporting the classifier: Exporting the classifier<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a classifier<6>,  Next: Making predictions<6>,  Up: Usage<87>

6.167.6.1 Learning a classifier
...............................

     | ?- qda_classifier::learn(iris_small, Classifier).

     | ?- qda_classifier::learn(iris_small, Classifier, [regularization(1.0e-5)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Making predictions<6>,  Next: Exporting the classifier<6>,  Prev: Learning a classifier<6>,  Up: Usage<87>

6.167.6.2 Making predictions
............................

     | ?- qda_classifier::learn(iris_small, Classifier),
          qda_classifier::predict(Classifier, [sepal_length-5.9, sepal_width-3.0, petal_length-5.1, petal_width-1.8], Class).

     | ?- qda_classifier::learn(iris_small, Classifier),
          qda_classifier::predict_scores(Classifier, [sepal_length-6.4, sepal_width-3.2, petal_length-4.5, petal_width-1.5], Scores).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the classifier<6>,  Prev: Making predictions<6>,  Up: Usage<87>

6.167.6.3 Exporting the classifier
..................................

     | ?- qda_classifier::learn(iris_small, Classifier),
          qda_classifier::export_to_clauses(iris_small, Classifier, classify, Clauses).

     | ?- qda_classifier::learn(iris_small, Classifier),
          qda_classifier::export_to_file(iris_small, Classifier, classify, 'classifier.pl').


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<10>,  Next: References<45>,  Prev: Usage<87>,  Up: qda_classifier

6.167.7 Classifier representation
---------------------------------

The learned classifier is represented as a compound term with the form:

     qda_classifier(Encoders, Models, Options)

Where:

   - ‘Encoders’: list of continuous feature encoders with learned
     scaling parameters

   - ‘Models’: list of ‘class_model(Class, Prior, Mean, Precision,
     LogDeterminant, Constant)’ terms

   - ‘Options’: merged training options used to learn the classifier

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<45>,  Prev: Classifier representation<10>,  Up: qda_classifier

6.167.8 References
------------------

  1. Hastie, T., Tibshirani, R. and Friedman, J. (2009).  “The Elements
     of Statistical Learning”.  Section 4.3.

  2. Bishop, C.M. (2006).  “Pattern Recognition and Machine Learning”.
     Section 4.2.

  3. Duda, R.O., Hart, P.E. and Stork, D.G. (2001).  “Pattern
     Classification”.  Chapter 2.


File: TheLogtalkHandbook-3.100.1.info,  Node: queues,  Next: random,  Prev: qda_classifier,  Up: Libraries

6.168 ‘queues’
==============

This library implements queues.  The queue representation should be
regarded as an opaque term and only accessed using the library
predicates.

* Menu:

* API documentation: API documentation<182>.
* Loading: Loading<184>.
* Testing: Testing<175>.
* Usage: Usage<88>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<182>,  Next: Loading<184>,  Up: queues

6.168.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#queues’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<184>,  Next: Testing<175>,  Prev: API documentation<182>,  Up: queues

6.168.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(queues(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<175>,  Next: Usage<88>,  Prev: Loading<184>,  Up: queues

6.168.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(queues(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<88>,  Prev: Testing<175>,  Up: queues

6.168.4 Usage
-------------

To create a new queue, use the ‘new/1’ predicate:

     | ?- queue::new(Queue).
     Queue = ...
     yes

Elements can be added to either the end of the queue or the front of the
queue using, respectively, the ‘join/3’ and ‘join_all/3’ predicates or
the ‘jump/3’ and ‘jump_all/3’.  For example:

     | ?- queue::(new(Queue0), join_all([1,2,3], Queue0, Queue1)).
     Queue0 = ...,
     Queue1 = ...
     yes

We can query the head of the queue or remove the head of the queue
using, respectively, the ‘head/2’ and ‘serve/3’ predicates.  For
example:

     | ?- queue::(new(Queue0), join(1, Queue0, Queue1), head(Queue1, Head)).
     Queue0 = ...,
     Queue1 = ...,
     Head = 1
     yes

For details on these and other provided predicates, consult the library
API documentation.


File: TheLogtalkHandbook-3.100.1.info,  Node: random,  Next: random_forest_classifier,  Prev: queues,  Up: Libraries

6.169 ‘random’
==============

This library provides portable random number generators and an
abstraction over the native backend Prolog compiler random number
generator if available.  It includes predicates for generating random
floats and random integers in a given interval; predicates for
generating random sequences and sets; predicates for randomly selecting,
enumerating, and swapping elements from a list; predicates that succeed,
fail, or call another predicate with a given probability; and predicates
for sampling common probability distributions.

* Menu:

* API documentation: API documentation<183>.
* Loading: Loading<185>.
* Testing: Testing<176>.
* Algorithms::
* Usage: Usage<89>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<183>,  Next: Loading<185>,  Up: random

6.169.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#random’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<185>,  Next: Testing<176>,  Prev: API documentation<183>,  Up: random

6.169.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(random(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<176>,  Next: Algorithms,  Prev: Loading<185>,  Up: random

6.169.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(random(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Algorithms,  Next: Usage<89>,  Prev: Testing<176>,  Up: random

6.169.4 Algorithms
------------------

The ‘random(Algorithm)’ and ‘fast_random(Algorithm)’ parametric objects
support the following pseudo-random number generator algorithms:

   - ‘as183’ - Algorithm AS 183 from Applied Statistics.  3x32-bit PRNG
     with period 2^60.

   - ‘splitmix64’ - SplitMix64 1x64-bit PRNG primarily used for seeding
     other generators.  Algorithm by Guy L. Steele Jr.  et al.

   - ‘xoshiro128pp’ - Xoshiro128++ 4x32-bit state-of-the-art PRNG with
     period 2^128-1.  Algorithm by David Blackman and Sebastiano Vigna.

   - ‘xoshiro128ss’ - Xoshiro128** 4x32-bit state-of-the-art PRNG with
     period 2^128-1.  Algorithm by David Blackman and Sebastiano Vigna.

   - ‘xoshiro256pp’ - Xoshiro256++ 4x64-bit state-of-the-art PRNG with
     period 2^256-1.  Algorithm by David Blackman and Sebastiano Vigna.

   - ‘xoshiro256ss’ - Xoshiro256** 4x64-bit state-of-the-art PRNG with
     period 2^256-1.  Algorithm by David Blackman and Sebastiano Vigna.

   - ‘well512a’ - WELL512a 16x32-bit state-of-the-art PRNG with period
     2^512-1.  Algorithm by by François Panneton, Pierre L’Ecuyer, and
     Makoto Matsumoto.

Note that none of the above algorithms are cryptographically secure.

The SplitMix64, Xoshiro256++, and Xoshiro256** algorithms require a
backend supporting unbound integer arithmetic.

The ‘random’ and ‘fast_random’ objects use the ‘as183’ algorithm and are
provided for backward compatibility.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<89>,  Prev: Algorithms,  Up: random

6.169.5 Usage
-------------

The ‘random(Algorithm)’ object implements a portable random number
generator and supports multiple random number generators, using
different seeds, by defining derived objects.  For example:

     :- object(my_random_generator_1,
         extends(random(xoshiro128pp))).

         :- initialization(::reset_seed).

     :- end_object.

The ‘fast_random(Algorithm)’ object also implements a portable random
number generator but does not support deriving multiple random number
generators, which makes it a bit faster than the ‘random(Algorithm)’
object.

The ‘random(Algorithm)’, ‘random’, ‘fast_random(Algorithm)’, and
‘fast_random’ objects manage the random number generator seed using
internal dynamic state.  The predicates that update the seed are
declared as synchronized (when running on Prolog backends that support
threads).  Still, care must be taken when using these objects from
multi-threaded applications, as there is no portable solution to protect
seed updates from signals and prevent inconsistent state when threads
are canceled.

The ‘random(Algorithm)’, ‘random’, ‘fast_random(Algorithm)’, and
‘fast_random’ objects always initialize the random generator seed to the
same value, thus providing a pseudo random number generator.  The
‘randomize/1’ predicate can be used to initialize the seed with a random
value.  The argument should be a large positive integer.  In
alternative, when using a small integer argument, discard the first
dozen random values.

The ‘backend_random’ object abstracts the native backend Prolog compiler
random number generator for the basic ‘random/1’, ‘get_seed/1’, and
‘set_seed/1’ predicates providing a portable implementation for the
remaining predicates.  This makes the object stateless, which allows
reliable use from multiple threads.  Consult the backend Prolog compiler
documentation for details on its random number generator properties.
Note that several of the supported backend Prolog systems, notably
B-Prolog, CxProlog, ECLiPSe, JIProlog, and Quintus Prolog, do not
provide implementations for both the ‘get_seed/1’ and ‘set_seed/1’
predicates and calling these predicates simply succeed without
performing any action.

All random objects implement the ‘sampling_protocol’ protocol.  To
maximize performance, the shared implementations of the sampling
predicates is defined in the ‘sampling.lgt’ file that’s included in the
random objects.  This allows these predicates to call the basic
‘random/1’ and ‘random/3’ predicates as locally defined predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: random_forest_classifier,  Next: random_forest_regression,  Prev: random,  Up: Libraries

6.170 ‘random_forest_classifier’
================================

Random Forest classifier using C4.5 decision trees as base learners.
Builds an ensemble of decision trees trained on bootstrap samples with
random feature subsets and combines their predictions through majority
voting.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
an ensemble classifier from a dataset, using it to make predictions
(with class probabilities), and exporting it as a list of predicate
clauses or to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  See ‘test_files’
directory for examples.

* Menu:

* API documentation: API documentation<184>.
* Loading: Loading<186>.
* Testing: Testing<177>.
* Features: Features<64>.
* Options: Options<60>.
* Classifier representation: Classifier representation<11>.
* References: References<46>.
* Usage: Usage<90>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<184>,  Next: Loading<186>,  Up: random_forest_classifier

6.170.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#random_forest_classifier’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<186>,  Next: Testing<177>,  Prev: API documentation<184>,  Up: random_forest_classifier

6.170.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(random_forest_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<177>,  Next: Features<64>,  Prev: Loading<186>,  Up: random_forest_classifier

6.170.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(random_forest_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<64>,  Next: Options<60>,  Prev: Testing<177>,  Up: random_forest_classifier

6.170.4 Features
----------------

   - 'Ensemble Learning': Combines multiple C4.5 decision trees for
     robust predictions.

   - 'Bootstrap Sampling': Each tree is trained on a bootstrap sample
     (random sample with replacement) of the training data.

   - 'Feature Randomization': Random subset of features selected for
     each tree (default: sqrt(TotalFeatures)).

   - 'Portable Seeded Sampling': Uses ‘fast_random(xoshiro128pp)’ so
     bootstrap sampling and feature subset selection are portable and
     reproducible.

   - 'Majority Voting': Final predictions determined by voting across
     all trees.

   - 'Probability Estimation': Provides confidence scores based on vote
     proportions.

   - 'Configurable Options': Number of trees, maximum features per tree,
     and random seed via predicate options.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<60>,  Next: Classifier representation<11>,  Prev: Features<64>,  Up: random_forest_classifier

6.170.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘number_of_trees(N)’: Number of trees in the forest (default:
     ‘10’).

   - ‘maximum_features_per_tree(N)’: Maximum number of features to
     consider per tree (default: sqrt(TotalFeatures)).

   - ‘random_seed(N)’: Positive integer seed used by the portable
     ‘fast_random(xoshiro128pp)’ pseudo-random generator when drawing
     bootstrap samples and random feature subsets.  Using the same seed
     with the same dataset and options reproduces the same learned
     classifier (default: ‘1357911’).


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<11>,  Next: References<46>,  Prev: Options<60>,  Up: random_forest_classifier

6.170.6 Classifier representation
---------------------------------

The learned classifier is represented as a compound term:

     rf_classifier(Trees, ClassValues, Options)

Where:

   - ‘Trees’: List of ‘tree(C45Tree, AttributeNames)’ pairs

   - ‘ClassValues’: List of possible class values

   - ‘Options’: List of options used during learning

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<46>,  Next: Usage<90>,  Prev: Classifier representation<11>,  Up: random_forest_classifier

6.170.7 References
------------------

  1. Breiman, L. (2001).  “Random Forests”.  Machine Learning, 45(1),
     5-32.

  2. Ho, T.K. (1995).  “Random Decision Forests”.  Proceedings of the
     3rd International Conference on Document Analysis and Recognition.

  3. Quinlan, J.R. (1993).  “C4.5: Programs for Machine Learning”.
     Morgan Kaufmann.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<90>,  Prev: References<46>,  Up: random_forest_classifier

6.170.8 Usage
-------------

* Menu:

* Learning a Classifier: Learning a Classifier<5>.
* Making Predictions: Making Predictions<5>.
* Exporting the Classifier: Exporting the Classifier<5>.
* Using a Saved Classifier: Using a Saved Classifier<2>.
* Printing the Classifier: Printing the Classifier<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a Classifier<5>,  Next: Making Predictions<5>,  Up: Usage<90>

6.170.8.1 Learning a Classifier
...............................

     % Learn a random forest with default options (10 trees)
     | ?- random_forest_classifier::learn(play_tennis, Classifier).
     ...

     % Learn with custom options
     | ?- random_forest_classifier::learn(play_tennis, Classifier, [number_of_trees(20), maximum_features_per_tree(2), random_seed(17)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Making Predictions<5>,  Next: Exporting the Classifier<5>,  Prev: Learning a Classifier<5>,  Up: Usage<90>

6.170.8.2 Making Predictions
............................

     % Predict class for a new instance
     | ?- random_forest_classifier::learn(play_tennis, Classifier),
          random_forest_classifier::predict(Classifier, [outlook-sunny, temperature-hot, humidity-high, wind-weak], Class).
     Class = no
     ...

     % Get probability distribution from ensemble voting
     | ?- random_forest_classifier::learn(play_tennis, Classifier),
          random_forest_classifier::predict_probabilities(Classifier, [outlook-overcast, temperature-mild, humidity-normal, wind-weak], Probabilities).
     Probabilities = [yes-0.9, no-0.1]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the Classifier<5>,  Next: Using a Saved Classifier<2>,  Prev: Making Predictions<5>,  Up: Usage<90>

6.170.8.3 Exporting the Classifier
..................................

     % Export as predicate clauses
     | ?- random_forest_classifier::learn(play_tennis, Classifier),
          random_forest_classifier::export_to_clauses(play_tennis, Classifier, my_forest, Clauses).
     Clauses = [my_forest(random_forest_classifier(...))]
     ...

     % Export to a file
     | ?- random_forest_classifier::learn(play_tennis, Classifier),
          random_forest_classifier::export_to_file(play_tennis, Classifier, my_forest, 'forest.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Using a Saved Classifier<2>,  Next: Printing the Classifier<2>,  Prev: Exporting the Classifier<5>,  Up: Usage<90>

6.170.8.4 Using a Saved Classifier
..................................

     % Load and use a previously saved classifier
     | ?- logtalk_load('forest.pl'),
          my_forest(Classifier),
          random_forest_classifier::predict(Classifier, [outlook-sunny, temperature-cool, humidity-normal, wind-weak], Class).
     Class = yes
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Printing the Classifier<2>,  Prev: Using a Saved Classifier<2>,  Up: Usage<90>

6.170.8.5 Printing the Classifier
.................................

     % Print a summary of the random forest
     | ?- random_forest_classifier::learn(play_tennis, Classifier),
          random_forest_classifier::print_classifier(Classifier).

     Random Forest Classifier
     ========================

     Number of trees: 10
     Class values: [yes,no]
     Options: [number_of_trees(10)]

     Trees:
       Tree 1 (features: [outlook,humidity]):
         -> tree rooted at outlook
       ...
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: random_forest_regression,  Next: random_projection,  Prev: random_forest_classifier,  Up: Libraries

6.171 ‘random_forest_regression’
================================

Random Forest regressor supporting continuous and mixed-feature
datasets.  The library implements the ‘regressor_protocol’ defined in
the ‘regression_protocols’ library and learns an ensemble of regression
trees trained on bootstrap samples and per-split random feature subsets,
predicting with the arithmetic mean of the individual tree predictions.

* Menu:

* API documentation: API documentation<185>.
* Loading: Loading<187>.
* Testing: Testing<178>.
* Features: Features<65>.
* Regressor representation: Regressor representation<8>.
* Diagnostics syntax: Diagnostics syntax<19>.
* Options: Options<61>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<185>,  Next: Loading<187>,  Up: random_forest_regression

6.171.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#random_forest_regression’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<187>,  Next: Testing<178>,  Prev: API documentation<185>,  Up: random_forest_regression

6.171.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(random_forest_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<178>,  Next: Features<65>,  Prev: Loading<187>,  Up: random_forest_regression

6.171.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(random_forest_regression(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(random_forest_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<65>,  Next: Regressor representation<8>,  Prev: Testing<178>,  Up: random_forest_regression

6.171.4 Features
----------------

   - 'Bootstrap Ensembles': Trains multiple regression trees on
     bootstrap samples.

   - 'Random Feature Subsets': Samples a random subset of the available
     dataset attributes at each split of every tree.

   - 'Portable Seeded Sampling': Uses ‘fast_random(xoshiro128pp)’ so
     bootstrap and split-level feature sampling are portable and
     reproducible.

   - 'Tree Averaging': Predicts numeric targets using the arithmetic
     mean of the tree predictions.

   - 'Tree Configuration': Exposes the underlying regression-tree
     split-feature, depth, minimum-leaf, variance-reduction, and scaling
     options.

   - 'Categorical Features Encoding': Uses reference-level dummy coding
     derived from the declared dataset attribute values, with a
     missing-value indicator, and the resulting encoded features are
     treated as ordinary numeric split features by the tree learners.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, attribute count, tree count, and
     effective options, accessible using the shared regression
     diagnostics predicates.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for representative
     regression datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<8>,  Next: Diagnostics syntax<19>,  Prev: Features<65>,  Up: random_forest_regression

6.171.5 Regressor representation
--------------------------------

The learned regressor is represented by default as:

   - ‘rf_regressor(Trees, Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(Trees, Diagnostics)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<19>,  Next: Options<61>,  Prev: Regressor representation<8>,  Up: random_forest_regression

6.171.6 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(random_forest_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         attribute_count(AttributeCount),
         tree_count(TreeCount)
     ]

Where:

   - ‘model(random_forest_regression)’ identifies the learning algorithm
     that produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘attribute_count(AttributeCount)’ stores the number of dataset
     attributes available to the ensemble before split-level
     subsampling.

   - ‘tree_count(TreeCount)’ stores the number of trained regression
     trees in the ensemble.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<61>,  Prev: Diagnostics syntax<19>,  Up: random_forest_regression

6.171.7 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘number_of_trees/1’: Number of regression trees to train in the
     ensemble.  Increasing this value usually improves stability at the
     cost of additional training and prediction time.  The default is
     ‘10’.

   - ‘maximum_features_per_split/1’: Number of dataset attributes
     randomly sampled at each split when searching for the best
     partition.  Accepted values are a positive integer or ‘all’.  When
     omitted, the library uses the square root of the total number of
     available attributes, with a minimum of one attribute.  Passing
     ‘all’ disables split-level attribute subsampling.

   - ‘maximum_depth/1’: Maximum depth allowed for each regression-tree
     base learner.  The default is ‘10’.

   - ‘minimum_samples_leaf/1’: Minimum number of training examples
     required in each leaf of a base learner tree.  The default is ‘1’.

   - ‘minimum_variance_reduction/1’: Minimum split gain required by each
     base learner tree before accepting a partition.  The default is
     ‘0.0’.

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes inside each regression-tree base learner.  Accepted
     values are ‘true’ and ‘false’.  The default is ‘false’.

   - ‘random_seed/1’: Positive integer seed used by the portable
     ‘fast_random(xoshiro128pp)’ pseudo-random generator when drawing
     bootstrap samples and split-level random feature subsets.  Using
     the same seed with the same dataset and options reproduces the same
     learned regressor.  The default is ‘1357911’.


File: TheLogtalkHandbook-3.100.1.info,  Node: random_projection,  Next: rank_centrality,  Prev: random_forest_regression,  Up: Libraries

6.172 ‘random_projection’
=========================

Random projection reducer for continuous datasets.  The library
implements the ‘dimension_reducer_protocol’ defined in the
‘dimension_reduction_protocols’ library and learns a seeded dense
Rademacher projection matrix using the portable ‘fast_random’
pseudo-random generator after centering the training data, optionally
standardizing continuous attributes, and sampling entries in
‘{-$1/sqrt(k)$, +$1/sqrt(k)$}’ where ‘$k$’ is the requested reduced
dimensionality.

* Menu:

* API documentation: API documentation<186>.
* Loading: Loading<188>.
* Testing: Testing<179>.
* Features: Features<66>.
* Options: Options<62>.
* Usage: Usage<91>.
* Dimension reducer representation: Dimension reducer representation<8>.
* References: References<47>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<186>,  Next: Loading<188>,  Up: random_projection

6.172.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#random_projection’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<188>,  Next: Testing<179>,  Prev: API documentation<186>,  Up: random_projection

6.172.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(random_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<179>,  Next: Features<66>,  Prev: Loading<188>,  Up: random_projection

6.172.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(random_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<66>,  Next: Options<62>,  Prev: Testing<179>,  Up: random_projection

6.172.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.  Missing or nonnumeric values are rejected.

   - 'Centering and Optional Scaling': Centers all attributes and
     optionally standardizes them before projection.

   - 'Portable Seeded Sampling': Uses ‘fast_random(xoshiro128pp)’ so
     learned projection matrices are portable and reproducible.

   - 'Projection API': Transforms a new instance into a list of
     ‘component_N-Value’ pairs.

   - 'Model Export': Learned reducers can be exported as predicate
     clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<62>,  Next: Usage<91>,  Prev: Features<66>,  Up: random_projection

6.172.5 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘n_components/1’: Number of random projection components to sample.
     Requests that exceed the number of features raise
     ‘domain_error(component_count, Requested-Maximum)’.  The default is
     ‘2’.

   - ‘feature_scaling/1’: Whether to standardize continuous attributes
     before projection.  Options: ‘true’ (default) or ‘false’.

   - ‘random_seed/1’: Positive integer used to seed the portable
     pseudo-random generator before sampling the projection matrix.  The
     default is ‘1357911’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<91>,  Next: Dimension reducer representation<8>,  Prev: Options<62>,  Up: random_projection

6.172.6 Usage
-------------

The following examples use the sample datasets shipped with the
‘dimension_reduction_protocols’ library:

     | ?- logtalk_load(dimension_reduction_protocols('test_datasets/correlated_plane')),
          logtalk_load(dimension_reduction_protocols('test_datasets/high_dimensional_measurements')).

* Menu:

* Learning a reducer: Learning a reducer<7>.
* Transforming new instances: Transforming new instances<7>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a reducer<7>,  Next: Transforming new instances<7>,  Up: Usage<91>

6.172.6.1 Learning a reducer
............................

     | ?- random_projection::learn(correlated_plane, DimensionReducer).

     | ?- random_projection::learn(correlated_plane, DimensionReducer, [n_components(1), feature_scaling(false), random_seed(17)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transforming new instances<7>,  Next: Exporting and reusing the reducer<7>,  Prev: Learning a reducer<7>,  Up: Usage<91>

6.172.6.2 Transforming new instances
....................................

     | ?- random_projection::learn(high_dimensional_measurements, DimensionReducer, [random_seed(11)]),
          random_projection::transform(DimensionReducer, [f1-0.9, f2-1.1, f3-1.0, f4-2.0, f5-2.2, f6-2.1], ReducedInstance).

     | ?- random_projection::learn(correlated_plane, DimensionReducer, [n_components(1), random_seed(19)]),
          random_projection::transform(DimensionReducer, [x-1.0, y-2.0, z-3.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting and reusing the reducer<7>,  Prev: Transforming new instances<7>,  Up: Usage<91>

6.172.6.3 Exporting and reusing the reducer
...........................................

     | ?- random_projection::learn(correlated_plane, DimensionReducer, [n_components(1), random_seed(29)]),
          random_projection::export_to_file(correlated_plane, DimensionReducer, reducer, 'random_projection_reducer.pl').

     | ?- logtalk_load('random_projection_reducer.pl'),
          reducer(Reducer),
          random_projection::transform(Reducer, [x-1.0, y-2.0, z-3.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation<8>,  Next: References<47>,  Prev: Usage<91>,  Up: random_projection

6.172.7 Dimension reducer representation
----------------------------------------

The learned dimension reducer is represented by a compound term with the
functor chosen by the implementation and arity 3.  For example:

     random_projection_reducer(Encoders, Components, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, mean, and scale.

   - ‘Components’: List of sampled projection vectors in component
     order.

   - ‘Diagnostics’: Learned reducer metadata including the effective
     training options and reproducibility details.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
reducer term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<47>,  Prev: Dimension reducer representation<8>,  Up: random_projection

6.172.8 References
------------------

  1. Johnson, W. B. and Lindenstrauss, J. (1984) - “Extensions of
     Lipschitz mappings into a Hilbert space”.

  2. Achlioptas, D. (2003) - “Database-friendly random projections:
     Johnson-Lindenstrauss with binary coins”.


File: TheLogtalkHandbook-3.100.1.info,  Node: rank_centrality,  Next: ranked_pairs,  Prev: random_projection,  Up: Libraries

6.173 ‘rank_centrality’
=======================

Rank Centrality pairwise preference ranker.  It uses the Rank Centrality
transition rule where each observed opponent contributes an outgoing
transition proportional to the empirical probability of beating the
current item, scaled by the maximum comparison degree, and estimates the
stationary distribution using deterministic power iteration.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The training dataset must declare each ranked item once,
enumerate positive-weight pairwise preferences between distinct declared
items, induce a connected undirected comparison graph, and induce a
strongly connected directed transition graph so that the learned
stationary distribution is unique.

* Menu:

* API documentation: API documentation<187>.
* Loading: Loading<189>.
* Testing: Testing<180>.
* Features: Features<67>.
* Dataset requirements: Dataset requirements<4>.
* Usage: Usage<92>.
* Diagnostics syntax: Diagnostics syntax<20>.
* Options: Options<63>.
* Ranker representation: Ranker representation<13>.
* References: References<48>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<187>,  Next: Loading<189>,  Up: rank_centrality

6.173.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#rank_centrality’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<189>,  Next: Testing<180>,  Prev: API documentation<187>,  Up: rank_centrality

6.173.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(rank_centrality(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<180>,  Next: Features<67>,  Prev: Loading<189>,  Up: rank_centrality

6.173.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(rank_centrality(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<67>,  Next: Dataset requirements<4>,  Prev: Testing<180>,  Up: rank_centrality

6.173.4 Features
----------------

   - 'Pairwise Preference Learning': Learns one stationary probability
     score per item from weighted head-to-head outcomes.

   - 'Original Rank Centrality Transition Rule': Builds the Markov chain
     from empirical pairwise win probabilities scaled by the maximum
     comparison degree, then estimates the stationary distribution by
     deterministic power iteration.

   - 'Deterministic Ranking': Orders candidate items by learned
     stationary probability with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, disconnected
     undirected comparison graphs, and pairwise datasets whose directed
     transition graph is not strongly connected.

   - 'Training Diagnostics': Learned rankers include convergence,
     iteration, maximum-degree, and dataset summary metadata that can be
     accessed using the ‘diagnostics/2’ predicate.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Sparse Transition Processing': Training aggregates observed
     pairwise comparisons into sparse incoming transition lists so each
     power-iteration step scales with observed matchups instead of a
     dense item cross-product.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dataset requirements<4>,  Next: Usage<92>,  Prev: Features<67>,  Up: rank_centrality

6.173.5 Dataset requirements
----------------------------

This implementation requires more than undirected connectedness.  In
order to guarantee a unique stationary distribution, the directed
transition graph induced by the aggregated pairwise outcomes must be
strongly connected.  Datasets that create one-way dominance sinks or
other disconnected directed transition components are rejected instead
of producing ambiguous stationary scores.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<92>,  Next: Diagnostics syntax<20>,  Prev: Dataset requirements<4>,  Up: rank_centrality

6.173.6 Usage
-------------

* Menu:

* Learning a ranker: Learning a ranker<13>.
* Inspecting diagnostics: Inspecting diagnostics<11>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<13>,  Next: Inspecting diagnostics<11>,  Up: Usage<92>

6.173.6.1 Learning a ranker
...........................

     % Learn from a pairwise ranking dataset object
     | ?- rank_centrality::learn(my_dataset, Ranker).
     ...

     % Learn with custom iteration and convergence options
     | ?- rank_centrality::learn(my_dataset, Ranker, [maximum_iterations(500), tolerance(1.0e-9)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<11>,  Prev: Learning a ranker<13>,  Up: Usage<92>

6.173.6.2 Inspecting diagnostics
................................

     % Inspect convergence and dataset summary metadata
     | ?- rank_centrality::learn(my_dataset, Ranker),
          rank_centrality::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<20>,  Next: Options<63>,  Prev: Usage<92>,  Up: rank_centrality

6.173.7 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(rank_centrality),
         options(Options),
         convergence(Status),
         iterations(Iterations),
         final_delta(FinalDelta),
         maximum_degree(MaximumDegree),
         dataset_summary(DatasetSummary)
     ]

Where:

   - ‘model(rank_centrality)’ identifies the learning algorithm that
     produced the ranker.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘convergence(Status)’ records the training stop condition.  The
     current values are ‘converged’ and ‘maximum_iterations_exhausted’.

   - ‘iterations(Iterations)’ stores the number of power-iteration steps
     that were executed.

   - ‘final_delta(FinalDelta)’ stores the maximum absolute score update
     in the last iteration.

   - ‘maximum_degree(MaximumDegree)’ stores the maximum number of
     observed opponents for any single item in the training dataset.

   - ‘dataset_summary(DatasetSummary)’ stores a summary list describing
     the validated training dataset.

The current ‘dataset_summary/1’ payload has the form:

     [
         items(NumberOfItems),
         preferences(NumberOfPreferences),
         connected_components(NumberOfComponents),
         isolated_items(IsolatedItems)
     ]

Use the ‘ranking_protocols’ ‘diagnostic/2’ and ‘ranker_options/2’ helper
predicates when you only need a single metadata term or the effective
options.

* Menu:

* Ranking candidate items: Ranking candidate items<12>.
* Exporting the ranker: Exporting the ranker<11>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<12>,  Next: Exporting the ranker<11>,  Up: Diagnostics syntax<20>

6.173.7.1 Ranking candidate items
.................................

     % Rank a candidate set from most preferred to least preferred
     | ?- rank_centrality::learn(my_dataset, Ranker),
          rank_centrality::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<11>,  Prev: Ranking candidate items<12>,  Up: Diagnostics syntax<20>

6.173.7.2 Exporting the ranker
..............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- rank_centrality::learn(my_dataset, Ranker),
          rank_centrality::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(rank_centrality_ranker(...))]
     ...

     % Export to a file
     | ?- rank_centrality::learn(my_dataset, Ranker),
          rank_centrality::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<63>,  Next: Ranker representation<13>,  Prev: Diagnostics syntax<20>,  Up: rank_centrality

6.173.8 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘maximum_iterations(MaximumIterations)’: Positive integer iteration
     bound.

   - ‘tolerance(Tolerance)’: Positive convergence tolerance.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<13>,  Next: References<48>,  Prev: Options<63>,  Up: rank_centrality

6.173.9 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     rank_centrality_ranker(Items, Scores, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Score’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, convergence status, iteration count, final update delta,
     maximum degree, and dataset summary.

The ‘Scores’ payload is expected to contain positive stationary
probability values summing to ‘1.0’.  The ranker validation logic
enforces this invariant when consuming serialized or exported ranker
terms so that malformed payloads are rejected instead of silently
accepted.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
ranker term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<48>,  Prev: Ranker representation<13>,  Up: rank_centrality

6.173.10 References
-------------------

  1. Negahban, S., Oh, S., and Shah, D. (2012).  Rank Centrality:
     Ranking from pairwise comparisons.  'Operations Research', 65(1),
     266-287.


File: TheLogtalkHandbook-3.100.1.info,  Node: ranked_pairs,  Next: ranking_protocols,  Prev: rank_centrality,  Up: Libraries

6.174 ‘ranked_pairs’
====================

Ranked Pairs pairwise preference ranker.  It builds the direct pairwise
victory graph from aggregated matchups, considers victories in
descending direct-victory strength order, and locks each victory unless
it would create a directed cycle in the accepted lock graph.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The current implementation requires a well-formed connected
pairwise dataset so that all ranked items remain part of a single
comparison graph.

* Menu:

* API documentation: API documentation<188>.
* Loading: Loading<190>.
* Testing: Testing<181>.
* Features: Features<68>.
* Usage: Usage<93>.
* Diagnostics syntax: Diagnostics syntax<21>.
* Options: Options<64>.
* Scoring semantics: Scoring semantics<7>.
* Ranker representation: Ranker representation<14>.
* See also: See also<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<188>,  Next: Loading<190>,  Up: ranked_pairs

6.174.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#ranked_pairs’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<190>,  Next: Testing<181>,  Prev: API documentation<188>,  Up: ranked_pairs

6.174.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ranked_pairs(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<181>,  Next: Features<68>,  Prev: Loading<190>,  Up: ranked_pairs

6.174.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ranked_pairs(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<68>,  Next: Usage<93>,  Prev: Testing<181>,  Up: ranked_pairs

6.174.4 Features
----------------

   - 'Pairwise Preference Learning': Learns one deterministic score per
     item from aggregated pairwise outcomes.

   - 'Ranked Pairs Locking': Processes direct victories in descending
     strength order and accepts each victory unless it would create a
     directed cycle in the current lock graph.

   - 'Configurable Direct Victory Semantics': Supports both
     winning-votes and victory-margins victory-strength modes before
     locking.

   - 'Configurable Equal-Strength Tie Breaking': Supports both standard
     term-order and dataset declaration-order resolution when direct
     victories have the same strength.

   - 'Locked-Pair Access': Exposes the accepted lock graph in lock order
     using the ‘locked_pairs/2’ predicate.

   - 'Deterministic Ranking': Orders candidate items by the number of
     opponents reachable in the final locked relation with deterministic
     tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     comparison graphs.

   - 'Training Diagnostics': Learned rankers include dataset summary
     metadata, the effective victory-strength mode, and the accepted
     lock graph.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Condorcet Infrastructure': Reuses the shared direct-victory
     preprocessing helpers from the ‘ranking_protocols’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<93>,  Next: Diagnostics syntax<21>,  Prev: Features<68>,  Up: ranked_pairs

6.174.5 Usage
-------------

* Menu:

* Learning a ranker: Learning a ranker<14>.
* Inspecting diagnostics: Inspecting diagnostics<12>.
* Ranking candidate items: Ranking candidate items<13>.
* Inspecting locked pairs::
* Exporting the ranker: Exporting the ranker<12>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<14>,  Next: Inspecting diagnostics<12>,  Up: Usage<93>

6.174.5.1 Learning a ranker
...........................

     % Learn from a pairwise ranking dataset object
     | ?- ranked_pairs::learn(my_dataset, Ranker).
     ...

     % Learn with custom direct-victory semantics
     | ?- ranked_pairs::learn(my_dataset, Ranker, [victory_strength(margins)]).
     ...

     % Learn with custom equal-strength tie breaking
     | ?- ranked_pairs::learn(my_dataset, Ranker, [tie_breaking(declaration_order)]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<12>,  Next: Ranking candidate items<13>,  Prev: Learning a ranker<14>,  Up: Usage<93>

6.174.5.2 Inspecting diagnostics
................................

     % Inspect the effective options and accepted locks
     | ?- ranked_pairs::learn(my_dataset, Ranker),
          ranked_pairs::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<13>,  Next: Inspecting locked pairs,  Prev: Inspecting diagnostics<12>,  Up: Usage<93>

6.174.5.3 Ranking candidate items
.................................

     % Rank a candidate set from most preferred to least preferred
     | ?- ranked_pairs::learn(my_dataset, Ranker),
          ranked_pairs::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting locked pairs,  Next: Exporting the ranker<12>,  Prev: Ranking candidate items<13>,  Up: Usage<93>

6.174.5.4 Inspecting locked pairs
.................................

     % Inspect the accepted lock graph in lock order
     | ?- ranked_pairs::learn(my_dataset, Ranker),
          ranked_pairs::locked_pairs(Ranker, LockedPairs).
     LockedPairs = [...]
     ...

The ‘locked_pairs/2’ predicate returns an ordered list of ‘lock(Winner,
Loser, Strength)’ terms representing the victories that were accepted
during the Ranked Pairs locking phase.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<12>,  Prev: Inspecting locked pairs,  Up: Usage<93>

6.174.5.5 Exporting the ranker
..............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- ranked_pairs::learn(my_dataset, Ranker),
          ranked_pairs::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(ranked_pairs_ranker(...))]
     ...

     % Export to a file
     | ?- ranked_pairs::learn(my_dataset, Ranker),
          ranked_pairs::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<21>,  Next: Options<64>,  Prev: Usage<93>,  Up: ranked_pairs

6.174.6 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(ranked_pairs),
         options(Options),
         locked_pairs(LockedPairs),
         dataset_summary(DatasetSummary)
     ]

Where:

   - ‘model(ranked_pairs)’ identifies the learning algorithm that
     produced the ranker.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘locked_pairs(LockedPairs)’ stores the accepted lock graph in the
     order in which victories were locked.

   - ‘dataset_summary(DatasetSummary)’ stores a summary list describing
     the validated training dataset.

Use the ‘ranking_protocols’ ‘diagnostic/2’ and ‘ranker_options/2’ helper
predicates when you only need a single metadata term or the effective
options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<64>,  Next: Scoring semantics<7>,  Prev: Diagnostics syntax<21>,  Up: ranked_pairs

6.174.7 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘victory_strength(winning_votes)’: Use the winning side’s
     aggregated vote total as the direct victory strength.

   - ‘victory_strength(margins)’: Use the victory margin as the direct
     victory strength.

   - ‘tie_breaking(term_order)’: Break equal-strength direct-victory
     ties using the standard term order of the winner and loser item
     identifiers.

   - ‘tie_breaking(declaration_order)’: Break equal-strength
     direct-victory ties using the training item declaration order
     preserved by the pairwise dataset helpers.

The defaults are ‘victory_strength(winning_votes)’ and
‘tie_breaking(term_order)’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoring semantics<7>,  Next: Ranker representation<14>,  Prev: Options<64>,  Up: ranked_pairs

6.174.8 Scoring semantics
-------------------------

The learned ‘scores/2’ values count how many opponents are reachable
from each item in the final locked relation.  These scores are therefore
integers in the range from ‘0’ to ‘N-1’, where ‘N’ is the number of
learned items.

This choice keeps the ‘rank/3’ behavior aligned with the locked graph
that the algorithm actually accepts: a higher score means that the item
precedes more opponents after all accepted locks are closed
transitively.

The effective scores can therefore change when ‘tie_breaking/1’ changes
the order in which equal-strength victories are considered for locking.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<14>,  Next: See also<6>,  Prev: Scoring semantics<7>,  Up: ranked_pairs

6.174.9 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     ranked_pairs_ranker(Items, Scores, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of integer ‘Item-Score’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, the accepted locked pairs, and the dataset summary.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
ranker term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: See also<6>,  Prev: Ranker representation<14>,  Up: ranked_pairs

6.174.10 See also
-----------------

For the strongest-path Condorcet-family alternative sharing the same
‘victory_strength(...)’ option, see the ‘schulze_ranker’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: ranking_protocols,  Next: reader,  Prev: ranked_pairs,  Up: Libraries

6.175 ‘ranking_protocols’
=========================

This library provides protocols used in the implementation of machine
learning ranking algorithms.  Rankers are represented as objects
implementing the ‘ranker_protocol’ protocol.  Datasets are represented
as objects implementing the ‘pairwise_ranking_dataset_protocol’,
‘pairwise_measurement_dataset_protocol’,
‘temporal_pairwise_ranking_dataset_protocol’, or the
‘ranking_dataset_protocol’ protocol.

This library also provides reusable test datasets and smoke tests for
the shared ranking-family contracts.

* Menu:

* Protocol requirements::
* Shared categories::
* Diagnostics: Diagnostics<10>.
* Export header format: Export header format<3>.
* API documentation: API documentation<189>.
* Loading: Loading<191>.
* Testing: Testing<182>.
* Test datasets: Test datasets<6>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol requirements,  Next: Shared categories,  Up: ranking_protocols

6.175.1 Protocol requirements
-----------------------------

The dataset protocols defined by this library impose the following
semantic and validity expectations:

   - ‘pairwise_ranking_dataset_protocol’ datasets should declare each
     item once, use only declared items in preferences, assign positive
     weights to preferences between distinct items, and may still need
     stronger conditions such as a strongly connected directed win graph
     for algorithms like Bradley-Terry that require finite
     maximum-likelihood estimates.

   - ‘pairwise_measurement_dataset_protocol’ datasets should declare
     each item once, use only declared items in measurements, assign
     numeric measurement values, and assign positive weights to
     measurements between distinct items.  Each ‘measurement(Item1,
     Item2, Value, Weight)’ fact denotes a weighted signed scalar
     observation on the oriented edge ‘Item1 -> Item2’, where positive
     values favor ‘Item1’, negative values favor ‘Item2’, and zero
     denotes a neutral observation.

   - ‘temporal_pairwise_ranking_dataset_protocol’ datasets should
     declare each item and period once, use only declared items and
     periods in games, keep game participants distinct, and restrict
     scores to the set ‘{0.0, 0.5, 1.0}’.  A fact ‘game(Period, Item1,
     Item2, Score)’ records the observed result for ‘Item1’ against
     ‘Item2’, with the score for ‘Item2’ implicitly equal to ‘1.0 -
     Score’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Shared categories,  Next: Diagnostics<10>,  Prev: Protocol requirements,  Up: ranking_protocols

6.175.2 Shared categories
-------------------------

The library includes a small family of reusable categories intended to
be imported by ranking algorithm implementations:

   - ‘ranking_dataset_common’ — dataset collection, summaries, graph
     connectivity, connected-component analysis, and pairwise/grouped
     dataset correctness checks, including pairwise measurement helpers,
     temporal pairwise rating-period helpers, and grouped tie-block
     extraction helpers for algorithms that consume tied rankings
     directly.

   - ‘glicko2_common’ — shared internal Glicko-2 numeric helpers for
     scale conversions, per-period player updates, and volatility root
     solving used by both the batch and periodic Glicko-2 rankers.

   - ‘condorcet_victory_common’ — shared direct-victory preprocessing
     helpers for Condorcet-family rankers that derive dense directed
     victory strengths from aggregated pairwise matchups under the
     ‘victory_strength(...)’ option semantics.

   - ‘ranker_common’ — representation-independent access to
     learned-ranker diagnostics plus reusable helpers for exporting
     learned rankers.

   - ‘grouped_strength_ranker_common’ — reusable positive-strength,
     strong-connectivity, and iterative-update helpers for grouped
     ranking models that estimate one latent strength parameter per
     item.

These categories are designed to keep ranking implementations compact
while keeping the shared protocol-facing behavior reusable.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics<10>,  Next: Export header format<3>,  Prev: Shared categories,  Up: ranking_protocols

6.175.3 Diagnostics
-------------------

The ‘ranker_common’ category provides shared accessor predicates such as
‘diagnostics/2’, ‘diagnostic/2’, and ‘ranker_options/2’, together with
the shared ‘export_to_file/4’ export helper.  These predicates make it
possible to inspect and export learned rankers without depending on the
exact term representation used by a particular ranking algorithm
implementation.

The detailed contents of the diagnostics data are ranking algorithm
implementation dependent.  For example, one ranker may report
convergence status, iteration count, and dataset summaries, while
another may report a different set of metadata terms or only a subset of
those details.  When using diagnostics in application code, rely on the
shared access predicates and the documentation of the specific ranking
algorithm you are using.


File: TheLogtalkHandbook-3.100.1.info,  Node: Export header format<3>,  Next: API documentation<189>,  Prev: Diagnostics<10>,  Up: ranking_protocols

6.175.4 Export header format
----------------------------

The shared ranker exporter in the ‘ranker_common’ category writes a
header before the exported clauses in the following format:

     % exported ranker predicate: Functor/Arity
     % training dataset: Dataset
     % diagnostics: Diagnostics
     % Functor(Ranker)
     Functor(Ranker)

When exporting a serialized ranker term, using a noun such as ‘ranker/1’
or ‘model/1’ is recommended.  The ‘Ranker’ argument can then be passed
to the rank predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<189>,  Next: Loading<191>,  Prev: Export header format<3>,  Up: ranking_protocols

6.175.5 API documentation
-------------------------

Open the ‘../../apis/library_index.html#ranking_protocols’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<191>,  Next: Testing<182>,  Prev: API documentation<189>,  Up: ranking_protocols

6.175.6 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ranking_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<182>,  Next: Test datasets<6>,  Prev: Loading<191>,  Up: ranking_protocols

6.175.7 Testing
---------------

To test this library predicates and datasets, load the ‘tester.lgt’
file:

     | ?- logtalk_load(ranking_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test datasets<6>,  Prev: Testing<182>,  Up: ranking_protocols

6.175.8 Test datasets
---------------------

Several sample datasets are included in the ‘test_datasets’ directory:

   - ‘head_to_head.lgt’ — A compact pairwise-comparison dataset with
     four items and weighted preferences suitable for smoke testing
     deterministic ranking.

   - ‘search_results.lgt’ — A grouped ranking dataset with two query
     groups, three items per group, and non-negative integer relevance
     judgments.

   - ‘malformed_pairwise.lgt’ — A negative fixture where a preference
     mentions an undeclared item.

   - ‘malformed_duplicate_items.lgt’ — A negative pairwise fixture where
     an item is declared more than once.

   - ‘malformed_self_preference.lgt’ — A negative pairwise fixture where
     an item is preferred over itself.

   - ‘malformed_non_positive_weight.lgt’ — A negative pairwise fixture
     where a preference weight is not positive.

   - ‘disconnected_pairwise.lgt’ — A pairwise fixture with more than one
     connected component, useful for testing algorithms that require
     identifiable global scores.

   - ‘cyclic_pairwise.lgt’ — A connected pairwise fixture with a
     preference cycle, useful for smoke testing algorithms on
     non-transitive data.

   - ‘condorcet_divergence_pairwise.lgt’ — A compact connected pairwise
     fixture where the current ‘schulze_ranker’ and ‘ranked_pairs’
     implementations produce different rankings, useful for cross-method
     regression tests.

   - ‘malformed_grouped.lgt’ — A negative fixture where a grouped
     relevance value is not a non-negative integer.

   - ‘sparse_preferences.lgt’ — A sparse pairwise dataset with an
     isolated item, useful for testing dataset summaries and
     disconnected-graph detection.

   - ‘two_item_measurements.lgt’ — A compact pairwise measurement
     dataset with two items and one signed measurement, useful for smoke
     testing exact two-item least-squares fits.

   - ‘regular_measurements.lgt’ — A compact connected pairwise
     measurement dataset whose measurements are perfectly explained by a
     zero-sum score potential, useful for regression tests with zero
     residuals.

   - ‘cyclic_measurements.lgt’ — A compact connected pairwise
     measurement dataset with cyclic inconsistency, useful for smoke
     testing zero global scores with non-zero residuals.

   - ‘disconnected_measurements.lgt’ — A pairwise measurement fixture
     with more than one connected component, useful for testing
     identifiable-score checks.

   - ‘malformed_measurement_unknown_item.lgt’ — A negative measurement
     fixture where a measurement mentions an undeclared item.

   - ‘malformed_measurement_duplicate_items.lgt’ — A negative
     measurement fixture where an item is declared more than once.

   - ‘malformed_measurement_self.lgt’ — A negative measurement fixture
     where an item is measured against itself.

   - ‘malformed_measurement_non_numeric.lgt’ — A negative measurement
     fixture where a measurement value is not numeric.

   - ‘malformed_measurement_non_positive_weight.lgt’ — A negative
     measurement fixture where a measurement weight is not positive.

   - ‘temporal_two_period_chain.lgt’ — A compact temporal pairwise
     dataset with two rating periods and three players, useful for smoke
     testing periodic rating carryover.

   - ‘temporal_draws.lgt’ — A compact temporal pairwise dataset with a
     draw, useful for testing score handling in temporal game results.

   - ‘temporal_idle_periods.lgt’ — A temporal pairwise dataset with an
     empty period between two played periods, useful for testing
     inactivity handling.


File: TheLogtalkHandbook-3.100.1.info,  Node: reader,  Next: recorded_database,  Prev: ranking_protocols,  Up: Libraries

6.176 ‘reader’
==============

The ‘reader’ object provides portable predicates for reading text file
and text stream contents to lists of terms, characters, or character
codes and for reading binary files to lists of bytes.  The text file API
is loosely based on the SWI-Prolog ‘readutil’ module.

* Menu:

* API documentation: API documentation<190>.
* Loading: Loading<192>.
* Testing: Testing<183>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<190>,  Next: Loading<192>,  Up: reader

6.176.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#reader’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<192>,  Next: Testing<183>,  Prev: API documentation<190>,  Up: reader

6.176.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(reader(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<183>,  Prev: Loading<192>,  Up: reader

6.176.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(reader(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: recorded_database,  Next: redis,  Prev: reader,  Up: Libraries

6.177 ‘recorded_database’
=========================

The ‘recorded_database’ library aims to help port Prolog code using the
legacy recorded database.  Ported applications should still consider
migrating to more standard solutions to handle dynamic data that must
survive backtracking.

* Menu:

* API documentation: API documentation<191>.
* Loading: Loading<193>.
* Testing: Testing<184>.
* Usage: Usage<94>.
* Known issues: Known issues<17>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<191>,  Next: Loading<193>,  Up: recorded_database

6.177.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#recorded_database’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<193>,  Next: Testing<184>,  Prev: API documentation<191>,  Up: recorded_database

6.177.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(recorded_database(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<184>,  Next: Usage<94>,  Prev: Loading<193>,  Up: recorded_database

6.177.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(recorded_database(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<94>,  Next: Known issues<17>,  Prev: Testing<184>,  Up: recorded_database

6.177.4 Usage
-------------

The ‘recorded_database_core’ category implements the library predicates.
This category is imported by the default ‘recorded_database’ object to
provide application global database.  To make the database local and
thus minimize potential record clashes, the category can be imported by
one or more application objects.  Use protected or private import to
restrict the scope of the library predicates.  For example:

     :- object(foo,
         imports(private::recorded_database_core)).

         bar :-
             ^^recorda(key, value(1)),
             ...

     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<17>,  Prev: Usage<94>,  Up: recorded_database

6.177.5 Known issues
--------------------

Currently, references are non-negative integers.  They still must be
regarded as opaque terms and subject to change without notice.  But
using integers can result in integer overflows when running on backends
with bounded integers in applications performing a large number of
database updates.


File: TheLogtalkHandbook-3.100.1.info,  Node: redis,  Next: regression_protocols,  Prev: recorded_database,  Up: Libraries

6.178 ‘redis’
=============

Redis client library.  Supports ECLiPSe, GNU Prolog, SICStus Prolog,
SWI-Prolog, Trealla Prolog, and XVM.

For general information on Redis, including a list of the available
commands, visit:

     https://redis.io

* Menu:

* API documentation: API documentation<192>.
* Loading: Loading<194>.
* Testing: Testing<185>.
* Supported Redis Features::
* Credits: Credits<4>.
* Known issues: Known issues<18>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<192>,  Next: Loading<194>,  Up: redis

6.178.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#redis’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<194>,  Next: Testing<185>,  Prev: API documentation<192>,  Up: redis

6.178.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(redis(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<185>,  Next: Supported Redis Features,  Prev: Loading<194>,  Up: redis

6.178.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(redis(tester)).

The tests assume a localhost Redis server running on the default port
(6379) if the ‘REDIS_HOST’ and ‘REDIS_PORT’ environment variables are
not defined.  If the server is not detected, the tests are skipped.

The unit tests were originally written by Sean Charles for his GNU
Prolog Redis client library:

     https://github.com/emacstheviking/gnuprolog-redisclient

The Logtalk version is a straight-forward port of the original tests
using the ‘test/1’ dialect of ‘lgtunit’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported Redis Features,  Next: Credits<4>,  Prev: Testing<185>,  Up: redis

6.178.4 Supported Redis Features
--------------------------------

This library provides wrapper predicates for commonly used Redis
operations across multiple data types.  For Redis commands not covered
by a wrapper, use the generic ‘redis::send/3’ predicate with the command
as a compound term.

* Menu:

* Connection Management::
* String Operations::
* Key Operations::
* Hash Operations::
* List Operations::
* Set Operations::
* Sorted Set Operations::
* Usage Examples::


File: TheLogtalkHandbook-3.100.1.info,  Node: Connection Management,  Next: String Operations,  Up: Supported Redis Features

6.178.4.1 Connection Management
...............................

   - ‘connect/1’ - Connect to localhost on default port (6379)

   - ‘connect/3’ - Connect to specified host and port

   - ‘disconnect/1’ - Disconnect from Redis server

   - ‘send/3’ - Send any Redis command and receive reply


File: TheLogtalkHandbook-3.100.1.info,  Node: String Operations,  Next: Key Operations,  Prev: Connection Management,  Up: Supported Redis Features

6.178.4.2 String Operations
...........................

   - ‘get/3’ - Get the value of a key

   - ‘set/4’ - Set the value of a key

   - ‘append/4’ - Append a value to a key

   - ‘getrange/5’ - Get substring of string stored at key

   - ‘setrange/5’ - Overwrite part of a string at key starting at offset

   - ‘strlen/3’ - Get the length of the value stored at key

   - ‘mget/3’ - Get values of multiple keys

   - ‘mset/3’ - Set multiple key-value pairs atomically

   - ‘incr/3’ - Increment integer value of key by one

   - ‘decr/3’ - Decrement integer value of key by one

   - ‘incrby/4’ - Increment integer value of key by amount

   - ‘decrby/4’ - Decrement integer value of key by amount


File: TheLogtalkHandbook-3.100.1.info,  Node: Key Operations,  Next: Hash Operations,  Prev: String Operations,  Up: Supported Redis Features

6.178.4.3 Key Operations
........................

   - ‘del/3’ - Delete a key

   - ‘exists/3’ - Check if a key exists

   - ‘keys/3’ - Find all keys matching a pattern

   - ‘ttl/3’ - Get time to live for a key in seconds

   - ‘expire/4’ - Set a timeout on a key in seconds

   - ‘persist/3’ - Remove the expiration from a key

   - ‘rename/4’ - Rename a key

   - ‘type/3’ - Get the type of value stored at key


File: TheLogtalkHandbook-3.100.1.info,  Node: Hash Operations,  Next: List Operations,  Prev: Key Operations,  Up: Supported Redis Features

6.178.4.4 Hash Operations
.........................

Hashes are maps between string fields and string values, ideal for
representing objects.

   - ‘hset/5’ - Set field in a hash

   - ‘hget/4’ - Get value of field in a hash

   - ‘hgetall/3’ - Get all fields and values in a hash

   - ‘hdel/4’ - Delete field from a hash

   - ‘hexists/4’ - Check if field exists in a hash

   - ‘hkeys/3’ - Get all field names in a hash

   - ‘hvals/3’ - Get all values in a hash

   - ‘hlen/3’ - Get number of fields in a hash


File: TheLogtalkHandbook-3.100.1.info,  Node: List Operations,  Next: Set Operations,  Prev: Hash Operations,  Up: Supported Redis Features

6.178.4.5 List Operations
.........................

Redis lists are ordered collections of strings, sorted by insertion
order.

   - ‘lpush/4’ - Prepend value to a list

   - ‘rpush/4’ - Append value to a list

   - ‘lpop/3’ - Remove and return first element of list

   - ‘rpop/3’ - Remove and return last element of list

   - ‘lrange/5’ - Get range of elements from list

   - ‘llen/3’ - Get length of list

   - ‘lrem/5’ - Remove elements from list

   - ‘ltrim/5’ - Trim list to specified range


File: TheLogtalkHandbook-3.100.1.info,  Node: Set Operations,  Next: Sorted Set Operations,  Prev: List Operations,  Up: Supported Redis Features

6.178.4.6 Set Operations
........................

Redis sets are unordered collections of unique strings.

   - ‘sadd/4’ - Add member to a set

   - ‘srem/4’ - Remove member from a set

   - ‘smembers/3’ - Get all members in a set

   - ‘sismember/4’ - Check if value is member of set

   - ‘scard/3’ - Get number of members in a set


File: TheLogtalkHandbook-3.100.1.info,  Node: Sorted Set Operations,  Next: Usage Examples,  Prev: Set Operations,  Up: Supported Redis Features

6.178.4.7 Sorted Set Operations
...............................

Sorted sets are collections of unique strings (members) ordered by an
associated score.  Members are unique, but scores may repeat.

   - ‘zadd/5’ - Add member with score to sorted set

   - ‘zrem/4’ - Remove member from sorted set

   - ‘zrange/5’ - Get range of members from sorted set by index

   - ‘zrank/4’ - Get rank (index) of member in sorted set

   - ‘zcard/3’ - Get number of members in sorted set

   - ‘zscore/4’ - Get score of member in sorted set


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage Examples,  Prev: Sorted Set Operations,  Up: Supported Redis Features

6.178.4.8 Usage Examples
........................

     % Connect and perform basic string operations
     ?- redis::connect(Connection),
        redis::set(Connection, mykey, 'Hello World', Status),
        redis::get(Connection, mykey, Value),
        redis::disconnect(Connection).
     Status = 'OK',
     Value = 'Hello World'.

     % Working with hashes
     ?- redis::connect(Connection),
        redis::hset(Connection, user:1000, name, 'John Doe', _),
        redis::hset(Connection, user:1000, email, 'john@example.com', _),
        redis::hgetall(Connection, user:1000, Fields),
        redis::disconnect(Connection).
     Fields = [bulk(name), bulk('John Doe'), bulk(email), bulk('john@example.com')].

     % Using lists as queues
     ?- redis::connect(Connection),
        redis::rpush(Connection, queue, task1, _),
        redis::rpush(Connection, queue, task2, _),
        redis::lpop(Connection, queue, Task),
        redis::disconnect(Connection).
     Task = task1.

     % Batch operations with mget/mset
     ?- redis::connect(Connection),
        redis::mset(Connection, [key1, val1, key2, val2], Status),
        redis::mget(Connection, [key1, key2], Values),
        redis::disconnect(Connection).
     Status = 'OK',
     Values = [bulk(val1), bulk(val2)].

     % Key expiration
     ?- redis::connect(Connection),
        redis::set(Connection, session:xyz, 'user_data', _),
        redis::expire(Connection, session:xyz, 3600, _), % Expire in 1 hour
        redis::ttl(Connection, session:xyz, TTL),
        redis::disconnect(Connection).
     TTL = 3600.

     % Using send/3 for commands without wrappers
     ?- redis::connect(Connection),
        redis::send(Connection, info(server), Reply),
        redis::disconnect(Connection).


File: TheLogtalkHandbook-3.100.1.info,  Node: Credits<4>,  Next: Known issues<18>,  Prev: Supported Redis Features,  Up: redis

6.178.5 Credits
---------------

This library is inspired by the Sean Charles GNU Prolog Redis client
library.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<18>,  Prev: Credits<4>,  Up: redis

6.178.6 Known issues
--------------------

Recent versions of macOS seem to disable the mapping of ‘localhost’ to
‘127.0.0.1’.  This issue may prevent running this library unit tests and
the ‘redis::connect/1’ predicate from working.  This can be fixed either
by editing the ‘/etc/hosts’ file or by using in alternative the
predicate ‘redis::connect/3’ with ‘'127.0.0.1'’ as the first argument.


File: TheLogtalkHandbook-3.100.1.info,  Node: regression_protocols,  Next: regression_tree,  Prev: redis,  Up: Libraries

6.179 ‘regression_protocols’
============================

This library provides protocols used in the implementation of machine
learning regression algorithms.  Datasets are represented as objects
implementing the ‘regression_dataset_protocol’ protocol.  Regressors are
represented as objects importing the ‘regressor_common’ category.  This
category provides shared helpers for regressor defaults, dataset
validation, diagnostics metadata, export, and pretty-printing support.

Learned regressors expose diagnostics using the shared ‘diagnostics/2’,
‘diagnostic/2’, and ‘regressor_options/2’ predicates.  Concrete
regressor implementations store effective training options in the
diagnostics metadata under an ‘options(Options)’ term.

This library also provides regression test datasets under the
‘test_datasets’ directory.

* Menu:

* API documentation: API documentation<193>.
* Loading: Loading<195>.
* Testing: Testing<186>.
* Test datasets: Test datasets<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<193>,  Next: Loading<195>,  Up: regression_protocols

6.179.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#regression_protocols’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<195>,  Next: Testing<186>,  Prev: API documentation<193>,  Up: regression_protocols

6.179.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(regression_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<186>,  Next: Test datasets<7>,  Prev: Loading<195>,  Up: regression_protocols

6.179.3 Testing
---------------

To test this library predicates, shared categories, and datasets, load
the ‘tester.lgt’ file:

| ?- logtalk_load(regression_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test datasets<7>,  Prev: Testing<186>,  Up: regression_protocols

6.179.4 Test datasets
---------------------

The ‘test_datasets’ directory includes the following compact regression
datasets and validation fixtures:

   - ‘duplicate_attribute_declaration.lgt’: invalid dataset fixture
     containing a duplicated attribute declaration in the dataset
     schema.

   - ‘duplicate_attribute_example.lgt’: invalid dataset fixture
     containing a duplicated declared attribute binding in one example.

   - ‘grouped_categorical_signal.lgt’: regression dataset with one
     relevant continuous attribute and one irrelevant categorical
     attribute for testing shrinkage of encoded categorical
     coefficients.

   - ‘intercept_only.lgt’: constant-target dataset for
     intercept-learning tests.

   - ‘invalid_target.lgt’: invalid dataset with a non-numeric target for
     negative tests.

   - ‘mixed_signal.lgt’: mixed continuous and categorical regression
     dataset.

   - ‘plane.lgt’: two-feature regression dataset following the plane ‘z
     = 3x1 - 2x2 + 5’.

   - ‘simple_line.lgt’: single-feature regression dataset following the
     line ‘y = 2x + 1’.

   - ‘sparse_mixed_signal.lgt’: mixed regression dataset with omitted
     attribute-value pairs used to exercise missing-value handling
     during training and prediction.

   - ‘sparse_signal.lgt’: two-feature regression dataset where only the
     signal attribute contributes to the target and the noise attribute
     is orthogonal to it.

   - ‘step_signal.lgt’: piecewise-constant regression dataset for
     tree-based and neighborhood regressor testing.

   - ‘undeclared_attribute_example.lgt’: invalid dataset fixture
     containing an undeclared attribute binding in one example.

   - ‘wide_mixed_signal.lgt’: synthetic wide mixed regression dataset
     with many continuous and categorical predictors for non-trivial
     linear-model benchmarking.


File: TheLogtalkHandbook-3.100.1.info,  Node: regression_tree,  Next: regularized_bradley_terry_ranker,  Prev: regression_protocols,  Up: Libraries

6.180 ‘regression_tree’
=======================

Regression tree regressor supporting continuous and mixed-feature
datasets.  The library implements the ‘regressor_protocol’ defined in
the ‘regression_protocols’ library and learns a binary regression tree
using recursive variance-reduction splits that select the encoded
feature threshold maximizing variance reduction.

* Menu:

* API documentation: API documentation<194>.
* Loading: Loading<196>.
* Testing: Testing<187>.
* Export header format: Export header format<4>.
* Features: Features<69>.
* Regressor representation: Regressor representation<9>.
* Diagnostics syntax: Diagnostics syntax<22>.
* Options: Options<65>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<194>,  Next: Loading<196>,  Up: regression_tree

6.180.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#regression_tree’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<196>,  Next: Testing<187>,  Prev: API documentation<194>,  Up: regression_tree

6.180.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(regression_tree(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<187>,  Next: Export header format<4>,  Prev: Loading<196>,  Up: regression_tree

6.180.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(regression_tree(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(regression_tree(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Export header format<4>,  Next: Features<69>,  Prev: Testing<187>,  Up: regression_tree

6.180.4 Export header format
----------------------------

The shared exporter in the ‘regressor_common’ category writes a header
before the exported clauses in the following format:

     % exported regressor predicate: Functor/Arity
     % training dataset: Dataset
     % target: Target
     % attributes: Attributes
     % diagnostics: Diagnostics
     % Functor(Encoders, FeatureLabels, Tree, Diagnostics)
     Functor(Encoders, FeatureLabels, Tree, Diagnostics)

The exported clauses serialize the learned regressor state so that
loading the file gives a regressor term that can be passed directly to
the ‘predict/3’ predicate.

When exporting a serialized regressor term, using a noun such as
‘regressor/4’ or ‘model/4’ is recommended.


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<69>,  Next: Regressor representation<9>,  Prev: Export header format<4>,  Up: regression_tree

6.180.5 Features
----------------

   - 'Variance-Reduction Splits': Selects binary thresholds over encoded
     features to reduce target variance.

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes.

   - 'Categorical Features Encoding': Uses reference-level dummy coding
     derived from the declared dataset attribute values, with a
     missing-value indicator, and the resulting encoded features are
     treated as ordinary numeric split features.

   - 'Missing Values': Missing feature values represented using
     anonymous variables or omitted attribute-value pairs are encoded
     using explicit missing-value indicator features during both
     training and prediction.

   - 'Per-Split Feature Sampling': Optionally samples a subset of
     dataset attributes at each split before searching for the best
     partition.

   - 'Optional Feature Scaling': Continuous attributes can be
     standardized using z-score scaling before tree induction.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, encoded feature count, and
     effective options, accessible using the shared regression
     diagnostics predicates.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Readable Trees': Includes a pretty-printer for inspecting learned
     tree structure.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for representative
     regression datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<9>,  Next: Diagnostics syntax<22>,  Prev: Features<69>,  Up: regression_tree

6.180.6 Regressor representation
--------------------------------

The learned regressor is represented by default as:

   - ‘regression_tree_regressor(Encoders, FeatureLabels, Tree,
     Diagnostics)’

In this representation, ‘Tree’ is built from ‘leaf(Prediction)’ and
‘node(Index, Threshold, FallbackPrediction, Left, Right)’ terms and
‘Diagnostics’ stores training metadata including the effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<22>,  Next: Options<65>,  Prev: Regressor representation<9>,  Up: regression_tree

6.180.7 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(regression_tree),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         encoded_feature_count(FeatureCount)
     ]

Where:

   - ‘model(regression_tree)’ identifies the learning algorithm that
     produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘encoded_feature_count(FeatureCount)’ stores the number of numeric
     features induced by the encoder list, including missing-value
     indicator features.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<65>,  Prev: Diagnostics syntax<22>,  Up: regression_tree

6.180.8 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘maximum_depth/1’: Maximum depth allowed for the induced regression
     tree.  Lower values yield smaller trees; higher values allow more
     detailed partitioning of the training data.  The default is ‘10’.

   - ‘minimum_samples_leaf/1’: Minimum number of training examples
     required in a leaf.  This option also prevents candidate splits
     that would create child nodes smaller than the requested size.  The
     default is ‘1’.

   - ‘minimum_variance_reduction/1’: Minimum variance-reduction gain
     required for accepting a split.  Higher values make the learner
     more conservative by pruning weak splits during induction.  The
     default is ‘0.0’.

   - ‘maximum_features_per_split/1’: Number of dataset attributes
     sampled at each split when searching for the best partition.
     Accepted values are a positive integer or ‘all’.  The default is
     ‘all’.

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes before tree induction.  Accepted values are ‘true’ and
     ‘false’.  The default is ‘false’.


File: TheLogtalkHandbook-3.100.1.info,  Node: regularized_bradley_terry_ranker,  Next: ridge_regression,  Prev: regression_tree,  Up: Libraries

6.181 ‘regularized_bradley_terry_ranker’
========================================

Regularized Bradley-Terry MAP pairwise preference ranker.  It uses a
deterministic MM-style posterior-mode update for a Bradley-Terry
likelihood regularized by an explicit independent Gamma prior over item
strengths.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The training dataset must declare each ranked item once,
enumerate positive-weight pairwise preferences between distinct declared
items, and induce a connected undirected comparison graph.  Unlike the
unregularized Bradley-Terry model, the directed win graph is not
required to be strongly connected.

* Menu:

* API documentation: API documentation<195>.
* Loading: Loading<197>.
* Testing: Testing<188>.
* Features: Features<70>.
* Dataset requirements: Dataset requirements<5>.
* Usage: Usage<95>.
* Diagnostics syntax: Diagnostics syntax<23>.
* Options: Options<66>.
* Ranker representation: Ranker representation<15>.
* References: References<49>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<195>,  Next: Loading<197>,  Up: regularized_bradley_terry_ranker

6.181.1 API documentation
-------------------------

Open the
‘../../apis/library_index.html#regularized_bradley_terry_ranker’ link in
a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<197>,  Next: Testing<188>,  Prev: API documentation<195>,  Up: regularized_bradley_terry_ranker

6.181.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(regularized_bradley_terry_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<188>,  Next: Features<70>,  Prev: Loading<197>,  Up: regularized_bradley_terry_ranker

6.181.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(regularized_bradley_terry_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<70>,  Next: Dataset requirements<5>,  Prev: Testing<188>,  Up: regularized_bradley_terry_ranker

6.181.4 Features
----------------

   - 'Pairwise Preference Learning': Learns positive item strengths from
     weighted head-to-head outcomes.

   - 'Explicit Gamma Prior': Uses a separate MAP model with an explicit
     independent Gamma prior over item strengths.

   - 'Finite Regularized Fit': Admits connected pairwise datasets whose
     directed win graph is not strongly connected, instead of rejecting
     them as non-identifiable maximum-likelihood problems.

   - 'Deterministic Ranking': Orders candidate items by learned strength
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     undirected comparison graphs.

   - 'Training Diagnostics': Learned rankers include the effective Gamma
     prior, convergence, iteration, and dataset summary metadata that
     can be accessed using the ‘diagnostics/2’ predicate.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.

   - 'Shared Pairwise Infrastructure': Reuses the shared pairwise
     preprocessing and MM-iteration scaffolding from the
     ‘ranking_protocols’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: Dataset requirements<5>,  Next: Usage<95>,  Prev: Features<70>,  Up: regularized_bradley_terry_ranker

6.181.5 Dataset requirements
----------------------------

This implementation still requires the undirected comparison graph
induced by the preferences to be connected, but unlike the unregularized
Bradley-Terry model it does not require the directed win graph to be
strongly connected.  The explicit Gamma prior regularizes dominance
partitions and one-way chains, yielding a finite posterior mode for
connected datasets that would otherwise fail the maximum-likelihood
existence check.

For the original unregularized maximum-likelihood Bradley-Terry model,
which keeps the same pairwise-preference interface but requires the
directed win graph to be strongly connected, see the
‘bradley_terry_ranker’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<95>,  Next: Diagnostics syntax<23>,  Prev: Dataset requirements<5>,  Up: regularized_bradley_terry_ranker

6.181.6 Usage
-------------

* Menu:

* Learning a ranker: Learning a ranker<15>.
* Inspecting diagnostics: Inspecting diagnostics<13>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a ranker<15>,  Next: Inspecting diagnostics<13>,  Up: Usage<95>

6.181.6.1 Learning a ranker
...........................

     % Learn from a pairwise ranking dataset object
     | ?- regularized_bradley_terry_ranker::learn(my_dataset, Ranker).
     ...

     % Learn with custom iteration and Gamma-prior options
     | ?- regularized_bradley_terry_ranker::learn(my_dataset, Ranker, [maximum_iterations(500), tolerance(1.0e-7), gamma_prior(gamma(3.0, 4.0))]).
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Inspecting diagnostics<13>,  Prev: Learning a ranker<15>,  Up: Usage<95>

6.181.6.2 Inspecting diagnostics
................................

     % Inspect convergence, prior, and dataset summary metadata
     | ?- regularized_bradley_terry_ranker::learn(my_dataset, Ranker),
          regularized_bradley_terry_ranker::diagnostics(Ranker, Diagnostics).
     Diagnostics = [...]
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<23>,  Next: Options<66>,  Prev: Usage<95>,  Up: regularized_bradley_terry_ranker

6.181.7 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(regularized_bradley_terry_ranker),
         options(Options),
         prior(gamma(Shape, Rate)),
         convergence(Status),
         iterations(Iterations),
         final_delta(FinalDelta),
         dataset_summary(DatasetSummary)
     ]

Where:

   - ‘model(regularized_bradley_terry_ranker)’ identifies the learning
     algorithm that produced the ranker.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘prior(gamma(Shape, Rate))’ stores the effective Gamma prior
     hyperparameters.

   - ‘convergence(Status)’ records the training stop condition.  The
     current values are ‘converged’ and ‘maximum_iterations_exhausted’.

   - ‘iterations(Iterations)’ stores the number of update iterations
     that were executed.

   - ‘final_delta(FinalDelta)’ stores the maximum absolute strength
     update in the last iteration.

   - ‘dataset_summary(DatasetSummary)’ stores a summary list describing
     the validated training dataset.

Use the ‘ranking_protocols’ ‘diagnostic/2’ and ‘ranker_options/2’ helper
predicates when you only need a single metadata term or the effective
options.

* Menu:

* Ranking candidate items: Ranking candidate items<14>.
* Exporting the ranker: Exporting the ranker<13>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranking candidate items<14>,  Next: Exporting the ranker<13>,  Up: Diagnostics syntax<23>

6.181.7.1 Ranking candidate items
.................................

     % Rank a candidate set from most preferred to least preferred
     | ?- regularized_bradley_terry_ranker::learn(my_dataset, Ranker),
          regularized_bradley_terry_ranker::rank(Ranker, [item_a, item_b, item_c], Ranking).
     Ranking = [...]
     ...

Candidate lists must be proper lists of unique, ground items declared by
the training dataset.  Invalid ranker terms, duplicate candidates, and
candidates containing variables are rejected with errors instead of
being silently accepted.


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the ranker<13>,  Prev: Ranking candidate items<14>,  Up: Diagnostics syntax<23>

6.181.7.2 Exporting the ranker
..............................

Learned rankers can be exported as a list of clauses or to a file for
later use.

     % Export as predicate clauses
     | ?- regularized_bradley_terry_ranker::learn(my_dataset, Ranker),
          regularized_bradley_terry_ranker::export_to_clauses(my_dataset, Ranker, my_ranker, Clauses).
     Clauses = [my_ranker(regularized_bt_ranker(...))]
     ...

     % Export to a file
     | ?- regularized_bradley_terry_ranker::learn(my_dataset, Ranker),
          regularized_bradley_terry_ranker::export_to_file(my_dataset, Ranker, my_ranker, 'ranker.pl').
     ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<66>,  Next: Ranker representation<15>,  Prev: Diagnostics syntax<23>,  Up: regularized_bradley_terry_ranker

6.181.8 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘maximum_iterations(MaximumIterations)’: Positive integer iteration
     bound.

   - ‘tolerance(Tolerance)’: Positive convergence tolerance.

   - ‘gamma_prior(gamma(Shape, Rate))’: Gamma-prior hyperparameters.
     The current implementation requires ‘Shape > 1’ and ‘Rate > 0’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<15>,  Next: References<49>,  Prev: Options<66>,  Up: regularized_bradley_terry_ranker

6.181.9 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     regularized_bt_ranker(Items, Strengths, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Strength’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     options, Gamma prior, convergence status, iteration count, final
     update delta, and dataset summary.

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
ranker term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<49>,  Prev: Ranker representation<15>,  Up: regularized_bradley_terry_ranker

6.181.10 References
-------------------

  1. Bradley, R. A. and Terry, M. E. (1952).  Rank analysis of
     incomplete block designs: I. The method of paired comparisons.
     'Biometrika', 39(3/4), 324-345.

  2. Hunter, D. R. (2004).  MM algorithms for generalized Bradley-Terry
     models.  'The Annals of Statistics', 32(1), 384-406.

  3. Caron, F. and Doucet, A. (2012).  Efficient Bayesian inference for
     generalized Bradley-Terry models.  'Journal of Computational and
     Graphical Statistics', 21(1), 174-196.


File: TheLogtalkHandbook-3.100.1.info,  Node: ridge_regression,  Next: schulze_ranker,  Prev: regularized_bradley_terry_ranker,  Up: Libraries

6.182 ‘ridge_regression’
========================

Ridge regression regressor supporting continuous and mixed-feature
datasets.  The library implements the ‘regressor_protocol’ defined in
the ‘regression_protocols’ library and learns a linear model by solving
the weighted ridge normal equations directly via the shared regression
encoding core in ‘regressor_common’, leaving the intercept unpenalized
while penalizing encoded feature columns using scale-aware weights that
match standardizing penalized columns before applying the L2 penalty.

* Menu:

* API documentation: API documentation<196>.
* Loading: Loading<198>.
* Testing: Testing<189>.
* Features: Features<71>.
* Regressor representation: Regressor representation<10>.
* Diagnostics syntax: Diagnostics syntax<24>.
* Options: Options<67>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<196>,  Next: Loading<198>,  Up: ridge_regression

6.182.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#ridge_regression’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<198>,  Next: Testing<189>,  Prev: API documentation<196>,  Up: ridge_regression

6.182.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ridge_regression(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<189>,  Next: Features<71>,  Prev: Loading<198>,  Up: ridge_regression

6.182.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ridge_regression(tester)).

To run the performance benchmark suite, load the
‘tester_performance.lgt’ file:

     | ?- logtalk_load(ridge_regression(tester_performance)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<71>,  Next: Regressor representation<10>,  Prev: Testing<189>,  Up: ridge_regression

6.182.4 Features
----------------

   - 'Continuous and Mixed Features': Supports continuous attributes and
     categorical attributes encoded using reference-level dummy coding.

   - 'Feature Scaling and Penalty Scaling': Continuous attributes can be
     standardized using z-score scaling.  Ridge regularization uses
     scale-aware weights equivalent to standardizing each penalized
     encoded feature column before applying the L2 penalty.

   - 'Missing Values': Missing numeric and categorical values
     represented using anonymous variables are encoded using explicit
     missing-value indicator features.

   - 'Unknown Values': Prediction requests containing categorical values
     that are not declared by the dataset raise a domain error.

   - 'Zero-Variance Features': Encoded columns with zero variance are
     excluded from the direct solve and assigned zero coefficients in
     the learned regressor.

   - 'Ridge Penalty': Applies L2 regularization to the learned weights
     using the shared ‘regularization/1’ option.

   - 'Diagnostics Metadata': Learned regressors record model name,
     target, training example count, solver, linear-system residual,
     active feature count, penalty scaling strategy, encoded feature
     count, and effective options, accessible using the shared
     regression diagnostics predicates.

   - 'Model Export': Learned regressors can be exported as predicate
     clauses or written to a file.

   - 'Reference Benchmarks': Includes a dedicated performance suite
     reporting training time, RMSE, and MAE for representative
     regression datasets.


File: TheLogtalkHandbook-3.100.1.info,  Node: Regressor representation<10>,  Next: Diagnostics syntax<24>,  Prev: Features<71>,  Up: ridge_regression

6.182.5 Regressor representation
--------------------------------

The learned regressor is represented by default as:

   - ‘ridge_regressor(Encoders, Bias, Weights, Diagnostics)’

The exported predicate clauses therefore use the shape:

   - ‘Functor(Encoders, Bias, Weights, Diagnostics)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<24>,  Next: Options<67>,  Prev: Regressor representation<10>,  Up: ridge_regression

6.182.6 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(ridge_regression),
         target(Target),
         training_example_count(TrainingExampleCount),
         options(Options),
         solver(Solver),
         linear_system_residual(Residual),
         active_feature_count(ActiveFeatureCount),
         penalty_scaling(encoded_feature_standardization),
         encoded_feature_count(FeatureCount)
     ]

Where:

   - ‘model(ridge_regression)’ identifies the learning algorithm that
     produced the regressor.

   - ‘target(Target)’ stores the target attribute name declared by the
     training dataset.

   - ‘training_example_count(TrainingExampleCount)’ stores the number of
     examples used during training.

   - ‘options(Options)’ stores the effective learning options after
     merging the user options with the library defaults.

   - ‘solver(Solver)’ records the direct linear-system solver used
     during training.  The current value is
     ‘pivoted_gaussian_elimination’.

   - ‘linear_system_residual(Residual)’ stores the maximum absolute
     residual of the solved ridge linear system.

   - ‘active_feature_count(ActiveFeatureCount)’ stores the number of
     encoded feature columns retained for the direct solve after
     dropping zero-variance columns.

   - ‘penalty_scaling(encoded_feature_standardization)’ records that the
     ridge penalty is scaled as if each penalized encoded feature column
     had been standardized before applying the L2 penalty.

   - ‘encoded_feature_count(FeatureCount)’ stores the number of numeric
     features induced by the encoder list, including missing-value
     indicator features.

Use the ‘regression_protocols’ ‘diagnostic/2’ and ‘regressor_options/2’
helper predicates when you only need a single metadata term or the
effective options.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<67>,  Prev: Diagnostics syntax<24>,  Up: ridge_regression

6.182.7 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘regularization/1’: Ridge penalty coefficient applied to the weight
     vector during the direct solve.  Higher values increase shrinkage
     and can reduce overfitting.  The default is ‘0.01’.

   - ‘feature_scaling/1’: Controls z-score standardization of continuous
     attributes before training and prediction.  Accepted values are
     ‘true’ and ‘false’.  The default is ‘true’.


File: TheLogtalkHandbook-3.100.1.info,  Node: schulze_ranker,  Next: sequential_pattern_mining_protocols,  Prev: ridge_regression,  Up: Libraries

6.183 ‘schulze_ranker’
======================

Schulze pairwise preference ranker.  It builds the direct pairwise
strength graph from aggregated matchups and applies the Schulze
strongest-path dynamic program to derive the final pairwise preference
relation.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The current implementation requires a well-formed connected
pairwise dataset so that all ranked items remain comparable in the
aggregated matchup graph.

* Menu:

* API documentation: API documentation<197>.
* Loading: Loading<199>.
* Testing: Testing<190>.
* Features: Features<72>.
* Options: Options<68>.
* Strongest paths::
* Diagnostics syntax: Diagnostics syntax<25>.
* Ranker representation: Ranker representation<16>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<197>,  Next: Loading<199>,  Up: schulze_ranker

6.183.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#schulze_ranker’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<199>,  Next: Testing<190>,  Prev: API documentation<197>,  Up: schulze_ranker

6.183.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(schulze_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<190>,  Next: Features<72>,  Prev: Loading<199>,  Up: schulze_ranker

6.183.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(schulze_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<72>,  Next: Options<68>,  Prev: Testing<190>,  Up: schulze_ranker

6.183.4 Features
----------------

   - 'Pairwise Preference Learning': Learns one deterministic score per
     item from aggregated pairwise outcomes.

   - 'Schulze Strongest Paths': Computes the final ranking relation
     using the Schulze strongest-path dynamic program over aggregated
     head-to-head data.

   - 'Configurable Direct Edge Semantics': Supports both winning-votes
     and victory-margins victory-strength modes.  The
     ‘victory_strength/1’ option selects whether direct edges use
     winning votes or victory margins before strongest-path propagation.

   - 'Strongest-Path Access': Exposes the labeled strongest-path
     relation for ordered item pairs using the ‘strongest_paths/2’
     predicate.

   - 'Deterministic Ranking': Orders candidate items by final Schulze
     relation win counts with deterministic tie-breaking.

   - 'Tie-breaking': Items tied in the final Schulze relation receive
     the same learned score, and ranking ties are then broken
     deterministically using the standard term order of the item
     identifiers.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     comparison graphs.

   - 'Training Diagnostics': Learned rankers include dataset summary
     metadata and the effective victory-strength mode.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<68>,  Next: Strongest paths,  Prev: Features<72>,  Up: schulze_ranker

6.183.5 Options
---------------

The following options can be passed to the ‘learn/3’ predicate:

   - ‘victory_strength(winning_votes)’: Use the winning side’s
     aggregated vote total as the direct edge strength.

   - ‘victory_strength(margins)’: Use the victory margin as the direct
     edge strength.

The default is ‘victory_strength(winning_votes)’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Strongest paths,  Next: Diagnostics syntax<25>,  Prev: Options<68>,  Up: schulze_ranker

6.183.6 Strongest paths
-----------------------

The ‘strongest_paths/2’ predicate returns the learned strongest-path
matrix as an ordered list of ‘path(Item1, Item2, Strength)’ terms for
all ordered pairs of distinct learned items.

This predicate complements ‘scores/2’ and ‘rank/3’ without changing
their semantics.  The ‘scores/2’ predicate still returns the number of
opponents that each item beats in the final Schulze relation, while
‘strongest_paths/2’ exposes the underlying pairwise path strengths used
to derive that relation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<25>,  Next: Ranker representation<16>,  Prev: Strongest paths,  Up: schulze_ranker

6.183.7 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(schulze_ranker),
         options(Options),
         strongest_paths(StrongestPaths),
         dataset_summary(DatasetSummary)
     ]


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<16>,  Prev: Diagnostics syntax<25>,  Up: schulze_ranker

6.183.8 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     schulze_ranker(Items, Scores, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Score’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the effective
     ‘victory_strength/1’ option, the labeled strongest paths, and the
     dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: sequential_pattern_mining_protocols,  Next: sets,  Prev: schulze_ranker,  Up: Libraries

6.184 ‘sequential_pattern_mining_protocols’
===========================================

This library provides support entities for sequential pattern mining
algorithms.  Ordered sequence datasets are represented as objects
implementing the ‘sequence_dataset_protocol’ protocol.  The generic
‘pattern_miner_protocol’ protocol and the ‘pattern_miner_common’
category used by concrete miners are loaded from the
‘pattern_mining_protocols’ core library.

The ‘sequential_pattern_mining_common’ category builds on that generic
core with sequential-specific helpers for dataset validation, support
count accumulation, and sequential pattern ordering/filtering.

This library also provides reusable sequence smoke-test datasets and a
small smoke-test suite.

* Menu:

* API documentation: API documentation<198>.
* Loading: Loading<200>.
* Testing: Testing<191>.
* Test datasets: Test datasets<8>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<198>,  Next: Loading<200>,  Up: sequential_pattern_mining_protocols

6.184.1 API documentation
-------------------------

Open the
‘../../apis/library_index.html#sequential_pattern_mining_protocols’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<200>,  Next: Testing<191>,  Prev: API documentation<198>,  Up: sequential_pattern_mining_protocols

6.184.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(sequential_pattern_mining_protocols(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<191>,  Next: Test datasets<8>,  Prev: Loading<200>,  Up: sequential_pattern_mining_protocols

6.184.3 Testing
---------------

To run the library smoke tests, load the ‘tester.lgt’ file:

     | ?- logtalk_load(sequential_pattern_mining_protocols(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Test datasets<8>,  Prev: Testing<191>,  Up: sequential_pattern_mining_protocols

6.184.4 Test datasets
---------------------

The ‘test_datasets’ directory includes the following sample sequence
datasets:

   - ‘clickstream_sequences.lgt’: A compact sequence dataset with
     repeated prefixes intended for sequential-pattern smoke tests.

   - ‘prefix_ladder_sequences.lgt’: A small ladder-shaped dataset of
     singleton events intended for exact baseline checks across
     sequential mining algorithms.

   - ‘same_event_vs_next_event_sequences.lgt’: A compact dataset
     intended to distinguish same-event extensions from next-event
     extensions.

   - ‘repeated_embedding_sequences.lgt’: A dataset where the same
     subsequence admits multiple embeddings inside a single sequence,
     intended for support-count semantics checks.

   - ‘border_threshold_sequences.lgt’: A compact dataset with patterns
     just above and below typical support thresholds, intended for
     pruning and threshold regression tests.

   - ‘closure_sequences.lgt’: A compact dataset intended for
     closed-pattern tests where some frequent patterns share the same
     support as one of their supersequences.

   - ‘dense_overlap_sequences.lgt’: A denser dataset with overlapping
     subsequences and mixed singleton and multi-item events, intended
     for overlap-heavy mining scenarios.

   - ‘branching_sequences.lgt’: A dataset with a common prefix and
     several competing branches, intended for candidate-generation and
     branching coverage.

The directory also includes invalid fixtures useful for validation and
error-handling tests:

   - ‘invalid_undeclared_item_sequences.lgt’: Uses an item not listed in
     the declared item domain.

   - ‘invalid_unsorted_itemset_sequences.lgt’: Uses an event with items
     not in canonical sorted order.

   - ‘invalid_duplicate_item_in_event_sequences.lgt’: Uses an event with
     a duplicate item.

   - ‘invalid_empty_event_sequences.lgt’: Uses an empty event inside a
     sequence.


File: TheLogtalkHandbook-3.100.1.info,  Node: sets,  Next: sgd_classifier,  Prev: sequential_pattern_mining_protocols,  Up: Libraries

6.185 ‘sets’
============

This library provides a set protocol, two implementations of this
protocol using 'ordered lists' (one of them a parametric object that
takes the type of the set elements as a parameter), and an
implementation using 'treaps' (tree heaps).

The set representations should be regarded as 'opaque terms' and only
constructed, accessed, and updated them using the library predicates.

For small sets, the ordered list implementations are likely to provide
the best performance.  For larger sets, the treap implementation likely
provides better performance, notably for the ‘memberchk/2’, ‘insert/3’,
and ‘delete/3’ operations.  Benchmark both implementations to select the
best one for your application.

The current implementations use ‘==/2’ for element comparison and
standard term ordering.  This allows non-ground set elements.  But
requires caution with later unifications with output arguments and when
using the ‘member/2’ and ‘select/3’ predicates, which can break the
ordered representation.  Note also that, per the ISO Prolog Core
Standard, variable ordering is implementation dependent.  This can
result in unexpected results and portability issues.

* Menu:

* API documentation: API documentation<199>.
* Loading: Loading<201>.
* Testing: Testing<192>.
* Usage: Usage<96>.
* Credits: Credits<5>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<199>,  Next: Loading<201>,  Up: sets

6.185.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#sets’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<201>,  Next: Testing<192>,  Prev: API documentation<199>,  Up: sets

6.185.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(sets(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<192>,  Next: Usage<96>,  Prev: Loading<201>,  Up: sets

6.185.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(sets(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<96>,  Next: Credits<5>,  Prev: Testing<192>,  Up: sets

6.185.4 Usage
-------------

First, select a set implementation.  Use the ‘set(Type)’ object if you
want to type-check the set elements.  Otherwise, use the ‘set’ object.

To create a new set, you can use the ‘new/1’ predicate.  For example:

     | ?- set::new(Set).
     Set = []
     yes

You can also create a new set with all unique elements from a list of
terms by using the ‘as_set/2’ predicate.  For example:

     | ?- set::as_set([1,3,2,1,2], Set).
     Set = [1, 2, 3]
     yes

Predicates are provided for the most common set operations.  For
example:

     | ?- set::(
             as_set([1,3,2,1,2], Set1),
             as_set([7,4,2,5,1], Set2),
             intersection(Set1, Set2, Intersection),
             symdiff(Set1, Set2, Difference)
         ).
     Set1 = [1, 2, 3],
     Set2 = [1, 2, 4, 5, 7],
     Intersection = [1, 2],
     Difference = [3, 4, 5, 7]
     yes

When working with a custom type of set elements and the ordered list
representation, the corresponding object must implement the ‘comparingp’
protocol.  For example:

     :- object(rainbow_colors,
         implements(comparingp)).

         order(red,    1).
         order(orange, 2).
         order(yellow, 3).
         order(green,  4).
         order(blue,   5).
         order(indigo, 6).
         order(violet, 7).

         Color1 < Color2 :-
             order(Color1, N1),
             order(Color2, N2),
             {N1 < N2}.

         Color1 =< Color2 :-
             order(Color1, N1),
             order(Color2, N2),
             {N1 =< N2}.

         ...

     :- end_object.

We can then use this object with the ‘set/1’ parametric object.  For
example:

     | ?- set(rainbow_colors)::as_set([blue, yellow, violet], Set).
     Set = [yellow, blue, violet]
     yes

For details on these and other provided predicates, consult the library
API documentation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Credits<5>,  Prev: Usage<96>,  Up: sets

6.185.5 Credits
---------------

Some predicates adapted from code authored by Richard O’Keefe.


File: TheLogtalkHandbook-3.100.1.info,  Node: sgd_classifier,  Next: snowflakeid,  Prev: sets,  Up: Libraries

6.186 ‘sgd_classifier’
======================

Linear stochastic-gradient classifier for tabular datasets using a
one-vs-rest scheme with configurable losses.  The implementation reuses
the shared linear encoder pipeline so continuous and categorical
features, including missing values, are represented consistently with
the existing linear classifiers.

The library implements the ‘classifier_protocol’ defined in the
‘classification_protocols’ library.  It provides predicates for learning
a classifier from a dataset, using it to make predictions, estimating
class probabilities, and exporting it as a list of predicate clauses or
to a file.

Datasets are represented as objects implementing the ‘dataset_protocol’
protocol from the ‘classification_protocols’ library.  Continuous,
categorical, and mixed-feature datasets are supported.

* Menu:

* API documentation: API documentation<200>.
* Loading: Loading<202>.
* Testing: Testing<193>.
* Features: Features<73>.
* Options: Options<69>.
* Usage: Usage<97>.
* Classifier representation: Classifier representation<12>.
* References: References<50>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<200>,  Next: Loading<202>,  Up: sgd_classifier

6.186.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#sgd_classifier’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<202>,  Next: Testing<193>,  Prev: API documentation<200>,  Up: sgd_classifier

6.186.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(sgd_classifier(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<193>,  Next: Features<73>,  Prev: Loading<202>,  Up: sgd_classifier

6.186.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(sgd_classifier(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<73>,  Next: Options<69>,  Prev: Testing<193>,  Up: sgd_classifier

6.186.4 Features
----------------

   - 'Binary and Multiclass Classification': Learns one-vs-rest linear
     models and predicts the class with the highest decision score.

   - 'Multiple Losses': Supports ‘log_loss’, ‘hinge’, ‘squared_hinge’,
     ‘modified_huber’, and ‘perceptron’ losses.

   - 'Mixed Features': Reuses the shared tabular encoders for continuous
     and categorical attributes, including missing-value indicators.

   - 'Probability Estimation': Provides class probabilities using a
     softmax over linear decision scores.

   - 'Configurable Optimization': Exposes learning-rate scheduling,
     convergence tolerance, and L2 regularization options.

   - 'Classifier Export': Learned classifiers can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<69>,  Next: Usage<97>,  Prev: Features<73>,  Up: sgd_classifier

6.186.5 Options
---------------

The ‘learn/3’ predicate supports these options:

   - ‘loss/1’ - optimization loss, one of ‘log_loss’, ‘hinge’,
     ‘squared_hinge’, ‘modified_huber’, or ‘perceptron’ (default:
     ‘log_loss’)

   - ‘learning_rate/1’ - base learning rate for optimization (default:
     ‘0.05’)

   - ‘learning_schedule/1’ - learning-rate schedule, either ‘constant’
     or ‘inverse_scaling(Power)’ (default: ‘constant’)

   - ‘maximum_iterations/1’ - maximum number of optimization epochs
     (default: ‘100’)

   - ‘tolerance/1’ - convergence threshold for the maximum parameter
     update (default: ‘1.0e-5’)

   - ‘l2_regularization/1’ - L2 penalty factor applied to the weight
     vectors (default: ‘0.0001’)

   - ‘feature_scaling/1’ - whether to standardize continuous attributes
     before encoding (default: ‘true’)


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<97>,  Next: Classifier representation<12>,  Prev: Options<69>,  Up: sgd_classifier

6.186.6 Usage
-------------

* Menu:

* Learning a classifier: Learning a classifier<7>.
* Making predictions: Making predictions<7>.
* Exporting the classifier: Exporting the classifier<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a classifier<7>,  Next: Making predictions<7>,  Up: Usage<97>

6.186.6.1 Learning a classifier
...............................

     | ?- sgd_classifier::learn(weather, Classifier).

     | ?- sgd_classifier::learn(mixed, Classifier, [loss(hinge), maximum_iterations(250)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Making predictions<7>,  Next: Exporting the classifier<7>,  Prev: Learning a classifier<7>,  Up: Usage<97>

6.186.6.2 Making predictions
............................

     | ?- sgd_classifier::learn(weather, Classifier),
          sgd_classifier::predict(Classifier, [outlook-rainy, temperature-mild, humidity-normal, windy-false], Class).

     | ?- sgd_classifier::learn(missing_mixed, Classifier),
          sgd_classifier::predict_probabilities(Classifier, [age-38, income-72000, student-yes, credit_rating-fair], Probabilities).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting the classifier<7>,  Prev: Making predictions<7>,  Up: Usage<97>

6.186.6.3 Exporting the classifier
..................................

     | ?- sgd_classifier::learn(weather, Classifier),
          sgd_classifier::export_to_clauses(weather, Classifier, classify, Clauses).

     | ?- sgd_classifier::learn(weather, Classifier),
          sgd_classifier::export_to_file(weather, Classifier, classify, 'classifier.pl').


File: TheLogtalkHandbook-3.100.1.info,  Node: Classifier representation<12>,  Next: References<50>,  Prev: Usage<97>,  Up: sgd_classifier

6.186.7 Classifier representation
---------------------------------

The learned classifier is represented as a compound term with the form:

     sgd_classifier(Classes, Encoders, Loss, Models, Options)

Where:

   - ‘Classes’: list of class labels

   - ‘Encoders’: list of continuous scaling descriptors and categorical
     value encoders

   - ‘Loss’: selected optimization loss

   - ‘Models’: list of ‘class_model(Class, Bias, Weights)’ terms

   - ‘Options’: merged training options used to learn the classifier

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
classifier term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<50>,  Prev: Classifier representation<12>,  Up: sgd_classifier

6.186.8 References
------------------

  1. Bottou, L. (2010).  “Large-Scale Machine Learning with Stochastic
     Gradient Descent”.

  2. Shalev-Shwartz, S. and Ben-David, S. (2014).  “Understanding
     Machine Learning”.  Chapter 15.

  3. Hastie, T., Tibshirani, R. and Friedman, J. (2009).  “The Elements
     of Statistical Learning”.  Chapter 12.


File: TheLogtalkHandbook-3.100.1.info,  Node: snowflakeid,  Next: sockets,  Prev: sgd_classifier,  Up: Libraries

6.187 ‘snowflakeid’
===================

This library generates Snowflake-style identifiers using a generic
generator object and predefined profile objects.

'This library requires a backend supporting unbounded integer
arithmetic.'

See also the ‘cuid2’, ‘ids’, ‘nanoid’, ‘ksuid’, ‘uuid’, and ‘ulid’
libraries.

* Menu:

* API documentation: API documentation<201>.
* Loading: Loading<203>.
* Testing: Testing<194>.
* Usage: Usage<98>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<201>,  Next: Loading<203>,  Up: snowflakeid

6.187.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#snowflakeid’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<203>,  Next: Testing<194>,  Prev: API documentation<201>,  Up: snowflakeid

6.187.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(snowflakeid(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<194>,  Next: Usage<98>,  Prev: Loading<203>,  Up: snowflakeid

6.187.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(snowflakeid(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<98>,  Prev: Testing<194>,  Up: snowflakeid

6.187.4 Usage
-------------

The generic generator is the parametric object:

     snowflakeid(Representation, EpochMilliseconds, TimeUnitMilliseconds, TimestampBits, NodeBits, SequenceBits, Node)

where ‘Representation’ can be ‘integer’, ‘atom’, ‘chars’, or ‘codes’.

Predefined profiles are provided as objects extending the generic
object:

   - ‘snowflakeid_twitter(_Representation_)’

   - ‘snowflakeid_sonyflake(_Representation_)’

   - ‘snowflakeid_instagram(_Representation_)’

The default object ‘snowflakeid’ uses the Twitter-style profile with
atom representation.

To generate a Snowflake ID using the default Twitter-style profile:

     | ?- snowflakeid::generate(ID).
     ID = '1917401915609202688'
     yes

To generate a Twitter-style Snowflake ID represented as an integer:

     | ?- snowflakeid_twitter(integer)::generate(ID).
     ID = 1917401915609202688
     yes

To generate a Sonyflake-style Snowflake ID represented as chars:

     | ?- snowflakeid_sonyflake(chars)::generate(ID).
     ID = ['9','2','8','5','6','7','2','8','0','1','4','8','9','5','5','7','5','9']
     yes

To define a custom profile:

     | ?- snowflakeid(atom, 1704067200000, 1, 41, 10, 12, 7)::generate(ID).
     ID = '28842191400263680'
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: sockets,  Next: spade_pattern_miner,  Prev: snowflakeid,  Up: Libraries

6.188 ‘sockets’
===============

Portable abstraction over TCP sockets.  Provides a high-level API for
client and server socket operations that works across all supported
backend Prolog systems: ECLiPSe, GNU Prolog, SICStus Prolog, SWI-Prolog,
Trealla Prolog, and XVM.

* Menu:

* Design rationale::
* API documentation: API documentation<202>.
* Loading: Loading<204>.
* Testing: Testing<195>.
* Usage: Usage<99>.
* API Summary: API Summary<3>.
* Backend-specific notes::
* Known issues: Known issues<19>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Design rationale,  Next: API documentation<202>,  Up: sockets

6.188.1 Design rationale
------------------------

Different Prolog systems provide socket functionality at different
abstraction levels.  Some backends (notably SICStus Prolog and Trealla
Prolog) do not provide low-level socket creation predicates that can be
separated from binding or connecting.  This library therefore provides a
higher-level API with predicates ‘client_open/4-5’ and ‘server_open/2-3’
that abstracts over these differences.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<202>,  Next: Loading<204>,  Prev: Design rationale,  Up: sockets

6.188.2 API documentation
-------------------------

Open the ‘../../apis/library_index.html#sockets’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<204>,  Next: Testing<195>,  Prev: API documentation<202>,  Up: sockets

6.188.3 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(sockets(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<195>,  Next: Usage<99>,  Prev: Loading<204>,  Up: sockets

6.188.4 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(sockets(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<99>,  Next: API Summary<3>,  Prev: Testing<195>,  Up: sockets

6.188.5 Usage
-------------

* Menu:

* Creating a client connection::
* Creating a server::
* Getting the current host name::


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating a client connection,  Next: Creating a server,  Up: Usage<99>

6.188.5.1 Creating a client connection
......................................

To connect to a server using default options:

     ?- socket::client_open(localhost, 8080, Input, Output).

The predicates ‘client_open/4-5’ and ‘server_accept/4-5’ return separate
input and output streams.  For backends where the same stream is used
for bidirectional communication (SICStus Prolog and ECLiPSe), the same
stream handle is returned in both arguments.  Use ‘socket::close/2’ to
close both streams when done.


File: TheLogtalkHandbook-3.100.1.info,  Node: Creating a server,  Next: Getting the current host name,  Prev: Creating a client connection,  Up: Usage<99>

6.188.5.2 Creating a server
...........................

To create a server that accepts connections using default options on all
interfaces:

     ?- socket::server_open(8080, ServerSocket),
        socket::server_accept(ServerSocket, Input, Output, ClientInfo),
        % ... communicate with client using Input and Output ...
        socket::close(Input, Output),
        socket::server_close(ServerSocket).

If the port is passed as a variable to the ‘server_open/2-3’ predicates,
an available port will be selected and unified with the variable.

The ‘server_open/4’ predicate can be used to accept a connection only on
the given interface.


File: TheLogtalkHandbook-3.100.1.info,  Node: Getting the current host name,  Prev: Creating a server,  Up: Usage<99>

6.188.5.3 Getting the current host name
.......................................

     ?- socket::current_host(Host).


File: TheLogtalkHandbook-3.100.1.info,  Node: API Summary<3>,  Next: Backend-specific notes,  Prev: Usage<99>,  Up: sockets

6.188.6 API Summary
-------------------

   - ‘client_open(+Host, +Port, -InputStream, -OutputStream, +Options)’
     - Connect to a server

   - ‘client_open(+Host, +Port, -InputStream, -OutputStream)’ - Connect
     to a server using default options

   - ‘server_open(+Host, ?Port, -ServerSocket, +Options)’ - Create a
     server socket on the given interface

   - ‘server_open(?Port, -ServerSocket, +Options)’ - Create a server
     socket on all interfaces

   - ‘server_open(?Port, -ServerSocket)’ - Create a server socket using
     default options

   - ‘server_accept(+ServerSocket, -InputStream, -OutputStream,
     -ClientInfo, +Options)’ - Accept connection

   - ‘server_accept(+ServerSocket, -InputStream, -OutputStream,
     -ClientInfo)’ - Accept connection using default options

   - ‘server_close(+ServerSocket)’ - Close a server socket

   - ‘close(+InputStream, +OutputStream)’ - Close a client or accepted
     connection

   - ‘current_host(-Host)’ - Get the current machine’s hostname


File: TheLogtalkHandbook-3.100.1.info,  Node: Backend-specific notes,  Next: Known issues<19>,  Prev: API Summary<3>,  Up: sockets

6.188.7 Backend-specific notes
------------------------------

* Menu:

* Stream representation::
* Binary and text modes::


File: TheLogtalkHandbook-3.100.1.info,  Node: Stream representation,  Next: Binary and text modes,  Up: Backend-specific notes

6.188.7.1 Stream representation
...............................

The library provides separate input and output stream arguments in
‘client_open/4-5’ and ‘server_accept/4-5’.  For backends where the same
stream is used for bidirectional communication (ECLiPSe, SICStus Prolog,
and Trealla Prolog), the same stream handle is returned in both the
input and output arguments.  For backends that use separate streams (GNU
Prolog and SWI-Prolog), separate stream handles are returned.


File: TheLogtalkHandbook-3.100.1.info,  Node: Binary and text modes,  Prev: Stream representation,  Up: Backend-specific notes

6.188.7.2 Binary and text modes
...............................

The library automatically sets streams by default to binary mode (e.g.,
for sending and receiving raw bytes).  An option is supported for
opening streams in text mode.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<19>,  Prev: Backend-specific notes,  Up: sockets

6.188.8 Known issues
--------------------

Recent versions of macOS seem to disable the mapping of ‘localhost’ to
‘127.0.0.1’.  This issue may prevent some functionality from working.
This can be fixed either by editing the ‘/etc/hosts’ file or by using
‘'127.0.0.1'’ as the host argument instead of ‘localhost’.


File: TheLogtalkHandbook-3.100.1.info,  Node: spade_pattern_miner,  Next: simulated_annealing,  Prev: sockets,  Up: Libraries

6.189 ‘spade_pattern_miner’
===========================

SPADE sequential pattern miner for sequence datasets.  The library
depends on the ‘sequential_pattern_mining_protocols’ support library,
implements the generic ‘pattern_miner_protocol’ defined in the
‘pattern_mining_protocols’ core library, and mines frequent sequential
patterns using Zaki’s equivalence-class decomposition with temporal
joins over vertical occurrence lists keyed by sequence and event
identifiers.

Requires a dataset implementing ‘sequence_dataset_protocol’ with
sequences represented as ordered lists of canonical sorted itemsets over
a declared item domain.

* Menu:

* API documentation: API documentation<203>.
* Loading: Loading<205>.
* Testing: Testing<196>.
* Features: Features<74>.
* Options: Options<70>.
* Pattern miner representation: Pattern miner representation<7>.
* References: References<51>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<203>,  Next: Loading<205>,  Up: spade_pattern_miner

6.189.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#spade_pattern_miner’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<205>,  Next: Testing<196>,  Prev: API documentation<203>,  Up: spade_pattern_miner

6.189.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(spade_pattern_miner(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<196>,  Next: Features<74>,  Prev: Loading<205>,  Up: spade_pattern_miner

6.189.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(spade_pattern_miner(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<74>,  Next: Options<70>,  Prev: Testing<196>,  Up: spade_pattern_miner

6.189.4 Features
----------------

   - 'Equivalence-Class Decomposition': Mines frequent sequences using
     Zaki’s equivalence-class decomposition over prefix-sharing classes.

   - 'Vertical Occurrence Lists': Represents frequent patterns using
     sequence and event occurrence lists.

   - 'Active Class Candidate Pruning': Restricts class joins to members
     that occur in the supporting sequences of the current prefix, using
     per-sequence member-id indexes instead of storing full pattern
     terms in the sequence index.

   - 'Same-Event and Sequence Extensions': Supports both itemset growth
     and next-event sequence growth.

   - 'Canonical Sequences': Validates that itemsets are sorted,
     duplicate-free, non-empty, and restricted to declared items.

   - 'Flexible Support Thresholds': Supports relative minimum support
     and absolute minimum support count.

   - 'Model Export': Mined pattern collections can be exported as
     predicate clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<70>,  Next: Pattern miner representation<7>,  Prev: Features<74>,  Up: spade_pattern_miner

6.189.5 Options
---------------

The ‘mine/3’ predicate accepts the following options:

   - ‘minimum_support/1’: Relative minimum support threshold in the
     interval ‘]0.0, 1.0]’.  The default is ‘0.5’.

   - ‘minimum_support_count/1’: Absolute minimum support count.  When
     both support options are provided, this option takes precedence.

   - ‘maximum_pattern_length/1’: Maximum total number of items in a
     mined sequential pattern.  The default is ‘1000’, effectively
     capped by the longest sequence in the dataset.

   - ‘minimum_pattern_length/1’: Minimum total number of items retained
     in the mined result.  The default is ‘1’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Pattern miner representation<7>,  Next: References<51>,  Prev: Options<70>,  Up: spade_pattern_miner

6.189.6 Pattern miner representation
------------------------------------

The mined pattern miner result is represented by a compound term with
the functor chosen by the implementation and arity 3.  For example:

     spade_pattern_miner(ItemDomain, Patterns, Options)

Where:

   - ‘ItemDomain’: Canonical sorted list of declared dataset items.

   - ‘Patterns’: List of ‘sequence_pattern(Pattern, SupportCount)’ terms
     ordered first by total item count and then lexicographically.

   - ‘Options’: Effective mining options used to mine the frequent
     sequential patterns.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<51>,  Prev: Pattern miner representation<7>,  Up: spade_pattern_miner

6.189.7 References
------------------

  1. Zaki, M. J. (2001) - “SPADE: An efficient algorithm for mining
     frequent sequences”.


File: TheLogtalkHandbook-3.100.1.info,  Node: simulated_annealing,  Next: statistics,  Prev: spade_pattern_miner,  Up: Libraries

6.190 ‘simulated_annealing’
===========================

Simulated annealing is a probabilistic meta-heuristic for approximating
the global optimum of a given function.  It is particularly useful for
combinatorial optimization problems such as the Traveling Salesman
Problem (TSP), graph coloring, and scheduling.

The library provides the parametric object ‘simulated_annealing(Problem,
RandomAlgorithm)’ where ‘Problem’ is an object implementing the
‘simulated_annealing_protocol’ protocol and ‘RandomAlgorithm’ is one of
the algorithms supported by the ‘fast_random’ library.  The algorithm
minimizes the energy (cost) function defined by the problem.

A convenience object ‘simulated_annealing(Problem)’ is also provided,
using the Xoshiro128++ random number generator (‘xoshiro128pp’) as the
default.

* Menu:

* API documentation: API documentation<204>.
* Loading: Loading<206>.
* Testing: Testing<197>.
* Features: Features<75>.
* Defining a problem::
* Options: Options<71>.
* Run statistics::
* Usage: Usage<100>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<204>,  Next: Loading<206>,  Up: simulated_annealing

6.190.1 API documentation
-------------------------

Open the ‘../../docs/library_index.html#simulated-annealing’ link in a
web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<206>,  Next: Testing<197>,  Prev: API documentation<204>,  Up: simulated_annealing

6.190.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(simulated_annealing(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<197>,  Next: Features<75>,  Prev: Loading<206>,  Up: simulated_annealing

6.190.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(simulated_annealing(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<75>,  Next: Defining a problem,  Prev: Testing<197>,  Up: simulated_annealing

6.190.4 Features
----------------

   - 'Configurable random number generator' — the algorithm is
     parameterized by a ‘fast_random’ algorithm.  Available algorithms
     include ‘xoshiro128pp’, ‘xoshiro128ss’, ‘xoshiro256pp’,
     ‘xoshiro256ss’, ‘well512a’, ‘splitmix64’, and ‘as183’.  The
     convenience object ‘simulated_annealing(Problem)’ defaults to
     ‘xoshiro128pp’.

   - 'Boltzmann acceptance criterion' — a worse neighbor is accepted
     with probability ‘exp(-DeltaE / Temperature)’, allowing the search
     to escape local minima early in the run while converging as the
     temperature cools.

   - 'Configurable cooling schedule' — default geometric cooling
     (‘NewTemp is Temp * 0.995’), overridable by defining
     ‘cooling_schedule/3’ in the problem object.

   - 'Custom stop conditions' — the search stops when the maximum number
     of steps is reached or the temperature drops below the minimum
     temperature.  A problem object can define ‘stop_condition/3’ to
     terminate early (e.g.  when a good-enough solution is found).

   - 'Delta-energy optimization' — when the problem object defines
     ‘neighbor_state/3’, the algorithm uses the returned energy delta
     directly instead of recomputing the full energy.  This is useful
     when computing the change is cheaper than evaluating the full cost
     (e.g.  a 2-opt swap in TSP).

   - 'Best state tracking' — the algorithm tracks the best state found
     across all iterations and across all restart cycles, not just the
     final state.

   - 'Progress reporting' — if the problem object defines ‘progress/5’,
     it is called periodically with the current step, temperature, best
     energy, acceptance rate, and improvement rate.  A final report is
     always produced when the loop terminates.

   - 'Run statistics' — the ‘run/4’ predicate returns a list of
     statistics including the number of steps, acceptances,
     improvements, and the final temperature.

   - 'Seed control' — the ‘seed(S)’ option initializes the random number
     generator for reproducible runs.

   - 'Reheating restarts' — the ‘restarts(N)’ option runs N additional
     SA cycles after the first.  Each restart reheats the temperature to
     the initial value and begins from the best state found so far,
     allowing the search to escape deep local minima.  Statistics
     accumulate across all cycles.

   - 'Auto-temperature estimation' — the ‘estimate_temperature/1-2’
     predicates sample random neighbor transitions and compute an
     initial temperature that would produce a target acceptance rate,
     avoiding manual tuning.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a problem,  Next: Options<71>,  Prev: Features<75>,  Up: simulated_annealing

6.190.5 Defining a problem
--------------------------

A problem object must implement the ‘simulated_annealing_protocol’
protocol by defining (at least) the following four predicates:

   - ‘initial_state(-State)’ — returns the starting state.

   - ‘neighbor_state(+State, -Neighbor)’ — generates a neighboring
     state.

   - ‘state_energy(+State, -Energy)’ — computes the cost of a state (to
     be minimized).

   - ‘initial_temperature(-Temperature)’ — returns the starting
     temperature.

Optionally, the problem object may also define:

   - ‘neighbor_state(+State, -Neighbor, -DeltaEnergy)’ — generates a
     neighboring state and returns the energy change directly, avoiding
     a full energy recomputation.  Useful when computing the delta is
     cheaper than recomputing the full energy (e.g.  TSP with a 2-opt
     swap).

   - ‘cooling_schedule(+Temperature, +Step, -NewTemperature)’ — computes
     the next temperature.  Default: geometric cooling (‘NewTemp is Temp
     * 0.995’).

   - ‘stop_condition(+Step, +Temperature, +BestEnergy)’ — succeeds when
     the search should terminate early (e.g.  when a good-enough
     solution is found).  Default: the search runs until the maximum
     number of steps is reached or the temperature drops below the
     minimum temperature.

   - ‘progress(+Step, +Temperature, +BestEnergy, +AcceptanceRate,
     +ImprovementRate)’ — called periodically during the optimization to
     report progress.  A final report is always produced when the loop
     terminates.  The acceptance and improvement rates are floats
     between 0.0 and 1.0.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<71>,  Next: Run statistics,  Prev: Defining a problem,  Up: simulated_annealing

6.190.6 Options
---------------

Options for the ‘run/3-4’ predicates:

   - ‘max_steps(N)’ — maximum number of iterations per cycle (default:
     ‘10000’).

   - ‘min_temperature(T)’ — minimum temperature floor; the search stops
     when the temperature drops below this value (default: ‘0.001’).

   - ‘updates(N)’ — number of progress reports during the run.  Progress
     is reported by calling ‘progress/5’ on the problem object.  Set to
     ‘0’ to disable (default: ‘0’).

   - ‘seed(S)’ — positive integer seed for the random number generator,
     enabling reproducible runs (default: none).

   - ‘restarts(N)’ — number of additional SA cycles after the first.
     Each restart reheats the temperature to the initial value and
     begins from the best state found so far, allowing the search to
     escape local minima (default: ‘0’).

Options for the ‘estimate_temperature/2’ predicate:

   - ‘samples(N)’ — number of random neighbor transitions to sample
     (default: ‘200’).

   - ‘acceptance_rate(P)’ — target initial acceptance rate as an integer
     percentage between 1 and 99 (default: ‘80’).


File: TheLogtalkHandbook-3.100.1.info,  Node: Run statistics,  Next: Usage<100>,  Prev: Options<71>,  Up: simulated_annealing

6.190.7 Run statistics
----------------------

The ‘run/4’ predicate returns a list of statistics about the completed
run:

   - ‘steps(N)’ — total number of steps executed.

   - ‘acceptances(A)’ — number of accepted moves (both improving and
     uphill).

   - ‘improvements(I)’ — number of moves that strictly improved the best
     energy found.

   - ‘final_temperature(T)’ — temperature at termination.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<100>,  Prev: Run statistics,  Up: simulated_annealing

6.190.8 Usage
-------------

* Menu:

* Defining a problem: Defining a problem<2>.
* Running the algorithm::
* Running with custom options::
* Running with statistics::
* Reproducible runs with seed::
* Reheating restarts::
* Auto-temperature estimation::
* Using a custom random number generator::


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining a problem<2>,  Next: Running the algorithm,  Up: Usage<100>

6.190.8.1 Defining a problem
............................

Define an object implementing the ‘simulated_annealing_protocol’
protocol.  For example, a simple quadratic minimization problem:

     :- object(quadratic,
         implements(simulated_annealing_protocol)).

         initial_state(50.0).
         neighbor_state(X, Y) :-
             random::random(-5.0, 5.0, Delta),
             Y is X + Delta.
         state_energy(X, E) :-
             E is (X - 3.0) * (X - 3.0).
         initial_temperature(100.0).

     :- end_object.


File: TheLogtalkHandbook-3.100.1.info,  Node: Running the algorithm,  Next: Running with custom options,  Prev: Defining a problem<2>,  Up: Usage<100>

6.190.8.2 Running the algorithm
...............................

     | ?- simulated_annealing(quadratic)::run(State, Energy).
     State = 3.001..., Energy = 0.000...


File: TheLogtalkHandbook-3.100.1.info,  Node: Running with custom options,  Next: Running with statistics,  Prev: Running the algorithm,  Up: Usage<100>

6.190.8.3 Running with custom options
.....................................

     | ?- simulated_annealing(quadratic)::run(State, Energy, [max_steps(50000)]).
     State = 3.000..., Energy = 0.000...


File: TheLogtalkHandbook-3.100.1.info,  Node: Running with statistics,  Next: Reproducible runs with seed,  Prev: Running with custom options,  Up: Usage<100>

6.190.8.4 Running with statistics
.................................

     | ?- simulated_annealing(quadratic)::run(State, Energy, Stats, []).
     State = 3.001..., Energy = 0.000...,
     Stats = [steps(10000), acceptances(...), improvements(...), final_temperature(...)]


File: TheLogtalkHandbook-3.100.1.info,  Node: Reproducible runs with seed,  Next: Reheating restarts,  Prev: Running with statistics,  Up: Usage<100>

6.190.8.5 Reproducible runs with seed
.....................................

     | ?- simulated_annealing(quadratic)::run(S1, E1, [seed(42)]),
          simulated_annealing(quadratic)::run(S2, E2, [seed(42)]).
     S1 = S2, E1 = E2.


File: TheLogtalkHandbook-3.100.1.info,  Node: Reheating restarts,  Next: Auto-temperature estimation,  Prev: Reproducible runs with seed,  Up: Usage<100>

6.190.8.6 Reheating restarts
............................

Run 3 SA cycles (1 initial + 2 restarts).  Each restart reheats the
temperature and begins from the best state found so far:

     | ?- simulated_annealing(quadratic)::run(State, Energy, [restarts(2)]).
     State = 3.000..., Energy = 0.000...


File: TheLogtalkHandbook-3.100.1.info,  Node: Auto-temperature estimation,  Next: Using a custom random number generator,  Prev: Reheating restarts,  Up: Usage<100>

6.190.8.7 Auto-temperature estimation
.....................................

Estimate a good initial temperature for the problem by sampling random
neighbor transitions:

     | ?- simulated_annealing(quadratic)::estimate_temperature(T).
     T = ...

With custom parameters (500 samples, 90% target acceptance rate):

     | ?- simulated_annealing(quadratic)::estimate_temperature(T, [samples(500), acceptance_rate(90)]).
     T = ...


File: TheLogtalkHandbook-3.100.1.info,  Node: Using a custom random number generator,  Prev: Auto-temperature estimation,  Up: Usage<100>

6.190.8.8 Using a custom random number generator
................................................

Use the two-parameter version to select a specific ‘fast_random’
algorithm:

     | ?- simulated_annealing(quadratic, well512a)::run(State, Energy).
     State = 3.001..., Energy = 0.000...

     | ?- simulated_annealing(quadratic, xoshiro256ss)::run(State, Energy, [seed(42)]).
     State = 3.000..., Energy = 0.000...


File: TheLogtalkHandbook-3.100.1.info,  Node: statistics,  Next: stemming,  Prev: simulated_annealing,  Up: Libraries

6.191 ‘statistics’
==================

The entities in this library define some useful predicates for
descriptive statistics.  Data is represented as a list of numbers
(integers or floats).  Use the object ‘sample’ if your data represents a
sample.  Use the object ‘population’ if your data represents a
population.

The ‘variance/2’, ‘standard_deviation/2’, ‘skewness/2’, ‘kurtosis/2’,
‘covariance/3’, ‘standard_error/2’, ‘correlation/3’, and
‘rank_correlation/3’ predicates use different formulas depending on
whether the data represents a sample (dividing by 'N-1') or a population
(dividing by 'N'). All other predicates share the same implementation.

* Menu:

* API documentation: API documentation<205>.
* Loading: Loading<207>.
* Testing: Testing<198>.
* API overview::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<205>,  Next: Loading<207>,  Up: statistics

6.191.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#statistics’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<207>,  Next: Testing<198>,  Prev: API documentation<205>,  Up: statistics

6.191.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(statistics(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<198>,  Next: API overview,  Prev: Loading<207>,  Up: statistics

6.191.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(statistics(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: API overview,  Prev: Testing<198>,  Up: statistics

6.191.4 API overview
--------------------

* Menu:

* Aggregation::
* Extremes and Range::
* Central Tendency::
* Measures of Position / Quantiles::
* Measures of Dispersion::
* Measures of Shape::
* Measures of Association::
* Error Metrics::
* Normalization::
* Frequency / Counting::
* Validation: Validation<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Aggregation,  Next: Extremes and Range,  Up: API overview

6.191.4.1 Aggregation
.....................

Predicate         Description
                  
--------------------------------------------------
‘product/2’       Product of all list numbers
                  
‘sum/2’           Sum of all list numbers
                  


File: TheLogtalkHandbook-3.100.1.info,  Node: Extremes and Range,  Next: Central Tendency,  Prev: Aggregation,  Up: API overview

6.191.4.2 Extremes and Range
............................

Predicate         Description
                  
-------------------------------------------------
‘min/2’           Minimum value
                  
‘max/2’           Maximum value
                  
‘min_max/3’       Minimum and maximum values
                  
‘range/2’         Range (max - min)
                  


File: TheLogtalkHandbook-3.100.1.info,  Node: Central Tendency,  Next: Measures of Position / Quantiles,  Prev: Extremes and Range,  Up: API overview

6.191.4.3 Central Tendency
..........................

Predicate                   Description
                            
-------------------------------------------------------------------------------
‘arithmetic_mean/2’         Arithmetic mean
                            
‘geometric_mean/2’          Geometric mean
                            
‘harmonic_mean/2’           Harmonic mean
                            
‘weighted_mean/3’           Weighted mean
                            
‘trimmed_mean/3’            Trimmed mean (removing a fraction of extreme
                            values)
                            
‘median/2’                  Median
                            
‘modes/2’                   Modes (in ascending order)
                            


File: TheLogtalkHandbook-3.100.1.info,  Node: Measures of Position / Quantiles,  Next: Measures of Dispersion,  Prev: Central Tendency,  Up: API overview

6.191.4.4 Measures of Position / Quantiles
..........................................

Predicate                       Description
                                
-------------------------------------------------------------------------------
‘fractile/3’                    Fractile (quantile given a fraction in (0.0,
                                1.0))
                                
‘percentile/3’                  Percentile (quantile given a value in (0,
                                100))
                                
‘quartiles/4’                   Quartiles (Q1, Q2, Q3)
                                
‘interquartile_range/2’         Interquartile range (Q3 - Q1)
                                


File: TheLogtalkHandbook-3.100.1.info,  Node: Measures of Dispersion,  Next: Measures of Shape,  Prev: Measures of Position / Quantiles,  Up: API overview

6.191.4.5 Measures of Dispersion
................................

Predicate                               Description
                                        
-------------------------------------------------------------------------------
‘variance/2’                            Variance (sample or population)
                                        
‘standard_deviation/2’                  Standard deviation (sample or
                                        population)
                                        
‘mean_deviation/2’                      Mean absolute deviation
                                        
‘median_deviation/2’                    Median absolute deviation
                                        
‘average_deviation/3’                   Average absolute deviation from a
                                        given central tendency
                                        
‘coefficient_of_variation/2’            Coefficient of variation
                                        
‘relative_standard_deviation/2’         Relative standard deviation
                                        (percentage)
                                        
‘sum_of_squares/2’                      Sum of squared deviations from the
                                        mean
                                        
‘standard_error/2’                      Standard error of the mean
                                        


File: TheLogtalkHandbook-3.100.1.info,  Node: Measures of Shape,  Next: Measures of Association,  Prev: Measures of Dispersion,  Up: API overview

6.191.4.6 Measures of Shape
...........................

Predicate                Description
                         
--------------------------------------------------------------------
‘skewness/2’             Moment skewness (sample or population)
                         
‘kurtosis/2’             Excess kurtosis (sample or population)
                         
‘central_moment/3’       K-th central moment
                         


File: TheLogtalkHandbook-3.100.1.info,  Node: Measures of Association,  Next: Error Metrics,  Prev: Measures of Shape,  Up: API overview

6.191.4.7 Measures of Association
.................................

Predicate                  Description
                           
---------------------------------------------------------------------
‘covariance/3’             Covariance (sample or population)
                           
‘correlation/3’            Pearson correlation coefficient
                           
‘rank_correlation/3’       Spearman rank correlation coefficient
                           


File: TheLogtalkHandbook-3.100.1.info,  Node: Error Metrics,  Next: Normalization,  Prev: Measures of Association,  Up: API overview

6.191.4.8 Error Metrics
.......................

Predicate                         Description
                                  
--------------------------------------------------------------------------------
‘mean_squared_error/3’            Mean squared error between two lists
                                  
‘root_mean_squared_error/3’       Root mean squared error between two lists
                                  


File: TheLogtalkHandbook-3.100.1.info,  Node: Normalization,  Next: Frequency / Counting,  Prev: Error Metrics,  Up: API overview

6.191.4.9 Normalization
.......................

Predicate                       Description
                                
--------------------------------------------------------------------------------
‘z_normalization/2’             Z-score normalization (mean ~= 0, std ~= 1)
                                
‘min_max_normalization/2’       Min-max normalization (rescale to [0, 1])
                                


File: TheLogtalkHandbook-3.100.1.info,  Node: Frequency / Counting,  Next: Validation<2>,  Prev: Normalization,  Up: API overview

6.191.4.10 Frequency / Counting
...............................

Predicate                        Description
                                 
--------------------------------------------------------------------------------
‘frequency_distribution/2’       Frequency distribution (Value-Count pairs)
                                 


File: TheLogtalkHandbook-3.100.1.info,  Node: Validation<2>,  Prev: Frequency / Counting,  Up: API overview

6.191.4.11 Validation
.....................

Predicate       Description
                
-----------------------------------------------------
‘valid/1’       Term is a closed list of numbers
                


File: TheLogtalkHandbook-3.100.1.info,  Node: stemming,  Next: stomp,  Prev: statistics,  Up: Libraries

6.192 ‘stemming’
================

This library provides word stemming predicates for English text, with
support for different word representations: atoms, character lists, or
character code lists.

The library includes implementations of two well-known stemming
algorithms:

   - 'Porter Stemmer' - The Porter stemming algorithm (Porter, 1980) is
     a widely used algorithm for reducing English words to their root
     form by applying a series of rules that remove common suffixes.

   - 'Lovins Stemmer' - The Lovins stemming algorithm (Lovins, 1968)
     removes the longest suffix from a word using a list of endings,
     each associated with a condition for removal.  It then applies
     transformation rules to fix spelling.

* Menu:

* API documentation: API documentation<206>.
* Loading: Loading<208>.
* Testing: Testing<199>.
* Usage: Usage<101>.
* Algorithms: Algorithms<2>.
* Choosing an Algorithm::
* Known Limitations: Known Limitations<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<206>,  Next: Loading<208>,  Up: stemming

6.192.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#stemming’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<208>,  Next: Testing<199>,  Prev: API documentation<206>,  Up: stemming

6.192.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(stemming(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<199>,  Next: Usage<101>,  Prev: Loading<208>,  Up: stemming

6.192.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(stemming(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<101>,  Next: Algorithms<2>,  Prev: Testing<199>,  Up: stemming

6.192.4 Usage
-------------

The stemming predicates are defined in parametric objects where the
parameter specifies the word representation:

   - ‘atom’ - words are represented as atoms

   - ‘chars’ - words are represented as lists of characters

   - ‘codes’ - words are represented as lists of character codes

The parameter must be bound when sending messages to the objects.

* Menu:

* Porter Stemmer::
* Lovins Stemmer::


File: TheLogtalkHandbook-3.100.1.info,  Node: Porter Stemmer,  Next: Lovins Stemmer,  Up: Usage<101>

6.192.4.1 Porter Stemmer
........................

To stem a single word using atoms:

     | ?- porter_stemmer(atom)::stem(running, Stem).
     Stem = run
     yes

To stem a list of words:

     | ?- porter_stemmer(atom)::stems([running, walks, easily], Stems).
     Stems = [run, walk, easili]
     yes

Using character lists:

     | ?- porter_stemmer(chars)::stem([r,u,n,n,i,n,g], Stem).
     Stem = [r,u,n]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Lovins Stemmer,  Prev: Porter Stemmer,  Up: Usage<101>

6.192.4.2 Lovins Stemmer
........................

To stem a single word using atoms:

     | ?- lovins_stemmer(atom)::stem(running, Stem).
     Stem = run
     yes

To stem a list of words:

     | ?- lovins_stemmer(atom)::stems([running, walks, easily], Stems).
     Stems = [run, walk, eas]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Algorithms<2>,  Next: Choosing an Algorithm,  Prev: Usage<101>,  Up: stemming

6.192.5 Algorithms
------------------

* Menu:

* Porter Stemmer: Porter Stemmer<2>.
* Lovins Stemmer: Lovins Stemmer<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Porter Stemmer<2>,  Next: Lovins Stemmer<2>,  Up: Algorithms<2>

6.192.5.1 Porter Stemmer
........................

The Porter stemming algorithm, developed by Martin Porter in 1980, is
one of the most widely used stemming algorithms for the English
language.  It operates through a series of steps that progressively
remove suffixes from words:

  1. 'Step 1a': Handle plurals (e.g., “caresses” → “caress”, “ponies” →
     “poni”)

  2. 'Step 1b': Handle past tense and progressive forms (e.g., “agreed”
     → “agree”)

  3. 'Step 1c': Replace terminal “y” with “i” when preceded by a vowel

  4. 'Steps 2-4': Remove various suffixes based on the “measure” of the
     stem

  5. 'Step 5': Clean up final “e” and double consonants

The algorithm uses the concept of “measure” (m), which counts
vowel-consonant sequences in the stem, to determine when suffixes can be
safely removed.

'Reference': Porter, M.F. (1980).  An algorithm for suffix stripping.
Program, 14(3), 130-137.


File: TheLogtalkHandbook-3.100.1.info,  Node: Lovins Stemmer<2>,  Prev: Porter Stemmer<2>,  Up: Algorithms<2>

6.192.5.2 Lovins Stemmer
........................

The Lovins stemming algorithm, developed by Julie Beth Lovins in 1968,
was one of the earliest stemming algorithms.  It takes a different
approach from Porter:

  1. 'Ending removal': The algorithm maintains a list of 294 possible
     endings, ordered by length.  It removes the longest matching ending
     that satisfies its associated condition (e.g., minimum stem
     length).

  2. 'Transformation rules': After removing the ending, spelling
     transformations are applied to fix common irregularities (e.g.,
     “iev” → “ief”, “uct” → “uc”).

The Lovins algorithm tends to be more aggressive than Porter, sometimes
producing stems that are not actual words but are consistent across
related word forms.

'Reference': Lovins, J.B. (1968).  Development of a stemming algorithm.
Mechanical Translation and Computational Linguistics, 11(1-2), 22-31.


File: TheLogtalkHandbook-3.100.1.info,  Node: Choosing an Algorithm,  Next: Known Limitations<2>,  Prev: Algorithms<2>,  Up: stemming

6.192.6 Choosing an Algorithm
-----------------------------

   - 'Porter': More conservative, produces more readable stems, widely
     used in information retrieval and search applications.  Good choice
     for most applications.

   - 'Lovins': More aggressive, may conflate more word forms together.
     Can be useful when broader matching is desired, but may over-stem
     in some cases.

Both algorithms are designed for English text only.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known Limitations<2>,  Prev: Choosing an Algorithm,  Up: stemming

6.192.7 Known Limitations
-------------------------

   - Both algorithms work only with English words.

   - Stemming is not lemmatization - stems may not be valid dictionary
     words.

   - Proper nouns and abbreviations may not be handled correctly.

   - Very short words (1-2 characters) are returned unchanged.


File: TheLogtalkHandbook-3.100.1.info,  Node: stomp,  Next: string_distance,  Prev: stemming,  Up: Libraries

6.193 ‘stomp’
=============

Portable STOMP 1.2 (Simple Text Orientated Messaging Protocol) client
implementation.  This library uses the ‘sockets’ library and supports
all backend Prolog systems supported by that library: ECLiPSe, GNU
Prolog, SICStus Prolog, SWI-Prolog, Trealla Prolog, and XVM.

* Menu:

* Protocol Version: Protocol Version<2>.
* Features: Features<76>.
* API documentation: API documentation<207>.
* Loading: Loading<209>.
* Testing: Testing<200>.
* Usage: Usage<102>.
* API Summary: API Summary<4>.
* Connection Options::
* Send Options::
* Subscribe Options::
* Receive Options::
* Error Handling: Error Handling<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Protocol Version<2>,  Next: Features<76>,  Up: stomp

6.193.1 Protocol Version
------------------------

This library implements the STOMP 1.2 protocol specification:

‘https://stomp.github.io/stomp-specification-1.2.html’

STOMP 1.2 is backwards compatible with STOMP 1.1 with minor differences
in frame line endings and message acknowledgment.


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<76>,  Next: API documentation<207>,  Prev: Protocol Version<2>,  Up: stomp

6.193.2 Features
----------------

   - Full STOMP 1.2 protocol support

   - Heartbeat negotiation and automatic heartbeat handling

   - Multiple concurrent subscriptions with unique IDs

   - All acknowledgment modes: ‘auto’, ‘client’, ‘client-individual’

   - Transaction support: ‘BEGIN’, ‘COMMIT’, ‘ABORT’

   - Graceful disconnect with receipt confirmation

   - Proper frame encoding/decoding with header escaping

   - User-defined headers for messages


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<207>,  Next: Loading<209>,  Prev: Features<76>,  Up: stomp

6.193.3 API documentation
-------------------------

Open the ‘../../apis/library_index.html#stomp’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<209>,  Next: Testing<200>,  Prev: API documentation<207>,  Up: stomp

6.193.4 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(stomp(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<200>,  Next: Usage<102>,  Prev: Loading<209>,  Up: stomp

6.193.5 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(stomp(tester)).

Note: Integration tests require a running STOMP server (e.g., RabbitMQ
with the STOMP plugin, ActiveMQ, or Apache Apollo).  They are usually
run using RabbitMQ with the STOMP plugin.  As RabbitMQ uses ‘/’ as its
default virtual host, the tests assume this and use the ‘host('/')’
option when calling the ‘connect/4’ predicate (otherwise the connection
would fail with a ‘"Virtual host 'localhost' access denied"’ error
message).  To enable the RabbitMQ’s STOMP plugin:

     $ rabbitmq-plugins enable rabbitmq_stomp

RabbitMQ STOMP listens on port 61613 by default.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<102>,  Next: API Summary<4>,  Prev: Testing<200>,  Up: stomp

6.193.6 Usage
-------------

* Menu:

* Connecting to a STOMP server::
* Sending messages::
* Subscribing to destinations::
* Receiving messages::
* Acknowledging messages::
* Unsubscribing::
* Transactions: Transactions<2>.
* Disconnecting: Disconnecting<3>.
* Heartbeat handling::
* Working with frames::


File: TheLogtalkHandbook-3.100.1.info,  Node: Connecting to a STOMP server,  Next: Sending messages,  Up: Usage<102>

6.193.6.1 Connecting to a STOMP server
......................................

Basic connection assuming RabbitMQ, which uses ‘host('/')’ as shown:

     ?- stomp::connect(localhost, 61613, Connection, [host('/')]).

Connection with authentication:

     ?- stomp::connect(localhost, 61613, Connection, [
            login('user'),
            passcode('password')
        ]).

Connection with heartbeat:

     ?- stomp::connect(localhost, 61613, Connection, [
            heartbeat(10000, 10000)
        ]).

Connection with virtual host:

     ?- stomp::connect(localhost, 61613, Connection, [
            host('/my-vhost')
        ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Sending messages,  Next: Subscribing to destinations,  Prev: Connecting to a STOMP server,  Up: Usage<102>

6.193.6.2 Sending messages
..........................

Send a simple text message:

     ?- stomp::send(Connection, '/queue/test', 'Hello, World!', []).

Send a message with content type:

     ?- stomp::send(Connection, '/queue/test', '{"key":"value"}', [
            content_type('application/json')
        ]).

Send with custom headers:

     ?- stomp::send(Connection, '/queue/test', 'Message', [
            header('priority', '9'),
            header('persistent', 'true')
        ]).

Send within a transaction:

     ?- stomp::begin_transaction(Connection, 'tx-001', []),
        stomp::send(Connection, '/queue/test', 'Message 1', [transaction('tx-001')]),
        stomp::send(Connection, '/queue/test', 'Message 2', [transaction('tx-001')]),
        stomp::commit_transaction(Connection, 'tx-001', []).


File: TheLogtalkHandbook-3.100.1.info,  Node: Subscribing to destinations,  Next: Receiving messages,  Prev: Sending messages,  Up: Usage<102>

6.193.6.3 Subscribing to destinations
.....................................

Subscribe with auto acknowledgment (default):

     ?- stomp::subscribe(Connection, '/queue/test', 'sub-0', []).

Subscribe with client acknowledgment:

     ?- stomp::subscribe(Connection, '/queue/test', 'sub-0', [
            ack(client)
        ]).

Subscribe with client-individual acknowledgment:

     ?- stomp::subscribe(Connection, '/topic/events', 'sub-1', [
            ack(client_individual)
        ]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Receiving messages,  Next: Acknowledging messages,  Prev: Subscribing to destinations,  Up: Usage<102>

6.193.6.4 Receiving messages
............................

Poll for a message (non-blocking):

     ?- stomp::receive(Connection, Frame, [timeout(0)]).

Wait for a message with timeout (milliseconds):

     ?- stomp::receive(Connection, Frame, [timeout(5000)]).

Process received MESSAGE frame:

     ?- stomp::receive(Connection, Frame, []),
        stomp::frame_command(Frame, 'MESSAGE'),
        stomp::frame_header(Frame, 'destination', Destination),
        stomp::frame_header(Frame, 'message-id', MessageId),
        stomp::frame_body(Frame, Body).


File: TheLogtalkHandbook-3.100.1.info,  Node: Acknowledging messages,  Next: Unsubscribing,  Prev: Receiving messages,  Up: Usage<102>

6.193.6.5 Acknowledging messages
................................

For ‘client’ or ‘client-individual’ acknowledgment modes:

     ?- stomp::receive(Connection, Frame, []),
        stomp::frame_header(Frame, 'ack', AckId),
        stomp::ack(Connection, AckId, []).

Negative acknowledgment:

     ?- stomp::nack(Connection, AckId, []).

Acknowledgment within a transaction:

     ?- stomp::ack(Connection, AckId, [transaction('tx-001')]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Unsubscribing,  Next: Transactions<2>,  Prev: Acknowledging messages,  Up: Usage<102>

6.193.6.6 Unsubscribing
.......................

     ?- stomp::unsubscribe(Connection, 'sub-0', []).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transactions<2>,  Next: Disconnecting<3>,  Prev: Unsubscribing,  Up: Usage<102>

6.193.6.7 Transactions
......................

Begin a transaction:

     ?- stomp::begin_transaction(Connection, 'tx-001', []).

Commit a transaction:

     ?- stomp::commit_transaction(Connection, 'tx-001', []).

Abort a transaction:

     ?- stomp::abort_transaction(Connection, 'tx-001', []).


File: TheLogtalkHandbook-3.100.1.info,  Node: Disconnecting<3>,  Next: Heartbeat handling,  Prev: Transactions<2>,  Up: Usage<102>

6.193.6.8 Disconnecting
.......................

Graceful disconnect with receipt confirmation:

     ?- stomp::disconnect(Connection, []).


File: TheLogtalkHandbook-3.100.1.info,  Node: Heartbeat handling,  Next: Working with frames,  Prev: Disconnecting<3>,  Up: Usage<102>

6.193.6.9 Heartbeat handling
............................

Send a heartbeat (if needed manually):

     ?- stomp::send_heartbeat(Connection).

Check connection health:

     ?- stomp::connection_alive(Connection).


File: TheLogtalkHandbook-3.100.1.info,  Node: Working with frames,  Prev: Heartbeat handling,  Up: Usage<102>

6.193.6.10 Working with frames
..............................

Get frame command:

     ?- stomp::frame_command(Frame, Command).

Get frame header value:

     ?- stomp::frame_header(Frame, HeaderName, Value).

Get frame body:

     ?- stomp::frame_body(Frame, Body).

Get all frame headers:

     ?- stomp::frame_headers(Frame, Headers).


File: TheLogtalkHandbook-3.100.1.info,  Node: API Summary<4>,  Next: Connection Options,  Prev: Usage<102>,  Up: stomp

6.193.7 API Summary
-------------------

* Menu:

* Connection management: Connection management<2>.
* Messaging::
* Acknowledgment::
* Transactions: Transactions<3>.
* Heartbeat::
* Frame inspection::


File: TheLogtalkHandbook-3.100.1.info,  Node: Connection management<2>,  Next: Messaging,  Up: API Summary<4>

6.193.7.1 Connection management
...............................

   - ‘connect(+Host, +Port, -Connection, +Options)’ - Connect to server

   - ‘disconnect(+Connection, +Options)’ - Disconnect from server

   - ‘connection_alive(+Connection)’ - Check if connection is alive


File: TheLogtalkHandbook-3.100.1.info,  Node: Messaging,  Next: Acknowledgment,  Prev: Connection management<2>,  Up: API Summary<4>

6.193.7.2 Messaging
...................

   - ‘send(+Connection, +Destination, +Body, +Options)’ - Send message

   - ‘subscribe(+Connection, +Destination, +Id, +Options)’ - Subscribe

   - ‘unsubscribe(+Connection, +Id, +Options)’ - Unsubscribe

   - ‘receive(+Connection, -Frame, +Options)’ - Receive frame


File: TheLogtalkHandbook-3.100.1.info,  Node: Acknowledgment,  Next: Transactions<3>,  Prev: Messaging,  Up: API Summary<4>

6.193.7.3 Acknowledgment
........................

   - ‘ack(+Connection, +Id, +Options)’ - Acknowledge message

   - ‘nack(+Connection, +Id, +Options)’ - Negative acknowledge


File: TheLogtalkHandbook-3.100.1.info,  Node: Transactions<3>,  Next: Heartbeat,  Prev: Acknowledgment,  Up: API Summary<4>

6.193.7.4 Transactions
......................

   - ‘begin_transaction(+Connection, +TransactionId, +Options)’ - Begin

   - ‘commit_transaction(+Connection, +TransactionId, +Options)’ -
     Commit

   - ‘abort_transaction(+Connection, +TransactionId, +Options)’ - Abort


File: TheLogtalkHandbook-3.100.1.info,  Node: Heartbeat,  Next: Frame inspection,  Prev: Transactions<3>,  Up: API Summary<4>

6.193.7.5 Heartbeat
...................

   - ‘send_heartbeat(+Connection)’ - Send heartbeat EOL


File: TheLogtalkHandbook-3.100.1.info,  Node: Frame inspection,  Prev: Heartbeat,  Up: API Summary<4>

6.193.7.6 Frame inspection
..........................

   - ‘frame_command(+Frame, -Command)’ - Get frame command

   - ‘frame_header(+Frame, +Name, -Value)’ - Get header value

   - ‘frame_headers(+Frame, -Headers)’ - Get all headers

   - ‘frame_body(+Frame, -Body)’ - Get frame body


File: TheLogtalkHandbook-3.100.1.info,  Node: Connection Options,  Next: Send Options,  Prev: API Summary<4>,  Up: stomp

6.193.8 Connection Options
--------------------------

   - ‘login(Login)’ - Username for authentication

   - ‘passcode(Passcode)’ - Password for authentication

   - ‘host(VirtualHost)’ - Virtual host name (default: from Host
     parameter)

   - ‘heartbeat(ClientMs, ServerMs)’ - Heartbeat timing in milliseconds


File: TheLogtalkHandbook-3.100.1.info,  Node: Send Options,  Next: Subscribe Options,  Prev: Connection Options,  Up: stomp

6.193.9 Send Options
--------------------

   - ‘content_type(MimeType)’ - MIME type of the body

   - ‘content_length(Length)’ - Byte length of body (auto-calculated if
     omitted)

   - ‘transaction(TransactionId)’ - Include in transaction

   - ‘receipt(ReceiptId)’ - Request receipt from server

   - ‘header(Name, Value)’ - Add custom header


File: TheLogtalkHandbook-3.100.1.info,  Node: Subscribe Options,  Next: Receive Options,  Prev: Send Options,  Up: stomp

6.193.10 Subscribe Options
--------------------------

   - ‘ack(Mode)’ - Acknowledgment mode: ‘auto’, ‘client’, or
     ‘client_individual’


File: TheLogtalkHandbook-3.100.1.info,  Node: Receive Options,  Next: Error Handling<3>,  Prev: Subscribe Options,  Up: stomp

6.193.11 Receive Options
------------------------

   - ‘timeout(Milliseconds)’ - Wait timeout; 0 for non-blocking, -1 for
     infinite


File: TheLogtalkHandbook-3.100.1.info,  Node: Error Handling<3>,  Prev: Receive Options,  Up: stomp

6.193.12 Error Handling
-----------------------

Most predicates throw ‘error(stomp_error(Reason), Context)’ on failure.
Common error reasons:

   - ‘connection_failed’ - Could not establish TCP connection

   - ‘protocol_error(Message)’ - Server sent ERROR frame

   - ‘not_connected’ - Connection was closed

   - ‘invalid_frame’ - Malformed frame received

   - ‘timeout’ - Operation timed out


File: TheLogtalkHandbook-3.100.1.info,  Node: string_distance,  Next: strings,  Prev: stomp,  Up: Libraries

6.194 ‘string_distance’
=======================

This library provides string distance predicates with support for
different string representations: atoms, character lists, or character
code lists.

The predicates are defined in the ‘string_distance(_Representation_)’
parametric object where ‘_Representation_’ can be one of:

   - ‘atom’ - strings are represented as atoms

   - ‘chars’ - strings are represented as lists of characters

   - ‘codes’ - strings are represented as lists of character codes

The parameter must be bound when sending messages to the object.

* Menu:

* API documentation: API documentation<208>.
* Loading: Loading<210>.
* Testing: Testing<201>.
* Algorithms: Algorithms<3>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<208>,  Next: Loading<210>,  Up: string_distance

6.194.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#string_distance’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<210>,  Next: Testing<201>,  Prev: API documentation<208>,  Up: string_distance

6.194.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(string_distance(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<201>,  Next: Algorithms<3>,  Prev: Loading<210>,  Up: string_distance

6.194.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(string_distance(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Algorithms<3>,  Prev: Testing<201>,  Up: string_distance

6.194.4 Algorithms
------------------

This library implements the following string distance algorithms:

   - 'Levenshtein' distance is probably the most well-known.  It counts
     the minimum number of single-character edits — insertions,
     deletions, or substitutions — needed to transform one string into
     another.  For example, the distance between “kitten” and “sitting”
     is 3.

   - 'Damerau-Levenshtein' distance extends Levenshtein by also allowing
     transpositions of two adjacent characters as a single edit
     operation.  This makes it more practical for catching common typos
     like “ab” -> “ba”.

   - 'Hamming' distance only works on strings of equal length and counts
     the number of positions where the corresponding characters differ.
     It’s very fast but limited by that equal-length constraint, making
     it useful for things like comparing binary codes or fixed-format
     identifiers.

   - 'Jaro and Jaro-Winkler' distance produce a similarity score between
     0 and 1 rather than a raw edit count.  Jaro considers matching
     characters and transpositions, while Jaro-Winkler adds a
     prefix-weighting boost — the idea being that strings matching at
     the start are more likely to be the same (useful for name
     matching).

   - 'Edit similarity' is a normalized version of the edit distance,
     defined as 1 - (edit distance / max length of the two strings).  It
     produces a similarity score between 0 and 1.  Can be computed from
     Levenshtein, Damerau-Levenshtein, Hamming, or Longest Common
     Subsequence distances.

   - 'Longest Common Subsequence' (LCS) finds the length of the longest
     sequence of characters that appears in both strings in the same
     relative order (not necessarily contiguous).  It’s heavily used in
     diff tools for comparing files.

   - 'Longest Common Substring' is similar to LCS but requires the
     shared characters to be contiguous.  Useful when caring about
     shared blocks of text rather than scattered matches.

   - 'Cosine Similarity' shifts the approach from character edits to
     vector-based comparison.  Strings are converted into vectors (often
     using character n-grams or word tokens), and then the cosine of the
     angle between them is computed.  It’s widely used in NLP and
     information retrieval.

   - 'Jaccard Index' compares two sets of tokens (often words or
     n-grams) by dividing the size of their intersection by the size of
     their union.  Simple and intuitive, though it ignores term
     frequency.

   - 'Soundex/Metaphone' are phonetic algorithms rather than strict
     string comparisons.  They encode strings based on how they sound,
     so “Smith” and “Smythe” would match.  Useful for name deduplication
     where spelling varies but pronunciation is similar.

General advice: use Levenshtein or Damerau-Levenshtein for
general-purpose edit distance, Jaro-Winkler for short strings like
names, LCS for diff-style comparisons, and cosine/Jaccard when working
at the word or document level rather than character level.


File: TheLogtalkHandbook-3.100.1.info,  Node: strings,  Next: subsequences,  Prev: string_distance,  Up: Libraries

6.195 ‘strings’
===============

This library provides string manipulation predicates with support for
different string representations: atoms, character lists, or character
code lists.  Its API is partially based on work and libraries found in
ECLiPSe and SWI-Prolog.

The predicates are defined in the ‘string(_Representation_)’ parametric
object where ‘_Representation_’ can be one of:

   - ‘atom’ - strings are represented as atoms

   - ‘chars’ - strings are represented as lists of characters

   - ‘codes’ - strings are represented as lists of character codes

The parameter must be bound when sending messages to the object.

* Menu:

* API documentation: API documentation<209>.
* Loading: Loading<211>.
* Testing: Testing<202>.
* Predicates: Predicates<2>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<209>,  Next: Loading<211>,  Up: strings

6.195.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#strings’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<211>,  Next: Testing<202>,  Prev: API documentation<209>,  Up: strings

6.195.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(strings(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<202>,  Next: Predicates<2>,  Prev: Loading<211>,  Up: strings

6.195.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(strings(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Predicates<2>,  Prev: Testing<202>,  Up: strings

6.195.4 Predicates
------------------

The library provides the following compatibility predicates:

   - ‘atom_string/2’ - converts between atoms and strings

   - ‘number_string/2’ - converts between numbers and strings

   - ‘string_chars/2’ - converts between strings and character lists

   - ‘string_codes/2’ - converts between strings and character code
     lists

   - ‘string_concat/3’ - concatenates two strings

   - ‘string_length/2’ - returns the length of a string

   - ‘sub_string/5’ - extracts substrings

   - ‘string_upper/2’ - converts a string to uppercase

   - ‘string_lower/2’ - converts a string to lowercase

   - ‘split_string/4’ - splits a string into substrings using separators
     and padding

   - ‘atomics_to_string/2’ - concatenates a list of atomic terms into a
     string

   - ‘atomics_to_string/3’ - concatenates a list of atomic terms into a
     string with separator

It also provides the following string trimming predicates:

   - ‘trim/2-3’ - trims leading and trailing characters from a string

   - ‘trim_left/2-3’ - trims leading characters from a string

   - ‘trim_right/2-3’ - trims trailing characters from a string

For converting between terms and strings, see the ‘term_io’ library.


File: TheLogtalkHandbook-3.100.1.info,  Node: subsequences,  Next: term_io,  Prev: strings,  Up: Libraries

6.196 ‘subsequences’
====================

This library provides predicates for working with subsequences
represented using lists, including generation, search, contiguous
subsequence operations, and random selection.  The following categories
of predicates are provided:

   - 'Generation operations' - Predicates for generating subsequences
     and variants thereof.

   - 'Ordering variants' - Predicates that support an additional order
     argument (‘default’, ‘lexicographic’, or ‘shortlex’) for
     controlling output order.

   - 'Filtered generation' - Predicates for generating specific types of
     subsequences (combinations, permutations).

   - 'Indexed access' - Predicates for direct access to subsequences at
     specific positions.

   - 'Searching and matching' - Predicates for finding specific
     subsequences with desired properties.

   - 'Prefix and suffix operations' - Predicates for checking and
     finding prefixes and suffixes.

   - 'Contiguous subsequences' - Predicates for working with contiguous
     subsequences (subslices, sliding windows).

   - 'Random selection' - Predicates for randomly selecting
     subsequences.

   - 'Constrained operations' - Predicates for generating subsequences
     with specific constraints.

   - 'Utility predicates' - Predicates that support subsequence
     operations.

Dedicated ‘arrangements’, ‘cartesian_products’, ‘derangements’,
‘combinations’, ‘multisets’, and ‘permutations’ libraries are also
available for focused APIs on related operations.

* Menu:

* API documentation: API documentation<210>.
* Loading: Loading<212>.
* Testing: Testing<203>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<210>,  Next: Loading<212>,  Up: subsequences

6.196.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#subsequences’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<212>,  Next: Testing<203>,  Prev: API documentation<210>,  Up: subsequences

6.196.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(subsequences(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<203>,  Prev: Loading<212>,  Up: subsequences

6.196.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(subsequences(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: term_io,  Next: thurstone_mosteller_ranker,  Prev: subsequences,  Up: Libraries

6.197 ‘term_io’
===============

This library implements predicates for reading/writing terms from/to
atoms, chars (lists of characters), and codes (lists of character
codes).  These predicates are implemented using a single temporary file
created when the library is loaded.  This temporary file is unique per
Logtalk process.  The predicates can be safely used in multi-threaded
applications.

* Menu:

* API documentation: API documentation<211>.
* Loading: Loading<213>.
* Testing: Testing<204>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<211>,  Next: Loading<213>,  Up: term_io

6.197.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#term-io’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<213>,  Next: Testing<204>,  Prev: API documentation<211>,  Up: term_io

6.197.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(term_io(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<204>,  Prev: Loading<213>,  Up: term_io

6.197.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(term_io(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: thurstone_mosteller_ranker,  Next: time_scales,  Prev: term_io,  Up: Libraries

6.198 ‘thurstone_mosteller_ranker’
==================================

Thurstone-Mosteller Case V pairwise preference ranker.  It aggregates
pairwise outcomes into matchup probabilities, applies a fixed continuity
correction to avoid infinite probit values, transforms them with the
inverse standard normal CDF, and fits Case V latent utilities using a
deterministic weighted least-squares linear solve.

The library implements the ‘ranker_protocol’ defined in the
‘ranking_protocols’ library.  It provides predicates for learning a
ranker from pairwise preferences, using it to order candidate items, and
exporting it as a list of predicate clauses or to a file.

Datasets are represented as objects implementing the
‘pairwise_ranking_dataset_protocol’ protocol from the
‘ranking_protocols’ library.  See the ‘test_datasets’ directory for
examples.  The current implementation requires a well-formed connected
pairwise dataset so that all learned utilities remain comparable across
the ranked items.

* Menu:

* API documentation: API documentation<212>.
* Loading: Loading<214>.
* Testing: Testing<205>.
* Features: Features<77>.
* Scoring semantics: Scoring semantics<8>.
* Options: Options<72>.
* Diagnostics syntax: Diagnostics syntax<26>.
* Ranker representation: Ranker representation<17>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<212>,  Next: Loading<214>,  Up: thurstone_mosteller_ranker

6.198.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#thurstone_mosteller_ranker’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<214>,  Next: Testing<205>,  Prev: API documentation<212>,  Up: thurstone_mosteller_ranker

6.198.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(thurstone_mosteller_ranker(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<205>,  Next: Features<77>,  Prev: Loading<214>,  Up: thurstone_mosteller_ranker

6.198.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(thurstone_mosteller_ranker(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<77>,  Next: Scoring semantics<8>,  Prev: Testing<205>,  Up: thurstone_mosteller_ranker

6.198.4 Features
----------------

   - 'Pairwise Preference Learning': Learns one deterministic latent
     utility per item from aggregated pairwise outcomes.

   - 'Case V Thurstone-Mosteller Fit': Uses continuity-corrected matchup
     win probabilities transformed by the inverse standard normal CDF
     and fitted with a deterministic weighted least-squares solve.

   - 'Centered Utility Scale': Learned scores are centered so that only
     utility differences encode preference strength while the absolute
     location remains arbitrary.

   - 'Deterministic Ranking': Orders candidate items by learned utility
     with deterministic tie-breaking.

   - 'Strict Dataset Validation': Rejects duplicate items, undeclared
     items, self-preferences, non-positive weights, and disconnected
     comparison graphs.

   - 'Training Diagnostics': Learned rankers include metadata describing
     the fitting method, continuity correction, and validated dataset
     summary.

   - 'Ranker Export': Learned rankers can be exported as self-contained
     terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Scoring semantics<8>,  Next: Options<72>,  Prev: Features<77>,  Up: thurstone_mosteller_ranker

6.198.5 Scoring semantics
-------------------------

This implementation aggregates pairwise preferences into matchup totals
and then estimates latent utilities under the Thurstone-Mosteller Case V
model.  For each observed unordered pair, it computes a
continuity-corrected empirical win probability

     (wins + 0.5) / (total + 1.0)

maps that probability through the inverse standard normal CDF, and fits
utility differences using weighted least squares with matchup totals as
the weights.

The resulting utilities are centered, real-valued scores on an arbitrary
additive scale.  Only differences between utilities are meaningful when
interpreting implied paired-comparison probabilities and ranking order.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<72>,  Next: Diagnostics syntax<26>,  Prev: Scoring semantics<8>,  Up: thurstone_mosteller_ranker

6.198.6 Options
---------------

The current ‘learn/3’ implementation does not define any user options
beyond the default empty list.  Non-empty options lists are rejected.


File: TheLogtalkHandbook-3.100.1.info,  Node: Diagnostics syntax<26>,  Next: Ranker representation<17>,  Prev: Options<72>,  Up: thurstone_mosteller_ranker

6.198.7 Diagnostics syntax
--------------------------

The ‘diagnostics/2’ predicate returns a list of metadata terms with the
form:

     [
         model(thurstone_mosteller_ranker),
         options(Options),
         fitting(weighted_least_squares_case_v),
         continuity_correction(0.5),
         dataset_summary(DatasetSummary)
     ]


File: TheLogtalkHandbook-3.100.1.info,  Node: Ranker representation<17>,  Prev: Diagnostics syntax<26>,  Up: thurstone_mosteller_ranker

6.198.8 Ranker representation
-----------------------------

The learned ranker is represented by a compound term of the form:

     thurstone_mosteller_ranker(Items, Scores, Diagnostics)

Where:

   - ‘Items’: List of ranked items.

   - ‘Scores’: List of ‘Item-Score’ pairs.

   - ‘Diagnostics’: List of metadata terms, including the fitting
     method, continuity correction, and dataset summary.


File: TheLogtalkHandbook-3.100.1.info,  Node: time_scales,  Next: timeout,  Prev: thurstone_mosteller_ranker,  Up: Libraries

6.199 ‘time_scales’
===================

The ‘time_scales’ library provides predicates for converting instants
between UTC, TAI, TT, UT1, TDB, GPS, GST, TCG, and TCB using bundled
reference data and optional user-provided override files.

The library is designed to complement (not replace) the ‘dates’ and
‘iso8601’ libraries:

   - Use ‘dates’ for civil date-time arithmetic and Unix epoch
     conversions.

   - Use ‘iso8601’ for string parsing and formatting.

   - Use ‘time_scales’ for physical time-scale conversions.

* Menu:

* API documentation: API documentation<213>.
* Loading: Loading<215>.
* Testing: Testing<206>.
* Features: Features<78>.
* Limitations: Limitations<5>.
* Representation: Representation<16>.
* Examples: Examples<174>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<213>,  Next: Loading<215>,  Up: time_scales

6.199.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#time_scales’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<215>,  Next: Testing<206>,  Prev: API documentation<213>,  Up: time_scales

6.199.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(time_scales(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<206>,  Next: Features<78>,  Prev: Loading<215>,  Up: time_scales

6.199.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(time_scales(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<78>,  Next: Limitations<5>,  Prev: Testing<206>,  Up: time_scales

6.199.4 Features
----------------

Current feature set:

   - Supported scales: ‘utc’, ‘tai’, ‘tt’, ‘ut1’, ‘tdb’, ‘gps’, ‘gst’,
     ‘tcg’, and ‘tcb’.

   - UTC support starts at ‘1972-01-01T00:00:00Z’.

   - Leap seconds are provided by a bundled static table with optional
     override file.

   - DUT1 (‘UT1-UTC’) is provided by bundled data with optional override
     file.

   - Active leap-second and DUT1 tables can be queried as ordered term
     lists for reproducibility.

   - Active leap-second and DUT1 tables can be saved to deterministic
     term files and reloaded as overrides.

   - Fail- and error-based validation predicates for validating and
     type-checking instant terms and conversion requests.

   - TDB conversions use a practical TT/TDB approximation suitable for
     application-level use.

   - Real-valued approximation offsets converted to rationals using
     high-resolution nanosecond scaling.


File: TheLogtalkHandbook-3.100.1.info,  Node: Limitations<5>,  Next: Representation<16>,  Prev: Features<78>,  Up: time_scales

6.199.5 Limitations
-------------------

Current non-implemented features:

   - UTC coverage before 1972-01-01T00:00:00Z is not implemented.

   - network-driven leap-second and DUT1 data updates are not
     implemented.

   - high-precision ephemeris-based relativistic modeling (beyond the
     current practical approximation formulas) is not implemented.

For full functionality (including all high-precision conversion paths
and their corresponding tests), a Prolog backend with support for
unbounded integer arithmetic is required.


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<16>,  Next: Examples<174>,  Prev: Limitations<5>,  Up: time_scales

6.199.6 Representation
----------------------

Instants are represented as:

     instant(Scale, Seconds, fraction(Numerator, Denominator))

Where:

   - ‘Scale’ is one of ‘utc’, ‘tai’, ‘tt’, ‘ut1’, ‘tdb’, ‘gps’, ‘gst’,
     ‘tcg’, or ‘tcb’;

   - ‘Seconds’ is integer epoch seconds;

   - ‘fraction(Numerator, Denominator)’ is a normalized fraction in the
     ‘[0,1[’ interval.

Offsets are returned as:

     rational(Numerator, Denominator)


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<174>,  Prev: Representation<16>,  Up: time_scales

6.199.7 Examples
----------------

Convert UTC to TAI:

     | ?- time_scales::convert(instant(utc, 1483228800, fraction(0,1)), utc, tai, TAI).

Strictly validate an instant term (throws on invalid input):

     | ?- time_scales::check_instant(instant(utc, 1483228800, fraction(0,1))).

Strict conversion (throws on invalid scale or mismatched instant scale):

     | ?- time_scales::check_convert(instant(utc, 1483228800, fraction(0,1)), utc, tai, TAI).

Convert TAI to TT:

     | ?- time_scales::convert(instant(tai, 1483228837, fraction(0,1)), tai, tt, TT).

Convert UTC to UT1:

     | ?- time_scales::convert(instant(utc, 1483228800, fraction(0,1)), utc, ut1, UT1).

Convert TT to TDB:

     | ?- time_scales::convert(instant(tt, 1483228869, fraction(0,1)), tt, tdb, TDB).

Convert UTC to GPS:

     | ?- time_scales::convert(instant(utc, 1483228800, fraction(0,1)), utc, gps, GPS).

Convert UTC to GST:

     | ?- time_scales::convert(instant(utc, 1483228800, fraction(0,1)), utc, gst, GST).

Convert UTC to TCG:

     | ?- time_scales::convert(instant(utc, 1483228800, fraction(0,1)), utc, tcg, TCG).

Convert UTC to TCB:

     | ?- time_scales::convert(instant(utc, 1483228800, fraction(0,1)), utc, tcb, TCB).

Lookup an effective leap-second date:

     | ?- time_scales::leap_second_date(Date, Offset).

Load leap-second and DUT1 override files:

     | ?- time_scales::load_leap_seconds_override('test_files/leap_seconds_override.pl').

     | ?- time_scales::load_dut1_override('test_files/dut1_override.pl').

Query active leap-second and DUT1 data tables:

     | ?- time_scales::leap_seconds_entries(LeapEntries).

     | ?- time_scales::dut1_entries(DUT1Entries).

Save active leap-second and DUT1 data tables:

     | ?- time_scales::save_leap_seconds_entries('/tmp/logtalk_time_scales_leap_snapshot.pl').

     | ?- time_scales::save_dut1_entries('/tmp/logtalk_time_scales_dut1_snapshot.pl').

Validate an instant or conversion request:

     | ?- time_scales::valid_instant(instant(utc, 1483228800, fraction(0,1))).

     | ?- time_scales::valid_conversion(instant(tai, 1483228837, fraction(0,1)), tai, tdb).


File: TheLogtalkHandbook-3.100.1.info,  Node: timeout,  Next: tle_orbits,  Prev: time_scales,  Up: Libraries

6.200 ‘timeout’
===============

The ‘timeout’ object provides a portable abstraction over calling a goal
deterministically with a time limit as made available in some form by
some of the supported backend Prolog systems (B-Prolog, ECLiPSe, SICStus
Prolog, SWI-Prolog, Trealla Prolog, XSB, XVM, and YAP).

For better performance, compile calls to this library meta-predicates
with the ‘optimize’ flag turned on so that the meta-arguments, i.e.  the
goals that you are timing, are also compiled.

* Menu:

* API documentation: API documentation<214>.
* Loading: Loading<216>.
* Testing: Testing<207>.
* Known issues: Known issues<20>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<214>,  Next: Loading<216>,  Up: timeout

6.200.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#timeout’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<216>,  Next: Testing<207>,  Prev: API documentation<214>,  Up: timeout

6.200.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(timeout(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<207>,  Next: Known issues<20>,  Prev: Loading<216>,  Up: timeout

6.200.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(timeout(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<20>,  Prev: Testing<207>,  Up: timeout

6.200.4 Known issues
--------------------

Two tests are currently skipped when using the SWI-Prolog backend as
they cannot be interrupted and generate the expected timeout exceptions
due to tests being run from an ‘initialization/1’ directive goal that,
in the SWI-Prolog implementation of this directive, ignores signals.
The test goals do generate the expected timeout exception when not
called from an ‘initialization/1’ directive.


File: TheLogtalkHandbook-3.100.1.info,  Node: tle_orbits,  Next: toml,  Prev: timeout,  Up: Libraries

6.201 ‘tle_orbits’
==================

The ‘tle_orbits’ library parses Two-Line Element (TLE) records and
provides a small set of helpers for portable approximate orbit
propagation and ground-track generation.

The current version defaults to an approximate automatic propagation
mode that dispatches between dedicated near-earth and deep-space
variants.  The near-earth variant applies low-order B* drag damping
together with J2 secular and short-period position corrections.  The
deep-space variant uses its own long-period and resonance-aware
corrections so high-period orbits no longer share the near-earth path.
The two-body Keplerian approximation is also available as an explicit
baseline model for comparison and simple fallback use.  Propagated
states can also be queried together with direct velocity outputs in
inertial, Earth-fixed, or local ENU frames.

* Menu:

* API documentation: API documentation<215>.
* Loading: Loading<217>.
* Testing: Testing<208>.
* Representation: Representation<17>.
* Public API: Public API<3>.
* Examples: Examples<175>.
* Notes: Notes<11>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<215>,  Next: Loading<217>,  Up: tle_orbits

6.201.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#tle_orbits’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<217>,  Next: Testing<208>,  Prev: API documentation<215>,  Up: tle_orbits

6.201.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(tle_orbits(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<208>,  Next: Representation<17>,  Prev: Loading<217>,  Up: tle_orbits

6.201.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(tle_orbits(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<17>,  Next: Public API<3>,  Prev: Testing<208>,  Up: tle_orbits

6.201.4 Representation
----------------------

Parsed TLE records are represented as:

     ```
         tle(
             Name,
             satellite(CatalogNumber, Classification, designator(LaunchYear, LaunchNumber, Piece)),
             epoch_julian_date(EpochJulianDate),
             drag(MeanMotionDot, MeanMotionDdot, BStar),
             orbit(InclinationDegrees, RightAscensionDegrees, Eccentricity,
                 ArgumentOfPerigeeDegrees, MeanAnomalyDegrees, MeanMotionRevolutionsPerDay),
             ephemeris_type(EphemerisType),
             element_set(ElementSetNumber),
             revolution(RevolutionNumber)
         )
     ```

If the optional title line is absent, ‘Name’ is the atom ‘none’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Public API<3>,  Next: Examples<175>,  Prev: Representation<17>,  Up: tle_orbits

6.201.5 Public API
------------------

   - ‘parse/2’ parses one or more TLE records from ‘atom(Atom)’,
     ‘chars(List)’, ‘codes(List)’, ‘stream(Stream)’, or ‘file(Path)’
     sources.

   - ‘parse_lines/4’ parses a single TLE record from an optional name
     and the two fixed-width element lines.

   - ‘propagate/3’ propagates to a default
     ‘geographic(Latitude,Longitude,Height)’ coordinate in WGS84 using
     the default ‘approximate’ model.

   - ‘propagate/4’ supports the frames ‘eci’, ‘ecef’, and ‘wgs84_3d’
     using the default ‘approximate’ model.

   - ‘propagate/5’ additionally allows choosing one of the
     ‘approximate’, ‘approximate_near_earth’, ‘approximate_deep_space’,
     or ‘two_body’ models.

   - ‘propagate_state/4’ returns ‘state(Position,Velocity)’ in a
     requested frame using the default ‘approximate’ model.

   - ‘propagate_state/5’ additionally allows choosing one of the
     ‘approximate’, ‘approximate_near_earth’, ‘approximate_deep_space’,
     or ‘two_body’ models.  Velocity is derived directly from the
     propagated orbital elements in ECI and then analytically
     transformed to ECEF or local ENU when requested.

   - ‘ground_track/5’ samples ‘sample(DateTime,
     geographic(Latitude,Longitude,Height))’ points over a time range
     using a fixed step in seconds and the default ‘approximate’ model.

   - ‘ground_track/6’ additionally allows choosing one of the
     ‘approximate’, ‘approximate_near_earth’, ‘approximate_deep_space’,
     or ‘two_body’ models.

Supported propagation time specifications are:

   - ‘date_time(Year, Month, Day, Hours, Minutes, Seconds)’

   - ‘julian_date(JulianDate)’

   - ‘offset_seconds(SecondsSinceEpoch)’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<175>,  Next: Notes<11>,  Prev: Public API<3>,  Up: tle_orbits

6.201.6 Examples
----------------

Parse one named TLE record:

     | ?- tle_orbits::parse(atom('ISS (ZARYA)\n1 25544U 98067A   24120.51782528  .00012051  00000-0  21940-3 0  9995\n2 25544  51.6393 184.4452 0003580  32.9443 327.1663 15.50957687452123\n'), TLEs).

Propagate to a WGS84 3D geodetic coordinate using the TLE epoch:

     | ?- TLEs = [TLE], tle_orbits::propagate(TLE, offset_seconds(0.0), Coordinate).

Propagate to ECI or ECEF coordinates:

     | ?- tle_orbits::propagate(TLE, offset_seconds(600.0), eci, ECI).
     | ?- tle_orbits::propagate(TLE, offset_seconds(600.0), ecef, ECEF).

Select the propagation model explicitly:

     | ?- tle_orbits::propagate(TLE, offset_seconds(600.0), eci, two_body, ECI).
     | ?- tle_orbits::propagate(TLE, offset_seconds(600.0), eci, approximate_near_earth, ECI).
     | ?- tle_orbits::propagate(TLE, offset_seconds(600.0), eci, approximate, ECI).
     | ?- tle_orbits::propagate(TLE, offset_seconds(43200.0), eci, approximate_deep_space, ECI).

Request propagated state plus velocity:

     | ?- tle_orbits::propagate_state(TLE, offset_seconds(600.0), eci, State).
     | ?- tle_orbits::propagate_state(TLE, offset_seconds(600.0), wgs84_3d, approximate, State).

Generate a ground track sampled every 10 minutes:

     | ?- tle_orbits::ground_track(
         TLE,
         date_time(2024, 4, 29, 12, 25, 40.0),
         date_time(2024, 4, 29, 13, 25, 40.0),
         600.0,
         Samples
     ).


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<11>,  Prev: Examples<175>,  Up: tle_orbits

6.201.7 Notes
-------------

   - Parsing validates the TLE checksums and rejects malformed records.

   - The ‘approximate’ family includes low-order B* drag handling,
     near-earth short-period corrections, and a separate deep-space
     approximation with independent solar, lunar, and resonance-aware
     perturbation terms.  It is a portable approximation, not an
     implementation of standards-grade SGP4/SDP4.

   - State velocity output is no longer estimated using centered finite
     differences.  The library now computes ECI velocity directly from
     the propagated orbital elements and transforms that velocity
     analytically to ECEF and local ENU.

   - Position and velocity frame conversion now share the same
     Earth-rotation basis to keep propagated state components internally
     consistent across frames.

   - The geodetic output path reuses the ‘crs_projections’ library for
     converting propagated ‘ecef(X,Y,Z)’ coordinates to ‘geographic/3’
     coordinates.


File: TheLogtalkHandbook-3.100.1.info,  Node: toml,  Next: toon,  Prev: tle_orbits,  Up: Libraries

6.202 ‘toml’
============

The ‘toml’ library provides predicates for parsing and generating data
in the TOML format:

‘https://toml.io’

It includes parametric objects whose parameters allow selecting the
representation for parsed TOML tables (‘compound’ or ‘curly’), TOML text
strings (‘atom’, ‘chars’, or ‘codes’) and TOML pairs (‘dash’, ‘equal’,
or ‘colon’).

* Menu:

* API documentation: API documentation<216>.
* Loading: Loading<218>.
* Testing: Testing<209>.
* Status::
* Representation: Representation<18>.
* Examples: Examples<176>.
* Notes: Notes<12>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<216>,  Next: Loading<218>,  Up: toml

6.202.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#toml’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<218>,  Next: Testing<209>,  Prev: API documentation<216>,  Up: toml

6.202.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(toml(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<209>,  Next: Status,  Prev: Loading<218>,  Up: toml

6.202.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(toml(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Status,  Next: Representation<18>,  Prev: Testing<209>,  Up: toml

6.202.4 Status
--------------

The full TOML 1.0.0 data model is covered:

   - key/value assignments

   - standard tables using ‘[table]’ headers

   - dotted keys

   - arrays

   - inline tables

   - array-of-tables

   - booleans

   - decimal, hexadecimal, octal, and binary integers

   - decimal floats plus ‘inf’ and ‘nan’

   - single-line and multiline basic and literal strings

   - local dates, local times, local date-times, and offset date-times

   - parsing and generation from files, streams, chars, codes, and atoms


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<18>,  Next: Examples<176>,  Prev: Status,  Up: toml

6.202.5 Representation
----------------------

The following choices of syntax have been made to represent TOML
elements as terms:

   - By default, TOML tables are represented using the compound term
     ‘toml(Pairs)’, where ‘Pairs’ is a list using the selected pair
     representation.

   - Alternatively, TOML tables can be represented using curly-bracketed
     terms, ‘{Pairs}’, where ‘Pairs’ uses the selected pair
     representation.

   - Arrays are represented using lists.

   - Text strings can be represented as atoms, ‘chars(List)’, or
     ‘codes(List)’.  The default when decoding is to use atoms when
     using the ‘toml’ object.  To decode text strings into lists of
     chars or codes, use the ‘toml/1’ object with the parameter bound to
     ‘chars’ or ‘codes’.

   - TOML booleans are represented by ‘@true’ and ‘@false’.

   - TOML special floats are represented by ‘@(inf)’, ‘@(-inf)’, and
     ‘@(nan)’.

Examples using the default ‘toml’ object:

TOML                             term
                                 
--------------------------------------------------------------------------
‘title = "Example"’              ‘toml([title-'Example'])’
                                 
‘point = {x = 1, y = 2}’         ‘toml([point-toml([x-1, y-2])])’
                                 
‘[owner]’ ‘name = "Tom"’         ‘toml([owner-toml([name-'Tom'])])’
                                 
‘enabled = true’                 ‘toml([enabled-@true])’
                                 
‘limits = [1, 2, 3]’             ‘toml([limits-[1,2,3]])’
                                 


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<176>,  Next: Notes<12>,  Prev: Representation<18>,  Up: toml

6.202.6 Examples
----------------

* Menu:

* Parsing a TOML String::
* Parsing with Curly Table Representation::
* Generating TOML::


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing a TOML String,  Next: Parsing with Curly Table Representation,  Up: Examples<176>

6.202.6.1 Parsing a TOML String
...............................

     |?- toml::parse(atom('title = "Example"\n[owner]\nname = "Tom"\n'), TOML).
     TOML = toml([title-'Example', owner-toml([name-'Tom'])]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing with Curly Table Representation,  Next: Generating TOML,  Prev: Parsing a TOML String,  Up: Examples<176>

6.202.6.2 Parsing with Curly Table Representation
.................................................

     | ?- toml(curly,dash,atom)::parse(atom('title = "Example"\n[owner]\nname = "Tom"\n'), TOML).
     TOML = {title-'Example', owner-{name-'Tom'}}.


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating TOML,  Prev: Parsing with Curly Table Representation,  Up: Examples<176>

6.202.6.3 Generating TOML
.........................

     | ?- toml::generate(atom(Atom), toml([title-'Example', owner-toml([name-'Tom'])])).
     Atom = 'title = "Example"\n\n[owner]\nname = "Tom"\n'.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<12>,  Prev: Examples<176>,  Up: toml

6.202.7 Notes
-------------

Generation is canonical and semantic.  The current implementation does
not preserve comments, original quoting style, or whether a table was
originally written as an inline table or a standard table.


File: TheLogtalkHandbook-3.100.1.info,  Node: toon,  Next: truncated_svd_projection,  Prev: toml,  Up: Libraries

6.203 ‘toon’
============

The ‘toon’ library provides predicates for parsing and generating data
in the TOON (Token-Oriented Object Notation) format.  TOON is a compact,
human-readable, line-oriented format that encodes the JSON data model
while minimizing tokens.  For more information on the TOON format, see:

‘https://github.com/toon-format/toon’

* Menu:

* API documentation: API documentation<217>.
* Loading: Loading<219>.
* Testing: Testing<210>.
* Representation: Representation<19>.
* TOON format features::
* Usage examples::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<217>,  Next: Loading<219>,  Up: toon

6.203.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#toon’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<219>,  Next: Testing<210>,  Prev: API documentation<217>,  Up: toon

6.203.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(toon(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<210>,  Next: Representation<19>,  Prev: Loading<219>,  Up: toon

6.203.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(toon(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<19>,  Next: TOON format features,  Prev: Testing<210>,  Up: toon

6.203.4 Representation
----------------------

TOON objects are represented using the same conventions as the ‘json’
library.  The representation of TOON objects and TOON pairs can be
controlled using the ‘toon/3’ parametric object.  The three parameters
are:

   - ‘ObjectRepresentation’: ‘curly’ (default) or ‘list’

   - ‘PairRepresentation’: ‘dash’ (default), ‘equal’, or ‘colon’

   - ‘StringRepresentation’: ‘atom’ (default), ‘chars’, or ‘codes’

The ‘toon(StringRepresentation)’ and ‘toon’ objects use the default
representations.

* Menu:

* Objects: Objects<2>.
* Arrays::
* Primitives::


File: TheLogtalkHandbook-3.100.1.info,  Node: Objects<2>,  Next: Arrays,  Up: Representation<19>

6.203.4.1 Objects
.................

TOON objects are represented using curly terms by default:

     {Key1-Value1, Key2-Value2, ...}

Or using lists when using ‘list’ for the ‘ObjectRepresentation’
parameter:

     toon([Key1-Value1, Key2-Value2, ...])


File: TheLogtalkHandbook-3.100.1.info,  Node: Arrays,  Next: Primitives,  Prev: Objects<2>,  Up: Representation<19>

6.203.4.2 Arrays
................

TOON arrays are represented as lists:

     [Element1, Element2, ...]


File: TheLogtalkHandbook-3.100.1.info,  Node: Primitives,  Prev: Arrays,  Up: Representation<19>

6.203.4.3 Primitives
....................

TOON primitive values are represented as follows:

   - Strings: atoms (default), ‘chars(ListOfChars)’, or
     ‘codes(ListOfCodes)’

   - Numbers: Prolog numbers

   - Booleans: ‘@true’ and ‘@false’

   - Null: ‘@null’


File: TheLogtalkHandbook-3.100.1.info,  Node: TOON format features,  Next: Usage examples,  Prev: Representation<19>,  Up: toon

6.203.5 TOON format features
----------------------------

TOON is a line-oriented format with the following key features:

   - Uses indentation (2 spaces) instead of braces for objects

   - Arrays declare their length: ‘[N]:’ for inline or ‘[N]{fields}:’
     for tabular

   - Tabular form for uniform arrays of objects with primitive values

   - Minimal quoting rules for strings

   - Three delimiters: comma (default), tab, and pipe

   - UTF-8 encoding with LF line endings

   - File extension: ‘.toon’, media type: ‘text/toon’


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage examples,  Prev: TOON format features,  Up: toon

6.203.6 Usage examples
----------------------

Parsing TOON from an atom:

     | ?- toon::parse(atom('name: John\nage: 30'), Term).
     Term = {name-'John', age-30}
     yes

Generating TOON to an atom:

     | ?- toon::generate(atom(Atom), {name-'John', age-30}).
     Atom = 'name: John\nage: 30'
     yes

Parsing TOON from a file:

     | ?- toon::parse(file('data.toon'), Term).
     ...

Generating TOON to a file:

     | ?- toon::generate(file('output.toon'), {name-'John', age-30}).
     ...

Using different representations:

     | ?- toon(list, dash, atom)::parse(atom('name: John'), Term).
     Term = toon([name-'John'])
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: truncated_svd_projection,  Next: tsv,  Prev: toon,  Up: Libraries

6.204 ‘truncated_svd_projection’
================================

Truncated singular value decomposition reducer for continuous datasets.
The library implements the ‘dimension_reducer_protocol’ defined in the
‘dimension_reduction_protocols’ library and learns a low-rank linear
projection by building a preprocessed data matrix using optional
centering and scaling, extracting singular triplets using deterministic
two-sided power iteration, and applying rank-one deflation directly to
the data matrix.

* Menu:

* API documentation: API documentation<218>.
* Loading: Loading<220>.
* Testing: Testing<211>.
* Features: Features<79>.
* Options: Options<73>.
* Usage: Usage<103>.
* Dimension reducer representation: Dimension reducer representation<9>.
* References: References<52>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<218>,  Next: Loading<220>,  Up: truncated_svd_projection

6.204.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#truncated_svd_projection’ link
in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<220>,  Next: Testing<211>,  Prev: API documentation<218>,  Up: truncated_svd_projection

6.204.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(truncated_svd_projection(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<211>,  Next: Features<79>,  Prev: Loading<220>,  Up: truncated_svd_projection

6.204.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(truncated_svd_projection(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<79>,  Next: Options<73>,  Prev: Testing<211>,  Up: truncated_svd_projection

6.204.4 Features
----------------

   - 'Continuous Datasets': Accepts datasets containing only continuous
     attributes.  Missing or nonnumeric values are rejected.

   - 'Low-Rank Projection': Extracts right singular vectors and singular
     values in descending order.

   - 'Portable SVD Solver': Uses deterministic two-sided power iteration
     with rank-one deflation over the data matrix instead of
     backend-specific linear algebra libraries.

   - 'Optional Centering and Scaling': Supports explicit control over
     whether training and transform inputs are centered and/or scaled.

   - 'Training Diagnostics': Records per-component convergence reasons,
     iteration counts, and final deltas alongside the learned singular
     values.

   - 'Projection API': Transforms a new instance into a list of
     ‘component_N-Value’ pairs.

   - 'Model Export': Learned reducers can be exported as predicate
     clauses or written to a file.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<73>,  Next: Usage<103>,  Prev: Features<79>,  Up: truncated_svd_projection

6.204.5 Options
---------------

The ‘learn/3’ predicate accepts the following options:

   - ‘n_components/1’: Number of singular vectors to extract.  The
     default is ‘2’.  Requests that exceed the numerical rank after
     shape capping raise ‘domain_error(component_count,
     Requested-Extracted)’ instead of silently returning fewer
     components.

   - ‘center/1’: Whether to center the training and transform inputs
     using the training-set means.  Options: ‘true’ or ‘false’
     (default).

   - ‘feature_scaling/1’: Whether to divide each continuous attribute by
     its training-set standard deviation.  Options: ‘true’ or ‘false’
     (default).

   - ‘maximum_iterations/1’: Maximum number of power-iteration steps
     used when estimating each singular vector.  The default is ‘1000’.

   - ‘tolerance/1’: Positive convergence tolerance used both for
     power-iteration stopping and for deciding when the residual matrix
     no longer supports the requested number of components.  The default
     is ‘1.0e-8’.

The learned diagnostics also include:

   - ‘convergence(Statuses)’: Per-component stop reasons, such as
     ‘tolerance’ or ‘maximum_iterations_exhausted’.

   - ‘iterations(Counts)’: Per-component iteration counts aligned with
     the extracted singular vectors.

   - ‘final_delta(Deltas)’: Per-component final update magnitudes
     aligned with the extracted singular vectors.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<103>,  Next: Dimension reducer representation<9>,  Prev: Options<73>,  Up: truncated_svd_projection

6.204.6 Usage
-------------

The following examples use the sample datasets shipped with the
‘dimension_reduction_protocols’ library:

     | ?- logtalk_load(dimension_reduction_protocols('test_datasets/low_rank_rectangular')).

* Menu:

* Learning a reducer: Learning a reducer<8>.
* Transforming new instances: Transforming new instances<8>.
* Exporting and reusing the reducer: Exporting and reusing the reducer<8>.


File: TheLogtalkHandbook-3.100.1.info,  Node: Learning a reducer<8>,  Next: Transforming new instances<8>,  Up: Usage<103>

6.204.6.1 Learning a reducer
............................

     | ?- truncated_svd_projection::learn(low_rank_rectangular, DimensionReducer).

     | ?- truncated_svd_projection::learn(low_rank_rectangular, DimensionReducer, [n_components(1), center(false), feature_scaling(false), maximum_iterations(200), tolerance(1.0e-7)]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Transforming new instances<8>,  Next: Exporting and reusing the reducer<8>,  Prev: Learning a reducer<8>,  Up: Usage<103>

6.204.6.2 Transforming new instances
....................................

     | ?- truncated_svd_projection::learn(low_rank_rectangular, DimensionReducer),
          truncated_svd_projection::transform(DimensionReducer, [f1-1.0, f2-1.0, f3-2.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Exporting and reusing the reducer<8>,  Prev: Transforming new instances<8>,  Up: Usage<103>

6.204.6.3 Exporting and reusing the reducer
...........................................

     | ?- truncated_svd_projection::learn(low_rank_rectangular, DimensionReducer, [n_components(1)]),
          truncated_svd_projection::export_to_file(low_rank_rectangular, DimensionReducer, reducer, 'truncated_svd_reducer.pl').

     | ?- logtalk_load('truncated_svd_reducer.pl'),
          reducer(Reducer),
          truncated_svd_projection::transform(Reducer, [f1-1.0, f2-1.0, f3-2.0], ReducedInstance).


File: TheLogtalkHandbook-3.100.1.info,  Node: Dimension reducer representation<9>,  Next: References<52>,  Prev: Usage<103>,  Up: truncated_svd_projection

6.204.7 Dimension reducer representation
----------------------------------------

The learned dimension reducer is represented by a compound term with the
functor chosen by the implementation and arity 4.  For example:

     truncated_svd_reducer(Encoders, Components, SingularValues, Diagnostics)

Where:

   - ‘Encoders’: List of continuous attribute encoders storing attribute
     name, centering offset, and scale factor.

   - ‘Components’: List of right singular vectors in descending
     singular-value order.

   - ‘SingularValues’: List of singular values matching the extracted
     components.

   - ‘Diagnostics’: Learned reducer metadata including the effective
     training options, singular values, and per-component convergence
     information.


File: TheLogtalkHandbook-3.100.1.info,  Node: References<52>,  Prev: Dimension reducer representation<9>,  Up: truncated_svd_projection

6.204.8 References
------------------

  1. Eckart, C. and Young, G. (1936) - “The approximation of one matrix
     by another of lower rank”.


File: TheLogtalkHandbook-3.100.1.info,  Node: tsv,  Next: types,  Prev: truncated_svd_projection,  Up: Libraries

6.205 ‘tsv’
===========

The ‘tsv’ library provides predicates for reading and writing TSV files
and streams:

‘https://www.iana.org/assignments/media-types/text/tab-separated-values’

The main object, ‘tsv/2’, is a parametric object allowing passing two
options: header handling (‘keep’ or ‘skip’) and comment handling
(‘false’ or ‘true’).  When comment handling is ‘true’, lines starting
with the ‘#’ character are skipped when reading files and streams.

The ‘tsv/1’ parametric object is kept for backward compatibility and
extends ‘tsv/2’ by setting the comments option to ‘false’.  The ‘tsv’
object extends the ‘tsv/2’ parametric object using the default options
‘keep’ and ‘false’.

Files and streams can be read into a list of rows (with each row being
represented by a list of fields) or asserted using a user-defined
dynamic predicate.  Reading can be done by first loading the whole file
(using the ‘read_file/2-3’ predicates) into memory or line by line
(using the ‘read_file_by_line/2-3’ predicates).  Reading line by line is
usually the best option for parsing large TSV files.

Data can be saved to a TSV file or stream by providing the object and
predicate for accessing the data plus the name of the destination file
or the stream handle or alias.

* Menu:

* API documentation: API documentation<219>.
* Loading: Loading<221>.
* Testing: Testing<212>.
* Usage: Usage<104>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<219>,  Next: Loading<221>,  Up: tsv

6.205.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#tsv’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<221>,  Next: Testing<212>,  Prev: API documentation<219>,  Up: tsv

6.205.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(tsv(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<212>,  Next: Usage<104>,  Prev: Loading<221>,  Up: tsv

6.205.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(tsv(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<104>,  Prev: Testing<212>,  Up: tsv

6.205.4 Usage
-------------

A TSV file can be read as a list of rows:

     | ?- tsv::read_file('test_files/data.tsv', Rows).

     Rows = [['Name','Age','Address'], ['Paul',23,'1115 W Franklin'], ['Bessy the Cow',5,'Big Farm Way'], ['Zeke,45,'W Main St']]
     yes

Alternatively, The TSV data can be saved using a public and dynamic
object predicate (that must be previously declared).  For example:

     | ?- assertz(p(_,_,_)), retractall(p(_,_,_)).
     yes

     | ?- tsv(skip)::read_file('test_files/data.tsv', user, p/3).
     yes

     | ?- tsv(skip, true)::read_file('test_files/data_with_comments.tsv', user, p/3).
     yes

     | ?-  p(A,B,C).

     A = 'Paul', B = 23, C = '1115 W Franklin' ? ;
     ...

Given a predicate representing a table, the predicate data can be
written to a file or stream.  For example:

     | ?- tsv::write_file('output.tsv', user, p/3).
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: types,  Next: tzif,  Prev: tsv,  Up: Libraries

6.206 ‘types’
=============

This library implements predicates over standard Prolog term types and
also terms representing common data structures such as lists and pairs.

It also includes a user-extensible ‘type’ object defining type checking
predicates over common Logtalk and Prolog term types.  The types define
a hierarchy with the Prolog type ‘term’ at the root (i.e., type-checking
a predicate argument of type ‘term’ trivially succeeds).  Some types are
only meaningful for backend Prolog systems supporting non-universal
features (e.g., ‘cyclic’ or ‘char(CharSet)’ with a Unicode character
set).  See the API documentation for a full list of the types defined by
default.

* Menu:

* API documentation: API documentation<220>.
* Loading: Loading<222>.
* Testing: Testing<213>.
* Type-checking: Type-checking<2>.
* Defining new types::
* Examples: Examples<177>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<220>,  Next: Loading<222>,  Up: types

6.206.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#types’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<222>,  Next: Testing<213>,  Prev: API documentation<220>,  Up: types

6.206.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(types(loader)).

If your code only requires the most basic types, you can load in
alternative the file:

     | ?- logtalk_load(basic_types(loader)).

See the notes on the ‘basic_types’ virtual library for details.


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<213>,  Next: Type-checking<2>,  Prev: Loading<222>,  Up: types

6.206.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(types(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Type-checking<2>,  Next: Defining new types,  Prev: Testing<213>,  Up: types

6.206.4 Type-checking
---------------------

This library ‘type’ object can be used to type-check common Logtalk and
Prolog term types (see the object documentation for a listing of all the
pre-defined types).  The ‘valid/2’ predicate succeeds or fails if a term
is of a given type.  For example:

     | ?- type::valid(positive_integer, 42).
     yes

     | ?- type::valid(positive_integer, -13).
     no

The ‘check/2’ and ‘check/3’ predicates throw an exception if a term is
not of a given type.  For example:

     | ?- catch(type::check(integer, abc), Error, true).
     Error = type_error(integer, abc)
     yes

If we require a standard ‘error/2’ exception term, the ‘check/3’
predicate takes a 'context' argument.  For example:

     | ?- catch(type::check(integer, abc, foo/3), Error, true).
     Error = error(type_error(integer, abc), foo/3)
     yes

Typically, the context is provided by calling the built-in ‘context/1’
method.


File: TheLogtalkHandbook-3.100.1.info,  Node: Defining new types,  Next: Examples<177>,  Prev: Type-checking<2>,  Up: types

6.206.5 Defining new types
--------------------------

To define a custom type, define clauses for the multifile predicates
‘type::type/1’ (to declare the type) and ‘type::check/2’ (to type-check
values).  For example:

     :- multifile(type::type/1).
     type::type(age).

     :- multifile(type::check/2).
     type::check(age, Term) :-
         type::check(between(non_negative_integer, 0, 150), Term).

Be careful to ensure that the new type definitions don’t introduce
spurious choice-points for these predicates.  The unit tests of the
‘types’ library perform this check for pre-defined and loaded
user-defined ground types.

When defining a meta-type (i.e., a type with arguments that are also
types), add also a clause for the ‘type::meta_type/3’ multifile
predicate.  For example:

     :- multifile(type::meta_type/3).
     type::meta_type(tuple(Type1, Type2, Type3), [Type1, Type2, Type3], []).

This predicate is called when checking if a type is a defined type.  For
meta-types, that check must extend to the sub-types.


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<177>,  Prev: Defining new types,  Up: types

6.206.6 Examples
----------------

See e.g.  the ‘os’ library implementation of custom types for files and
directories.  Or the ‘expecteds’ and ‘optionals’ libraries custom types.
See also the ‘my_types’ programming example.


File: TheLogtalkHandbook-3.100.1.info,  Node: tzif,  Next: ulid,  Prev: types,  Up: Libraries

6.207 ‘tzif’
============

The ‘tzif’ library loads TZif v1, v2, and v3 files from the IANA time
zone database into inspectable terms and answers UTC-based lookup
queries over one or more zones.

'Requires a backend Prolog compiler with unbounded integer arithmetic.'

Current feature set:

   - Loads sources given as ‘file(Path, ZoneId)’, ‘files(Root, Paths)’,
     ‘directory(Root)’, ‘stream(Stream, ZoneId)’, ‘bytes(Bytes,
     ZoneId)’, or ‘snapshot(File)’ using ‘load/1’ or ‘load/2’.

   - Supports TZif v1, v2, and v3, including validated skipping of the
     v1 compatibility block in v2/v3 files.

   - Parses POSIX footers, including signed-hour and signed-minute
     offsets.

   - Exposes zone-aware lookup predicates over loaded ‘tzif(...)’ terms,
     plus cached convenience variants for zone and single-zone queries.

   - Exposes strict local civil-time lookup predicates that fail cleanly
     for ambiguous or nonexistent times.

   - Exposes ‘*_with_resolution’ local civil-time query predicates for
     explicit resolution modes (‘strict’, ‘first’, ‘second’, and ‘all’).

   - Exposes ‘*_reified’ local civil-time query predicates that return
     ‘unique(...)’, ‘ambiguous(...)’, or ‘nonexistent’ results.

   - Caches successful ‘load/1’ calls automatically, while ‘load/2’
     returns a loaded term without changing the cache.

   - Provides ‘cache/1’ for making an already loaded ‘tzif(...)’ term
     the active cached term.

   - Saves and reloads ‘tzif(...)’ terms as plain Prolog snapshot files,
     with ‘save/1’ providing a convenience predicate for saving the
     cached term.

   - Returns the source term recorded in the active cached term via
     ‘cache_source/1’.

   - Exposes the active cached term using ‘cached_tzif/1’.

   - Exposes the cached zone list using ‘zones/1’.

   - Accepts UTC queries as Unix seconds or ‘date_time/6’ terms.

   - Validates zone identifiers against bundled IANA TZDB 2026a
     canonical names plus backward-compatible aliases.

* Menu:

* API documentation: API documentation<221>.
* Loading: Loading<223>.
* Testing: Testing<214>.
* Representation: Representation<20>.
* Zone identifier validation::
* Local Queries::
* Examples: Examples<178>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<221>,  Next: Loading<223>,  Up: tzif

6.207.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#tzif’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<223>,  Next: Testing<214>,  Prev: API documentation<221>,  Up: tzif

6.207.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(tzif(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<214>,  Next: Representation<20>,  Prev: Loading<223>,  Up: tzif

6.207.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(tzif(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<20>,  Next: Zone identifier validation,  Prev: Testing<214>,  Up: tzif

6.207.4 Representation
----------------------

Loaded sources are returned by ‘load/2’ as lists of ‘tzif(Zone, Source,
ZoneData)’ terms, one term per loaded zone.

Each nested ‘ZoneData’ term contains the parsed block data, leap-second
records, and parsed footer for a single zone.  These per-zone
‘tzif(...)’ terms are stable enough to be serialized directly using
‘save/2’ and restored using ‘load(snapshot(File), TZifs)’.

For directory and file-set loads, zone identifiers are the relative
paths used to locate the TZif files inside the root directory, and each
loaded term records its own ‘file(File, ZoneId)’ source.

When loading a ‘directory(Root)’, regular files whose relative paths are
not recognized zone identifiers are ignored.  This allows loading system
zoneinfo trees that also contain metadata files such as ‘leapseconds’.

For single-zone file, stream, and byte-list loads, the caller must
provide the zone identifier explicitly using ‘file(Path, ZoneId)’,
‘stream(Stream, ZoneId)’, or ‘bytes(Bytes, ZoneId)’.

The cache stores one ‘tzif(...)’ term per zone id.  ‘load/1’ and
‘cache/1’ replace only cached entries whose zone ids match the newly
loaded terms.


File: TheLogtalkHandbook-3.100.1.info,  Node: Zone identifier validation,  Next: Local Queries,  Prev: Representation<20>,  Up: tzif

6.207.5 Zone identifier validation
----------------------------------

The library validates zone identifiers using bundled data derived from
the official IANA TZDB 2026a release.  Accepted identifiers include both
canonical zone names such as ‘America/New_York’ and backward-compatible
aliases such as ‘US/Eastern’.

The bundled data is generated from the IANA ‘zone1970.tab’ and
‘backward’ files and does not consult the host operating system’s
installed zoneinfo tree.

To refresh the bundled table for a newer IANA release, run:

     $ ./update_zone_ids.sh 2026a


File: TheLogtalkHandbook-3.100.1.info,  Node: Local Queries,  Next: Examples<178>,  Prev: Zone identifier validation,  Up: tzif

6.207.6 Local Queries
---------------------

The library provides three sets of predicates for local civil-time
queries.

Strict predicates:

   - ‘local_time_type/2-4’

   - ‘local_offset/2-4’

   - ‘local_daylight_saving_time/2-4’

   - ‘local_abbreviation/2-4’

These predicates are intended for local civil times with a unique
interpretation.  They fail for ambiguous fold times and nonexistent gap
times.

Explicit-resolution predicates:

   - ‘local_time_type_with_resolution/3-5’

   - ‘local_offset_with_resolution/3-5’

   - ‘local_daylight_saving_time_with_resolution/3-5’

   - ‘local_abbreviation_with_resolution/3-5’

These predicates accept an explicit resolution mode argument.  Supported
modes are ‘strict’, ‘first’, ‘second’, and ‘all’.

   - ‘strict’: succeed only when the local civil time has a unique
     interpretation

   - ‘first’: select the earliest valid interpretation

   - ‘second’: select the latest valid interpretation

   - ‘all’: enumerate all valid interpretations in chronological order

Reified predicates:

   - ‘local_time_type_reified/2-4’

   - ‘local_offset_reified/2-4’

   - ‘local_daylight_saving_time_reified/2-4’

   - ‘local_abbreviation_reified/2-4’

These predicates never use failure to distinguish ambiguity from
absence.  Instead, they return one of the following results:

   - ‘unique(...)’

   - ‘ambiguous(...)’

   - ‘nonexistent’


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<178>,  Prev: Local Queries,  Up: tzif

6.207.7 Examples
----------------

Load a single TZif payload without caching it:

     | ?- tzif::load(bytes(Bytes, 'America/New_York'), TZifs).

Cache an already loaded term explicitly:

     | ?- tzif::load(bytes(Bytes, 'America/New_York'), TZifs), tzif::cache(TZifs).

Load a directory tree of TZif files:

     | ?- tzif::load(directory('/usr/share/zoneinfo'), TZifs).

Query a specific zone in a loaded term:

     | ?- tzif::load(bytes(Bytes, 'America/New_York'), [TZif]).
     | ?- tzif::offset(TZif, 'America/New_York', date_time(2024, 7, 1, 12, 0, 0), Offset).

Query a specific zone in the cached term:

     | ?- tzif::load(directory('/usr/share/zoneinfo')).
     | ?- tzif::offset('America/New_York', date_time(2024, 7, 1, 12, 0, 0), Offset).

Persist and reload a snapshot:

     | ?- tzif::save(TZifs, 'snapshot.pl').
     | ?- tzif::load(snapshot('snapshot.pl'), ReloadedTZifs).

Save the cached terms directly:

     | ?- tzif::load(directory('/usr/share/zoneinfo')).
     | ?- tzif::save('snapshot.pl').

Load using a backward-compatible alias:

     | ?- tzif::load(bytes(Bytes, 'US/Eastern'), TZifs).

Use the automatic cache populated by ‘load/1’:

     | ?- tzif::load(snapshot('snapshot.pl')).
     | ?- tzif::abbreviation(date_time(2024, 7, 1, 12, 0, 0), Abbreviation).

Resolve an ambiguous local civil time explicitly:

     | ?- tzif::local_offset_with_resolution('America/New_York', date_time(2024, 11, 3, 1, 30, 0), first, Offset).

Inspect whether a local civil time is unique, ambiguous, or nonexistent:

     | ?- tzif::local_time_type_reified('America/New_York', date_time(2024, 11, 3, 1, 30, 0), Result).

List cached zones directly:

     | ?- tzif::load(directory('/usr/share/zoneinfo')).
     | ?- tzif::zones(Zones).


File: TheLogtalkHandbook-3.100.1.info,  Node: ulid,  Next: unicode_data,  Prev: tzif,  Up: Libraries

6.208 ‘ulid’
============

This library implements a Universally Unique Lexicographically Sortable
Identifier (ULID) generator.

‘https://github.com/ulid/spec’

Note that most backends provide time stamps with lower granularity than
required (i.e., seconds but not milliseconds).  Also note that, per
spec, within the same millisecond, monotonic sort order is not
guaranteed.

The generation of ULIDs uses the ‘/dev/urandom’ random number generator
when available.  This includes macOS, Linux, *BSD, and other POSIX
operating-systems.  On Windows, a pseudo-random generator is used, but
randomized using the current wall time.

ULIDs can be generated as atoms, lists of characters, or lists of
character codes.

See also the ‘cuid2’, ‘ids’, ‘ksuid’, ‘snowflakeid’, ‘nanoid’, and
‘uuid’ libraries.

* Menu:

* API documentation: API documentation<222>.
* Loading: Loading<224>.
* Testing: Testing<215>.
* Generating ULIDs::
* Type-checking ULIDs::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<222>,  Next: Loading<224>,  Up: ulid

6.208.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#ulid’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<224>,  Next: Testing<215>,  Prev: API documentation<222>,  Up: ulid

6.208.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(ulid(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<215>,  Next: Generating ULIDs,  Prev: Loading<224>,  Up: ulid

6.208.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(ulid(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating ULIDs,  Next: Type-checking ULIDs,  Prev: Testing<215>,  Up: ulid

6.208.4 Generating ULIDs
------------------------

By default, ULIDs are generated as atoms.  For example:

     | ?- ulid::generate(ULID).
     ULID = '01H0J31SYQXHJZWPRAKHQ6YVYH'
     yes

To generate a ULID using a list of characters representation, use
instead the ‘ulid/1’ parametric object:

     | ?- ulid(chars)::generate(ULID).
     ULID = ['0','1','H','0','J','3','2','Y','V','5','V','S','P','K','5','P','4','5','G','G','0','9','8','8','M','2']
     yes

Similarly, to get a ULID using a list of character codes representation:

     | ?- ulid(codes)::generate(ULID).
     ULID = [48,49,72,48,74,51,52,66,54,48,55,57,54,49,67,82,70,65,67,51,67,67,86,82,48,66]
     yes

It’s also possible to generate ULIDs from a given timestamp, i.e.  the
number of milliseconds since the Unix epoch (00:00:00 UTC on January 1,
1970), using the ‘generate/2’ predicate.  The timestamp must be an
integer.  For example, assuming a backend Prolog system providing a
‘time_stamp/1’ predicate returning the Unix epoch in milliseconds:

     | ?- time_stamp(Milliseconds), ulid(atom)::generate(Seconds, ULID).
     Seconds = 1684245175344, ULID = '01H0JDBQ1GAWJF35C44Y5S97DX'
     yes

You can also use timestamp discrete components using the ‘generate/8’
predicate.  For example:

     | ?- ulid(atom)::generate(2023, 5, 17, 16, 23, 38, 591, ULID).
     ULID = '01H0N8CDAZK75C5H3BJSGS4VCQ'
     yes

To extract the timestamp from a given ULID, use the ‘timestamp/2’ and
‘timestamp/8’ predicates.  For example:

     | ?- ulid(atom)::timestamp('01H0JDBQ1GAWJF35C44Y5S97DX', Milliseconds).
     Milliseconds = 1684245175344
     yes

     | ?- ulid(atom)::timestamp('01H0N8CDAZK75C5H3BJSGS4VCQ', Year, Month, Day, Hours, Minutes, Seconds, Milliseconds).
     Year = 2023, Month = 5, Day = 17, Hours = 16, Minutes = 23, Seconds = 38, Milliseconds = 591
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Type-checking ULIDs,  Prev: Generating ULIDs,  Up: ulid

6.208.5 Type-checking ULIDs
---------------------------

This library also defines a ‘ulid(Representation)’ type for
type-checking ULIDs.  For example, with an atom containing invalid
characters:

     | ?- type::check(ulid(atom), '01BX5ZIKBKALTAV9OEVGEMMVRY').
     uncaught exception: domain_error(ulid,'01BX5ZIKBKALTAV9OEVGEMMVRY')


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_data,  Next: union_find,  Prev: ulid,  Up: Libraries

6.209 ‘unicode_data’
====================

VivoMind Prolog Unicode Resources

* Menu:

* Authors::
* License::
* Website::
* Description: Description<165>.
* Requirements: Requirements<6>.
* Usage: Usage<105>.
* Known issues: Known issues<21>.
* Acknowledgements::
* Files and API Summary::


File: TheLogtalkHandbook-3.100.1.info,  Node: Authors,  Next: License,  Up: unicode_data

6.209.1 Authors
---------------

     Arun Majumdar @ VivoMind LLC
     Paulo Moura @ VivoMind LLC


File: TheLogtalkHandbook-3.100.1.info,  Node: License,  Next: Website,  Prev: Authors,  Up: unicode_data

6.209.2 License
---------------

Creative Commons CC0 1.0 Universal (CC0 1.0) - Public Domain Dedication:

     https://creativecommons.org/publicdomain/zero/1.0/

We do appreciate acknowledgment if you use these resources, however, and
we also welcome contributions to improve them.


File: TheLogtalkHandbook-3.100.1.info,  Node: Website,  Next: Description<165>,  Prev: License,  Up: unicode_data

6.209.3 Website
---------------

The latest release of the VivoMind Prolog Unicode Resources is available
at the URL:

     https://github.com/VivoMind

At this address you can also find additional information about the
VivoMind Prolog Unicode Resources and submit your bug reports and
contributions.


File: TheLogtalkHandbook-3.100.1.info,  Node: Description<165>,  Next: Requirements<6>,  Prev: Website,  Up: unicode_data

6.209.4 Description
-------------------

The VivoMind Prolog Unicode Resources are a set of files resulting from
the conversion of most (but not all) official UCD 6.1 files and updated
for the few changes in the 6.2 standard.  The original files can be
downloaded from:

     http://www.unicode.org

The conversion of the UCD files resulted in a large number of Prolog
tables and also a set of auxiliary predicates (described below) for
accessing these tables.  Other than the obvious conversion in the
provided predicate names, no attempt was made to convert the identifiers
used for properties and other data.


File: TheLogtalkHandbook-3.100.1.info,  Node: Requirements<6>,  Next: Usage<105>,  Prev: Description<165>,  Up: unicode_data

6.209.5 Requirements
--------------------

Most of the auxiliary predicates assume that the de facto Prolog
standard predicate ‘between/3’ is available.  Unicode code point values
are represented using the ISO Prolog standard notation for hexadecimal
integers.  In addition, the ISO Prolog standard directives ‘include/1’
and ‘ensure_loaded/1’ are used in some of the files to load auxiliary
files.


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<105>,  Next: Known issues<21>,  Prev: Requirements<6>,  Up: unicode_data

6.209.6 Usage
-------------

Most applications only require some of the tables present in these
resources.  Most of these tables define properties for ranges of code
points and not for single code points, but the provided auxiliary
predicates allow access for a single code point.  When increased
performance is required, consider using the existing tables and
auxiliary predicates to generate derived tables more fit for your
specific application.


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<21>,  Next: Acknowledgements,  Prev: Usage<105>,  Up: unicode_data

6.209.7 Known issues
--------------------

In the file ‘unicode_unihan_variant.pl’, when there’s more than one
variant for a code point, only the first one (as listed in the original
UCD file) is returned.

The ‘include/1’ and ‘ensure_loaded/1’ directives are specified in the
ISO Prolog standard published in 1995.  But some Prolog compilers either
don’t implement one or both directives or have flawed implementations.
Thus, you may need to change how some of the files are loaded depending
on the chosen Prolog compiler.  Using conditional compilation directives
would help in some cases, but it would also raise portability issues on
its own.


File: TheLogtalkHandbook-3.100.1.info,  Node: Acknowledgements,  Next: Files and API Summary,  Prev: Known issues<21>,  Up: unicode_data

6.209.8 Acknowledgements
------------------------

We thank Richard O’Keefe for helpful suggestions to improve the
usability of these resources.


File: TheLogtalkHandbook-3.100.1.info,  Node: Files and API Summary,  Prev: Acknowledgements,  Up: unicode_data

6.209.9 Files and API Summary
-----------------------------

The Prolog file names are derived from the original file names by
prefixing them with the ‘unicode_’ string, converting to lower case, and
replacing the camel case spelling with underscores.  There are, however,
two exceptions: the files and directories holding the code point
categories and names.

There’s also a utility file, ‘unicode_data.pl’, that can be used to load
all the files in these resources.  It is mostly used to test the
portability of the code across Prolog compilers.  Also included is a
Logtalk version of this file, ‘unicode_data.lgt’, which uses Logtalk’s
own implementation of the ‘include/1’ directive and the ‘logtak_load/1’
predicate to load all files.  This file can be used to workaround Prolog
systems with buggy or missing implementations of the ‘ensure_loaded/1’
and ‘include/1’ directives.

An overview of the original file names and the code point properties can
be found at:

     http://www.unicode.org/reports/tr44/#Directory_Structure

     http://www.unicode.org/reports/tr44/#Property_Definitions

* Menu:

* unicode_arabic_shaping.pl: unicode_arabic_shaping pl.
* unicode_bidi_mirroring.pl: unicode_bidi_mirroring pl.
* unicode_blocks.pl: unicode_blocks pl.
* unicode_case_folding.pl: unicode_case_folding pl.
* unicode_categories.pl: unicode_categories pl.
* unicode_cjk_radicals.pl: unicode_cjk_radicals pl.
* unicode_composition_exclusions.pl: unicode_composition_exclusions pl.
* unicode_core_properties.pl: unicode_core_properties pl.
* unicode_decomposition_type.pl: unicode_decomposition_type pl.
* unicode_derived_age.pl: unicode_derived_age pl.
* unicode_derived_bidi_class.pl: unicode_derived_bidi_class pl.
* unicode_derived_combining_class.pl: unicode_derived_combining_class pl.
* unicode_derived_core_properties.pl: unicode_derived_core_properties pl.
* unicode_derived_decomposition_type.pl: unicode_derived_decomposition_type pl.
* unicode_derived_east_asian_width.pl: unicode_derived_east_asian_width pl.
* unicode_derived_joining_group.pl: unicode_derived_joining_group pl.
* unicode_derived_joining_type.pl: unicode_derived_joining_type pl.
* unicode_derived_line_break.pl: unicode_derived_line_break pl.
* unicode_derived_normalization_props.pl: unicode_derived_normalization_props pl.
* unicode_derived_numeric_type.pl: unicode_derived_numeric_type pl.
* unicode_derived_numeric_values.pl: unicode_derived_numeric_values pl.
* unicode_hangul_syllable_type.pl: unicode_hangul_syllable_type pl.
* unicode_indic_matra_category.pl: unicode_indic_matra_category pl.
* unicode_indic_syllabic_category.pl: unicode_indic_syllabic_category pl.
* unicode_jamo.pl: unicode_jamo pl.
* unicode_name_aliases.pl: unicode_name_aliases pl.
* unicode_names.pl: unicode_names pl.
* unicode_prop_list.pl: unicode_prop_list pl.
* unicode_range_scripts.pl: unicode_range_scripts pl.
* unicode_script_extensions.pl: unicode_script_extensions pl.
* unicode_scripts.pl: unicode_scripts pl.
* unicode_special_casing.pl: unicode_special_casing pl.
* unicode_unihan_variants.pl: unicode_unihan_variants pl.
* unicode_version.pl: unicode_version pl.


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_arabic_shaping pl,  Next: unicode_bidi_mirroring pl,  Up: Files and API Summary

6.209.9.1 ‘unicode_arabic_shaping.pl’
.....................................

   - Provides: ‘unicode_arabic_shaping/4’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_bidi_mirroring pl,  Next: unicode_blocks pl,  Prev: unicode_arabic_shaping pl,  Up: Files and API Summary

6.209.9.2 ‘unicode_bidi_mirroring.pl’
.....................................

   - Provides: ‘unicode_bidi_mirroring/2’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_blocks pl,  Next: unicode_case_folding pl,  Prev: unicode_bidi_mirroring pl,  Up: Files and API Summary

6.209.9.3 ‘unicode_blocks.pl’
.............................

   - Provides: ‘unicode_block/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_case_folding pl,  Next: unicode_categories pl,  Prev: unicode_blocks pl,  Up: Files and API Summary

6.209.9.4 ‘unicode_case_folding.pl’
...................................

   - Provides: ‘unicode_case_folding/3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_categories pl,  Next: unicode_cjk_radicals pl,  Prev: unicode_case_folding pl,  Up: Files and API Summary

6.209.9.5 ‘unicode_categories.pl’
.................................

   - Provides: ‘unicode_category/2’

   - Dependencies: files in the ‘unicode_categories’ directory


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_cjk_radicals pl,  Next: unicode_composition_exclusions pl,  Prev: unicode_categories pl,  Up: Files and API Summary

6.209.9.6 ‘unicode_cjk_radicals.pl’
...................................

   - Provides: ‘unicode_cjk_radical/3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_composition_exclusions pl,  Next: unicode_core_properties pl,  Prev: unicode_cjk_radicals pl,  Up: Files and API Summary

6.209.9.7 ‘unicode_composition_exclusions.pl’
.............................................

   - Provides: ‘unicode_composition_exclusion/1’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_core_properties pl,  Next: unicode_decomposition_type pl,  Prev: unicode_composition_exclusions pl,  Up: Files and API Summary

6.209.9.8 ‘unicode_core_properties.pl’
......................................

   - Provides: ‘unicode_math/1-2’ ‘unicode_alphabetic/1-2’
     ‘unicode_range_alphabetic/2’ ‘unicode_lowercase/1-2’
     ‘unicode_uppercase/1-2’ ‘unicode_cased/1-2’
     ‘unicode_case_ignorable/1-2’ ‘unicode_changes_when_lowercased/1-2’
     ‘unicode_changes_when_uppercased/1-2’
     ‘unicode_changes_when_titlecased/1-2’
     ‘unicode_changes_when_casefolded/1-2’
     ‘unicode_changes_when_casemapped/1-2’ ‘unicode_id_start/1-2’
     ‘unicode_id_continue/1-2’ ‘unicode_xid_start/1-2’
     ‘unicode_xid_continue/1-2’ ‘unicode_default_ignorable/1-2’
     ‘unicode_grapheme_extend/1-2’ ‘unicode_grapheme_base/1-2’
     ‘unicode_grapheme_link/1-2’

   - Dependencies: files in the ‘unicode_core_properties’ directory


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_decomposition_type pl,  Next: unicode_derived_age pl,  Prev: unicode_core_properties pl,  Up: Files and API Summary

6.209.9.9 ‘unicode_decomposition_type.pl’
.........................................

   - Provides: ‘unicode_canonical/1-2’ ‘unicode_compat/1-2’
     ‘unicode_font/1-2’ ‘unicode_nobreak/1-2’ ‘unicode_initial/1-2’
     ‘unicode_medial/1-2’ ‘unicode_final/1-2’ ‘unicode_isolated/1-2’
     ‘unicode_circle/1-2’ ‘unicode_super/1-2’ ‘unicode_sub/1-2’
     ‘unicode_vertical/1-2’ ‘unicode_wide/1-2’ ‘unicode_narrow/1-2’
     ‘unicode_small/1-2’ ‘unicode_square/1-2’ ‘unicode_fraction/1-2’

   - Dependencies: files in the ‘unicode_decomposition_type’ directory


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_age pl,  Next: unicode_derived_bidi_class pl,  Prev: unicode_decomposition_type pl,  Up: Files and API Summary

6.209.9.10 ‘unicode_derived_age.pl’
...................................

   - Provides: ‘unicode_age/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_bidi_class pl,  Next: unicode_derived_combining_class pl,  Prev: unicode_derived_age pl,  Up: Files and API Summary

6.209.9.11 ‘unicode_derived_bidi_class.pl’
..........................................

   - Provides: ‘unicode_bidi_class/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_combining_class pl,  Next: unicode_derived_core_properties pl,  Prev: unicode_derived_bidi_class pl,  Up: Files and API Summary

6.209.9.12 ‘unicode_derived_combining_class.pl’
...............................................

   - Provides: ‘unicode_combining_class/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_core_properties pl,  Next: unicode_derived_decomposition_type pl,  Prev: unicode_derived_combining_class pl,  Up: Files and API Summary

6.209.9.13 ‘unicode_derived_core_properties.pl’
...............................................

   - Provides: ‘unicode_core_property/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_decomposition_type pl,  Next: unicode_derived_east_asian_width pl,  Prev: unicode_derived_core_properties pl,  Up: Files and API Summary

6.209.9.14 ‘unicode_derived_decomposition_type.pl’
..................................................

   - Provides: ‘unicode_decomposition_type/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_east_asian_width pl,  Next: unicode_derived_joining_group pl,  Prev: unicode_derived_decomposition_type pl,  Up: Files and API Summary

6.209.9.15 ‘unicode_derived_east_asian_width.pl’
................................................

   - Provides: ‘unicode_east_asian_width/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_joining_group pl,  Next: unicode_derived_joining_type pl,  Prev: unicode_derived_east_asian_width pl,  Up: Files and API Summary

6.209.9.16 ‘unicode_derived_joining_group.pl’
.............................................

   - Provides: ‘unicode_joining_group/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_joining_type pl,  Next: unicode_derived_line_break pl,  Prev: unicode_derived_joining_group pl,  Up: Files and API Summary

6.209.9.17 ‘unicode_derived_joining_type.pl’
............................................

   - Provides: ‘unicode_joining_type/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_line_break pl,  Next: unicode_derived_normalization_props pl,  Prev: unicode_derived_joining_type pl,  Up: Files and API Summary

6.209.9.18 ‘unicode_derived_line_break.pl’
..........................................

   - Provides: ‘unicode_line_break/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_normalization_props pl,  Next: unicode_derived_numeric_type pl,  Prev: unicode_derived_line_break pl,  Up: Files and API Summary

6.209.9.19 ‘unicode_derived_normalization_props.pl’
...................................................

   - Provides: ‘unicode_fc_nfkc/2’ ‘unicode_nfkc_cf/2’
     ‘unicode_full_composition_exclusion/1-2’ ‘unicode_nfd_qc_no/1-2’
     ‘unicode_nfc_qc_no/1-2’ ‘unicode_nfc_qc_maybe/1-2’
     ‘unicode_nfkd_qc_no/1-2’ ‘unicode_nfkc_qc_no/1-2’
     ‘unicode_nfkc_qc_maybe/1-2’ ‘unicode_expands_on_nfd/1-2’
     ‘unicode_expands_on_nfc/1-2’ ‘unicode_expands_on_nfkd/1-2’
     ‘unicode_expands_on_nfkc/1-2’
     ‘unicode_changes_when_nfkc_casefolded/1-2’

   - Dependencies: files in the ‘unicode_derived_normalization_props’
     directory


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_numeric_type pl,  Next: unicode_derived_numeric_values pl,  Prev: unicode_derived_normalization_props pl,  Up: Files and API Summary

6.209.9.20 ‘unicode_derived_numeric_type.pl’
............................................

   - Provides: ‘unicode_numeric_type/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_derived_numeric_values pl,  Next: unicode_hangul_syllable_type pl,  Prev: unicode_derived_numeric_type pl,  Up: Files and API Summary

6.209.9.21 ‘unicode_derived_numeric_values.pl’
..............................................

   - Provides: ‘unicode_numerical_value/3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_hangul_syllable_type pl,  Next: unicode_indic_matra_category pl,  Prev: unicode_derived_numeric_values pl,  Up: Files and API Summary

6.209.9.22 ‘unicode_hangul_syllable_type.pl’
............................................

   - Provides: ‘unicode_hangul_syllable_type/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_indic_matra_category pl,  Next: unicode_indic_syllabic_category pl,  Prev: unicode_hangul_syllable_type pl,  Up: Files and API Summary

6.209.9.23 ‘unicode_indic_matra_category.pl’
............................................

   - Provides: ‘unicode_indic_matra_category/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_indic_syllabic_category pl,  Next: unicode_jamo pl,  Prev: unicode_indic_matra_category pl,  Up: Files and API Summary

6.209.9.24 ‘unicode_indic_syllabic_category.pl’
...............................................

   - Provides: ‘unicode_indic_syllabic_category/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_jamo pl,  Next: unicode_name_aliases pl,  Prev: unicode_indic_syllabic_category pl,  Up: Files and API Summary

6.209.9.25 ‘unicode_jamo.pl’
............................

   - Provides: ‘unicode_jamo/2’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_name_aliases pl,  Next: unicode_names pl,  Prev: unicode_jamo pl,  Up: Files and API Summary

6.209.9.26 ‘unicode_name_aliases.pl’
....................................

   - Provides: ‘unicode_name_alias/3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_names pl,  Next: unicode_prop_list pl,  Prev: unicode_name_aliases pl,  Up: Files and API Summary

6.209.9.27 ‘unicode_names.pl’
.............................

   - Provides: ‘unicode_name/2’

   - Dependencies: files in the ‘unicode_names’ directory


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_prop_list pl,  Next: unicode_range_scripts pl,  Prev: unicode_names pl,  Up: Files and API Summary

6.209.9.28 ‘unicode_prop_list.pl’
.................................

   - Provides: ‘unicode_white_space/1-2’ ‘unicode_bidi_control/1-2’
     ‘unicode_join_control/1-2’ ‘unicode_dash/1-2’ ‘unicode_hyphen/1-2’
     ‘unicode_quotation_mark/1-2’ ‘unicode_terminal_punctuation/1-2’
     ‘unicode_other_math/1-2’ ‘unicode_hex_digit/1-2’
     ‘unicode_ascii_hex_digit/1-2’ ‘unicode_other_alphabetic/1-2’
     ‘unicode_ideographic/1-2’ ‘unicode_diacritic/1-2’
     ‘unicode_extender/1-2’ ‘unicode_other_lowercase/1-2’
     ‘unicode_other_uppercase/1-2’ ‘unicode_noncharacter_code_point/1-2’
     ‘unicode_other_grapheme_extend/1-2’
     ‘unicode_ids_binary_operator/1-2’
     ‘unicode_ids_trinary_operator/1-2’ ‘unicode_radical/1-2’
     ‘unicode_unified_ideograph/1-2’
     ‘unicode_other_default_ignorable/1-2’ ‘unicode_deprecated/1-2’
     ‘unicode_soft_dotted/1-2’ ‘unicode_logical_order_exception/1-2’
     ‘unicode_other_id_start/1-2’ ‘unicode_other_id_continue/1-2’
     ‘unicode_sterm/1-2’ ‘unicode_variation_selector/1-2’
     ‘unicode_pattern_white_space/1-2’ ‘unicode_pattern_syntax/1-2’

   - Dependencies: files in the ‘unicode_prop_list’ directory


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_range_scripts pl,  Next: unicode_script_extensions pl,  Prev: unicode_prop_list pl,  Up: Files and API Summary

6.209.9.29 ‘unicode_range_scripts.pl’
.....................................

   - Provides: ‘unicode_range_script/3’ ‘unicode_script/2’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_script_extensions pl,  Next: unicode_scripts pl,  Prev: unicode_range_scripts pl,  Up: Files and API Summary

6.209.9.30 ‘unicode_script_extensions.pl’
.........................................

   - Provides: ‘unicode_script_extension/2-3’

   - Dependencies: ‘unicode_scripts.pl’


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_scripts pl,  Next: unicode_special_casing pl,  Prev: unicode_script_extensions pl,  Up: Files and API Summary

6.209.9.31 ‘unicode_scripts.pl’
...............................

   - Provides: ‘unicode_script/6’ ‘unicode_script_category/3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_special_casing pl,  Next: unicode_unihan_variants pl,  Prev: unicode_scripts pl,  Up: Files and API Summary

6.209.9.32 ‘unicode_special_casing.pl’
......................................

   - Provides: ‘unicode_special_casing/5’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_unihan_variants pl,  Next: unicode_version pl,  Prev: unicode_special_casing pl,  Up: Files and API Summary

6.209.9.33 ‘unicode_unihan_variants.pl’
.......................................

   - Provides: ‘unicode_unihan_variant/2-3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: unicode_version pl,  Prev: unicode_unihan_variants pl,  Up: Files and API Summary

6.209.9.34 ‘unicode_version.pl’
...............................

   - Provides: ‘unicode_version/3’

   - Dependencies: (none)


File: TheLogtalkHandbook-3.100.1.info,  Node: union_find,  Next: url,  Prev: unicode_data,  Up: Libraries

6.210 ‘union_find’
==================

This library implements a union-find data structure.  This structure
tracks a set of elements partitioned into a number of disjoint
(non-overlapping) subsets.  It provides fast operations to add new sets,
to merge existing sets, and to determine whether elements are in the
same set.  This implementation of the union-find algorithm provides the
following features:

   - Path compression: Path compression flattens the structure of the
     tree by making every node point to the root whenever a find
     predicate is used on it.

   - Union by rank: Union predicates always attach the shorter tree to
     the root of the taller tree.  Thus, the resulting tree is no taller
     than the original unless they were of equal height, in which case
     the resulting tree is taller by one node.

For a general and extended discussion on this data structure, see e.g.

‘https://en.wikipedia.org/wiki/Disjoint-set_data_structure’

* Menu:

* API documentation: API documentation<223>.
* Loading: Loading<225>.
* Testing: Testing<216>.
* Usage: Usage<106>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<223>,  Next: Loading<225>,  Up: union_find

6.210.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#union-find’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<225>,  Next: Testing<216>,  Prev: API documentation<223>,  Up: union_find

6.210.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(union_find(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<216>,  Next: Usage<106>,  Prev: Loading<225>,  Up: union_find

6.210.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(union_find(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<106>,  Prev: Testing<216>,  Up: union_find

6.210.4 Usage
-------------

An usage example is Kruskal’s algorithm, a minimum-spanning-tree
algorithm which finds an edge of the least possible weight that connects
any two trees in the forest.  It is a greedy algorithm in graph theory
as it finds a minimum spanning tree for a connected weighted graph by
adding increasing cost arcs at each step.

     :- object(kruskal).

         :- public(kruskal/2).

         :- uses(union_find, [
             new/2, find/4, union/4
         ]).

         kruskal(g(Vertices-Edges), g(Vertices-Tree)) :-
             new(Vertices, UnionFind),
             keysort(Edges, Sorted),
             kruskal(UnionFind, Sorted, Tree).

         kruskal(_, [], []).
         kruskal(UnionFind0, [Edge| Edges], [Edge| Tree]) :-
             Edge = _-(Vertex1, Vertex2),
             find(UnionFind0, Vertex1, Root1, UnionFind1),
             find(UnionFind1, Vertex2, Root2, UnionFind2),
             Root1 \== Root2,
             !,
             union(UnionFind2, Vertex1, Vertex2, UnionFind3),
             kruskal(UnionFind3, Edges, Tree).
         kruskal(UnionFind, [_| Edges], Tree) :-
             kruskal(UnionFind, Edges, Tree).

     :- end_object.

Sample query:

     | ?- kruskal::kruskal(g([a,b,c,d,e,f,g]-[7-(a,b), 5-(a,d), 8-(b,c), 7-(b,e), 9-(b,d), 5-(c,e), 15-(d,e), 6-(d,f), 8-(e,f), 9-(e,g), 11-(f,g)]), Tree).

     Tree = g([a,b,c,d,e,f,g]-[5-(a,d),5-(c,e),6-(d,f),7-(a,b),7-(b,e),9-(e,g)])
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: url,  Next: uuid,  Prev: union_find,  Up: Libraries

6.211 ‘url’
===========

This library implements validation, parsing, generating, and
normalization of URLs, which can be represented as atoms, character
lists, or code lists.  It currently supports the following URL schemes:

Web protocols:

   - ‘http’

   - ‘https’

   - ‘ws’

   - ‘wss’

   - ‘gopher’

File transfer and version control:

   - ‘ftp’

   - ‘ftps’

   - ‘sftp’

   - ‘git’

File access:

   - ‘file’

Databases:

   - ‘jdbc’

   - ‘mongodb’

   - ‘mysql’

   - ‘postgresql’

Email and news:

   - ‘mailto’

   - ‘news’

   - ‘nntp’

Media streaming:

   - ‘mms’

   - ‘rtmp’

   - ‘rtsp’

Shell access:

   - ‘ssh’

   - ‘telnet’

Directory services:

   - ‘ldap’

   - ‘ldaps’

Other protocols:

   - ‘tel’

   - ‘urn’

The library predicates are defined in the ‘url(_Representation_)’
parametric object where ‘_Representation_’ can be one of:

   - ‘atom’ - strings are represented as atoms

   - ‘chars’ - strings are represented as lists of characters

   - ‘codes’ - strings are represented as lists of character codes

The parameter must be bound when sending messages to the object.

The library also provides an utility predicate,
‘file_path_components/2’, for converting a file-system path into file
URL components.  This predicate also handles Windows drive-letter and
UNC paths.

* Menu:

* API documentation: API documentation<224>.
* Loading: Loading<226>.
* Testing: Testing<217>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<224>,  Next: Loading<226>,  Up: url

6.211.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#url’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<226>,  Next: Testing<217>,  Prev: API documentation<224>,  Up: url

6.211.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(url(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<217>,  Prev: Loading<226>,  Up: url

6.211.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(url(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: uuid,  Next: validations,  Prev: url,  Up: Libraries

6.212 ‘uuid’
============

This library implements a Universally Unique Identifier (UUID)
generator.  Currently version 1, version 3, version 4, version 5, and
version 7 UUIDs are supported.  Version 5 support requires a Prolog
backend with support for unbounded integer arithmetic.  For reference
material, see e.g.

‘https://en.wikipedia.org/wiki/Universally_unique_identifier’

Some backends provide time stamps with low granularity (e.g., seconds
but not milliseconds or nanoseconds).  To compensate, the generation of
version 1 UUIDs uses 14 random bits for the clock sequence.

The generation of version 4 and version 7 UUIDs uses the ‘/dev/urandom’
random number generator when available.  This includes macOS, Linux,
*BSD, and other POSIX operating-systems.  On Windows, a pseudo-random
generator is used, but randomized using the current wall time.

Version 3 and version 5 UUIDs are namespace-name based UUIDs using the
MD5 and SHA-1 hash functions, respectively.

Version 7 UUIDs are time-ordered using a Unix Epoch timestamp in
milliseconds, as specified in RFC 9562.  They are recommended over
version 1 UUIDs for new applications due to improved entropy and
sortability characteristics.

UUIDs can be generated as atoms, lists of characters, or lists of
character codes.

See also the ‘cuid2’, ‘ksuid’, ‘ids’, ‘nanoid’, ‘snowflakeid’, and
‘ulid’ libraries.

* Menu:

* API documentation: API documentation<225>.
* Loading: Loading<227>.
* Testing: Testing<218>.
* Generating version 1 UUIDs::
* Generating version 4 UUIDs::
* Generating version 3 UUIDs::
* Generating version 5 UUIDs::
* Generating version 7 UUIDs::
* Generating the Nil and Max UUIDs::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<225>,  Next: Loading<227>,  Up: uuid

6.212.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#uuid’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<227>,  Next: Testing<218>,  Prev: API documentation<225>,  Up: uuid

6.212.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(uuid(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<218>,  Next: Generating version 1 UUIDs,  Prev: Loading<227>,  Up: uuid

6.212.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(uuid(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating version 1 UUIDs,  Next: Generating version 4 UUIDs,  Prev: Testing<218>,  Up: uuid

6.212.4 Generating version 1 UUIDs
----------------------------------

By default, version 1 UUIDs are generated as atoms.  For example:

     | ?- uuid::uuid_v1([0xf2,0xd1,0x90,0x94,0xdc,0x4b], UUID).
     UUID = '00a66fc0-82cf-11eb-bc83-f2d19094dc4b'
     yes

To generate a UUID using a list of characters representation, use
instead the ‘uuid/1’ parametric object:

     | ?- uuid(chars)::uuid_v1([0xf2,0xd1,0x90,0x94,0xdc,0x4b], UUID).
     UUID = ['0','0',d,e,'9','0',c,'0',-,'8','2',c,f,-,'1','1',e,b,-,
             a,'9','8','5',-,f,'2',d,'1','9','0','9','4',d,c,'4',b]
     yes

Similarly, to get a UUID using a list of character codes representation:

     | ?- uuid(codes)::uuid_v1([0xf2,0xd1,0x90,0x94,0xdc,0x4b], UUID).
     UUID = [48,48,52,99,99,54,99,48,45,56,50,99,102,45,49,49,101,98,45,
             98,57,102,52,45,102,50,100,49,57,48,57,52,100,99,52,98]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating version 4 UUIDs,  Next: Generating version 3 UUIDs,  Prev: Generating version 1 UUIDs,  Up: uuid

6.212.5 Generating version 4 UUIDs
----------------------------------

By default, version 4 UUIDs are generated as atoms.  For example:

     | ?- uuid::uuid_v4(UUID).
     UUID = '1c652782-69c5-4252-88c8-09e576a44db5'
     yes

To generate a UUID using a list of characters representation, use
instead the ‘uuid/1’ parametric object:

     | ?- uuid(chars)::uuid_v4(UUID).
     UUID = [d,'3',d,'3','3','5','1','3',-,'8','1',e,c,-,'4',d,'2','6',-,
             '9',f,'2','2',-,e,d,'9','5',e,'0','0',e,'1','5','7','0']
     yes

Similar to get a UUID using a list of character codes representation:

     | ?- uuid(codes)::uuid_v4(UUID).
     UUID = [102,97,52,54,57,98,100,50,45,51,57,54,51,45,52,97,100,55,45,
             98,50,50,55,45,101,100,52,99,56,55,99,54,53,55,102,98]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating version 3 UUIDs,  Next: Generating version 5 UUIDs,  Prev: Generating version 4 UUIDs,  Up: uuid

6.212.6 Generating version 3 UUIDs
----------------------------------

Version 3 UUIDs are namespace-name based UUIDs using the MD5 hash
function.  For example:

     | ?- uuid::uuid_v3('6ba7b810-9dad-11d1-80b4-00c04fd430c8', 'www.widgets.com', UUID).
     UUID = '3d813cbb-47fb-32ba-91df-831e1593ac29'
     yes

To generate a UUID using a list of characters representation, use
instead the ‘uuid/1’ parametric object:

     | ?- uuid(chars)::uuid_v3('6ba7b810-9dad-11d1-80b4-00c04fd430c8', 'www.widgets.com', UUID).
     UUID = ['3',d,'8','1','3',c,b,b,-,'4','7',f,b,-,'3','2',b,a,-,
             '9','1',d,f,-,'8','3','1',e,'1','5','9','3',a,c,'2','9']
     yes

Similarly, to get a UUID using a list of character codes representation:

     | ?- uuid(codes)::uuid_v3('6ba7b810-9dad-11d1-80b4-00c04fd430c8', 'www.widgets.com', UUID).
     UUID = [51,100,56,49,51,99,98,98,45,52,55,102,98,45,51,50,98,97,45,
             57,49,100,102,45,56,51,49,101,49,53,57,51,97,99,50,57]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating version 5 UUIDs,  Next: Generating version 7 UUIDs,  Prev: Generating version 3 UUIDs,  Up: uuid

6.212.7 Generating version 5 UUIDs
----------------------------------

Version 5 UUIDs are namespace-name based UUIDs using the SHA-1 hash
function.  This predicate is only available on Prolog backends with
support for unbounded integer arithmetic.  For example:

     | ?- uuid::uuid_v5('6ba7b810-9dad-11d1-80b4-00c04fd430c8', 'www.widgets.com', UUID).
     UUID = '21f7f8de-8051-5b89-8680-0195ef798b6a'
     yes

To generate a UUID using a list of characters representation, use
instead the ‘uuid/1’ parametric object:

     | ?- uuid(chars)::uuid_v5('6ba7b810-9dad-11d1-80b4-00c04fd430c8', 'www.widgets.com', UUID).
     UUID = ['2','1',f,'7',f,'8',d,e,-,'8','0','5','1',-,'5',b,'8','9',-,
             '8','6','8','0',-,'0','1','9','5',e,f,'7','9','8',b,'6',a]
     yes

Similarly, to get a UUID using a list of character codes representation:

     | ?- uuid(codes)::uuid_v5('6ba7b810-9dad-11d1-80b4-00c04fd430c8', 'www.widgets.com', UUID).
     UUID = [50,49,102,55,102,56,100,101,45,56,48,53,49,45,53,98,56,57,45,
             56,54,56,48,45,48,49,57,53,101,102,55,57,56,98,54,97]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating version 7 UUIDs,  Next: Generating the Nil and Max UUIDs,  Prev: Generating version 5 UUIDs,  Up: uuid

6.212.8 Generating version 7 UUIDs
----------------------------------

Version 7 UUIDs are time-ordered using the Unix Epoch timestamp in
milliseconds (as specified in RFC 9562).  By default, version 7 UUIDs
are generated as atoms.  For example:

     | ?- uuid::uuid_v7(UUID).
     UUID = '018d5f3c-9b5a-7c4e-8f2a-1b3c4d5e6f70'
     yes

To generate a UUID using a list of characters representation, use
instead the ‘uuid/1’ parametric object:

     | ?- uuid(chars)::uuid_v7(UUID).
     UUID = ['0','1','8',d,'5',f,'3',c,-,'9',b,'5',a,-,'7',c,'4',e,-,
             '8',f,'2',a,-,'1',b,'3',c,'4',d,'5',e,'6',f,'7','0']
     yes

Similar to get a UUID using a list of character codes representation:

     | ?- uuid(codes)::uuid_v7(UUID).
     UUID = [48,49,56,100,53,102,51,99,45,57,98,53,97,45,55,99,52,101,45,
             56,102,50,97,45,49,98,51,99,52,100,53,101,54,102,55,48]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating the Nil and Max UUIDs,  Prev: Generating version 7 UUIDs,  Up: uuid

6.212.9 Generating the Nil and Max UUIDs
----------------------------------------

Predicates are also provided that return the Nil and Max UUIDs:

     | ?- uuid::uuid_nil(UUID).
     UUID = '00000000-0000-0000-0000-000000000000'
     yes

     | ?- uuid::uuid_max(UUID).
     UUID = 'FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF'
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: validations,  Next: wkt_wkb,  Prev: uuid,  Up: Libraries

6.213 ‘validations’
===================

This library provides an implementation of 'validation terms' with an
API for applicative-style error accumulation.  A validation term is an
opaque compound term that either contains a valid value (‘valid(Value)’)
or a list of errors (‘invalid(Errors)’).

The library follows the same design pattern as the ‘optionals’ and
‘expecteds’ libraries:

   - ‘validation’ — factory object for constructing validation terms

   - ‘validation/1’ — parametric object wrapping a validation term

   - ‘validated’ — companion helper object for list operations,
     type-checking, and QuickCheck support

The naming follows the convention used in Scala Cats and Kotlin Arrow,
where the companion type is called ‘Validated’.

* Menu:

* API documentation: API documentation<226>.
* Loading: Loading<228>.
* Testing: Testing<219>.
* Usage: Usage<107>.
* Comparison with the expecteds library::
* See also: See also<7>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<226>,  Next: Loading<228>,  Up: validations

6.213.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#validations’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<228>,  Next: Testing<219>,  Prev: API documentation<226>,  Up: validations

6.213.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(validations(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<219>,  Next: Usage<107>,  Prev: Loading<228>,  Up: validations

6.213.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(validations(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Usage<107>,  Next: Comparison with the expecteds library,  Prev: Testing<219>,  Up: validations

6.213.4 Usage
-------------

The ‘validation’ object provides constructors for validation terms.  For
example:

     | ?- validation::of_valid(1, Validation).
     ...

The created validation terms can then be passed as parameters to the
‘validation/1’ parametric object.  For example:

     | ?- validation::of_valid(1, V1), validation::of_valid(2, V2),
          validation::sequence([V1, V2], Validation).
     Validation = valid([1,2])
     yes

     | ?- validation::of_invalid(e1, V1), validation::of_invalid(e2, V2),
          validation::sequence([V1, V2], Validation).
     Validation = invalid([e1,e2])
     yes

     | ?- validation(valid(1))::flat_map([X,V]>>(Y is X+1, V = valid(Y)), Validation).
     Validation = valid(2)
     yes

Validation terms can be constructed from goals, optionals, and
expecteds:

     | ?- validation::from_goal(succ(1, Value), Value, Validation).
     Validation = valid(2)
     yes

     | ?- validation::from_optional(empty, no_value, Validation).
     Validation = invalid([no_value])
     yes

     | ?- validation::from_expected(unexpected(e), Validation).
     Validation = invalid([e])
     yes

Validation terms can be converted to optionals and expecteds:

     | ?- validation(valid(42))::to_optional(Optional).
     Optional = optional(42)
     yes

     | ?- validation(invalid([e1,e2]))::to_expected(Expected).
     Expected = unexpected([e1,e2])
     yes

The key feature of validation is error accumulation via ‘zip/3’:

     | ?- validation::of_valid(1, V1), validation::of_invalid(e1, V2),
          validation(V1)::zip([_,_,_]>>true, V2, Result).
     Result = invalid([e1])
     yes

     | ?- validation::of_invalid(e1, V1), validation::of_invalid(e2, V2),
          validation(V1)::zip([_,_,_]>>true, V2, Result).
     Result = invalid([e1,e2])
     yes

The companion ‘validated’ object provides predicates for handling lists
of validation terms, including ‘valids/2’, ‘invalids/2’, ‘partition/3’,
and ‘map/3-4’.

     | ?- validation::of_valid(1, V1), validation::of_invalids([e1,e2], V2), validation::of_valid(2, V3),
          validated::partition([V1, V2, V3], Values, Errors).
     Values = [1,2],
     Errors = [e1,e2]
     yes

     | ?- validated::map([Term,Validation]>>(
            integer(Term) -> validation::of_valid(Term, Validation)
          ; validation::of_invalid(not_integer(Term), Validation)
          ), [1,a,2,b], ValuesErrors).
     ValuesErrors = [1,2]-[not_integer(a),not_integer(b)]
     yes

     | ?- validated::map([Term,Validation]>>(
            integer(Term) -> validation::of_valid(Term, Validation)
          ; validation::of_invalid(not_integer(Term), Validation)
          ), [1,a,2,b], Values, Errors).
     Values = [1,2],
     Errors = [not_integer(a),not_integer(b)]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Comparison with the expecteds library,  Next: See also<7>,  Prev: Usage<107>,  Up: validations

6.213.5 Comparison with the ‘expecteds’ library
-----------------------------------------------

Both this library and the ‘expecteds’ library wrap computations that may
succeed or fail.  The fundamental difference is the 'error model':

   - ‘expecteds’ carries a 'single' error and 'short-circuits' on the
     first failure (monadic error handling).  Once an unexpected term is
     produced, subsequent operations are skipped.

   - ‘validations’ carries a 'list' of errors and 'accumulates all
     failures' (applicative error handling).  Operations such as
     ‘zip/3’, ‘sequence/2’, and ‘traverse/3’ collect every error.

Use ‘expecteds’ when you only care about the first error.  Use
‘validations’ when you want to 'report all problems at once' (e.g.  form
validation, configuration checking, or batch input processing).

* Menu:

* Example; form validation with error accumulation: Example form validation with error accumulation.


File: TheLogtalkHandbook-3.100.1.info,  Node: Example form validation with error accumulation,  Up: Comparison with the expecteds library

6.213.5.1 Example: form validation with error accumulation
..........................................................

Consider validating a form with a name (must be an atom) and an age
(must be a positive integer).  Each field is validated independently and
the results are combined with ‘validated::sequence/2’, which accumulates
all errors:

     | ?- Name = 123, Age = young,
          validation::from_goal(atom(Name), Name, invalid_name, V1),
          validation::from_goal((integer(Age), Age > 0), Age, invalid_age, V2),
          validated::sequence([V1, V2], Result),
          validation(Result)::or_else_throw(_).
     uncaught exception: [invalid_name,invalid_age]

Both errors are reported.  When all fields are valid, ‘or_else_throw/1’
returns the list of valid values:

     | ?- Name = john, Age = 25,
          validation::from_goal(atom(Name), Name, invalid_name, V1),
          validation::from_goal((integer(Age), Age > 0), Age, invalid_age, V2),
          validated::sequence([V1, V2], Result),
          validation(Result)::or_else_throw(Values).
     Values = [john,25]
     yes

Compare with the ‘expecteds’ library, where ‘either::sequence/2’
short-circuits at the first failure:

     | ?- Name = 123, Age = young,
          expected::from_goal(atom(Name), Name, invalid_name, E1),
          expected::from_goal((integer(Age), Age > 0), Age, invalid_age, E2),
          either::sequence([E1, E2], Result),
          expected(Result)::or_else_throw(_).
     uncaught exception: invalid_name

Only ‘invalid_name’ is reported — ‘either::sequence/2’ stops at the
first unexpected term.

The two libraries are complementary.  Use ‘expecteds’ for sequential
pipelines where only the first error matters.  Use ‘validations’ with
‘sequence/2’, ‘traverse/3’, or ‘zip/3’ for independent validations where
all errors should be collected.


File: TheLogtalkHandbook-3.100.1.info,  Node: See also<7>,  Prev: Comparison with the expecteds library,  Up: validations

6.213.6 See also
----------------

The ‘expecteds’ and ‘optionals’ libraries.


File: TheLogtalkHandbook-3.100.1.info,  Node: wkt_wkb,  Next: yaml,  Prev: validations,  Up: Libraries

6.214 ‘wkt_wkb’
===============

The ‘wkt_wkb’ library provides predicates for parsing, generating, and
validating geometries represented using the Well-Known Text (WKT) and
Well-Known Binary (WKB) interchange formats.

It complements the ‘geojson’ and ‘geospatial’ libraries by reusing the
same geometry constructors while adding support for the standard text
and binary geometry encodings widely used by spatial databases and GIS
tooling.

* Menu:

* API documentation: API documentation<227>.
* Loading: Loading<229>.
* Testing: Testing<220>.
* Representation: Representation<21>.
* Sources and sinks::
* Examples: Examples<179>.
* Notes: Notes<13>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<227>,  Next: Loading<229>,  Up: wkt_wkb

6.214.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#wkt_wkb’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<229>,  Next: Testing<220>,  Prev: API documentation<227>,  Up: wkt_wkb

6.214.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(wkt_wkb(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<220>,  Next: Representation<21>,  Prev: Loading<229>,  Up: wkt_wkb

6.214.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(wkt_wkb(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Representation<21>,  Next: Sources and sinks,  Prev: Testing<220>,  Up: wkt_wkb

6.214.4 Representation
----------------------

The library uses the same native geometry constructors as the ‘geojson’
library for geometry values:

   - ‘point(Position)’ or ‘point(Position, Options)’

   - ‘multi_point(Positions)’ or ‘multi_point(Positions, Options)’

   - ‘line_string(Positions)’ or ‘line_string(Positions, Options)’

   - ‘multi_line_string(LineStrings)’ or ‘multi_line_string(LineStrings,
     Options)’

   - ‘polygon(Rings)’ or ‘polygon(Rings, Options)’

   - ‘multi_polygon(Polygons)’ or ‘multi_polygon(Polygons, Options)’

   - ‘geometry_collection(Geometries)’ or
     ‘geometry_collection(Geometries, Options)’

Positions are represented as lists of numeric coordinates.  Empty
geometries use empty lists, e.g.  ‘point([])’ or ‘polygon([])’.

The optional ‘Options’ lists currently support:

   - ‘dimensions(xy)’

   - ‘dimensions(z)’

   - ‘dimensions(m)’

   - ‘dimensions(zm)’

The ‘dimensions/1’ option is mainly required to distinguish ‘Z’ and ‘M’
three-coordinate geometries and to preserve dimensionality for empty
geometries.  When the option is omitted, dimensionality is inferred from
the coordinates and defaults to ‘xy’ for empty geometries.


File: TheLogtalkHandbook-3.100.1.info,  Node: Sources and sinks,  Next: Examples<179>,  Prev: Representation<21>,  Up: wkt_wkb

6.214.5 Sources and sinks
-------------------------

WKT sources and sinks are wrapped as ‘wkt(...)’ terms:

   - ‘wkt(file(Path))’

   - ‘wkt(stream(Stream))’

   - ‘wkt(atom(Atom))’

   - ‘wkt(chars(List))’

   - ‘wkt(codes(List))’

WKB sources and sinks are wrapped as ‘wkb(...)’ terms:

   - ‘wkb(file(Path))’

   - ‘wkb(stream(Stream))’

   - ‘wkb(bytes(List))’

   - ‘wkb(hex(atom(Atom)))’

   - ‘wkb(hex(chars(List)))’

   - ‘wkb(hex(codes(List)))’

When generating WKB, byte order defaults to little-endian.  A specific
byte order can be selected using ‘wkb(Sink, little)’ or ‘wkb(Sink,
big)’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<179>,  Next: Notes<13>,  Prev: Sources and sinks,  Up: wkt_wkb

6.214.6 Examples
----------------

Parse a WKT point:

     | ?- wkt_wkb::parse(wkt(atom('POINT Z (1 2 3)')), Geometry).
     Geometry = point([1, 2, 3], [dimensions(z)])
     yes

Generate canonical WKT for a polygon:

     | ?- wkt_wkb::generate(wkt(atom(WKT)), polygon([[[0,0],[1,0],[1,1],[0,1],[0,0]]])).
     WKT = 'POLYGON ((0 0, 1 0, 1 1, 0 1, 0 0))'
     yes

Generate WKB hex for a point:

     | ?- wkt_wkb::generate(wkb(hex(atom(Hex))), point([1, 2])).
     Hex = '0101000000000000000000f03f0000000000000040'
     yes

Round-trip through a big-endian WKB byte sequence:

     | ?- wkt_wkb::generate(wkb(bytes(Bytes), big), line_string([[0,0],[1,1]])),
          wkt_wkb::parse(wkb(bytes(Bytes)), Geometry).

Validate a geometry term:

     | ?- wkt_wkb::validate(multi_point([[], [1, 2], [3, 4]])).
     yes

     | ?- wkt_wkb::validate(polygon([[[0,0],[1,0],[1,1],[0,1]]]), Errors).
     Errors = [ring_not_closed([coordinates,0])]
     yes


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<13>,  Prev: Examples<179>,  Up: wkt_wkb

6.214.7 Notes
-------------

   - WKT parsing accepts the standard geometry keywords ‘POINT’,
     ‘LINESTRING’, ‘POLYGON’, ‘MULTIPOINT’, ‘MULTILINESTRING’,
     ‘MULTIPOLYGON’, and ‘GEOMETRYCOLLECTION’, together with the ‘Z’,
     ‘M’, and ‘ZM’ dimension tags.

   - Canonical WKT generation always uses uppercase geometry keywords.

   - WKB generation uses the ISO/OGC type-code offsets ‘1000’, ‘2000’,
     and ‘3000’ for ‘Z’, ‘M’, and ‘ZM’ dimensionality.

   - Empty WKB points are encoded using quiet NaN ordinates as required
     by the format, while empty non-point geometries are encoded using
     zero counts.

   - Geometry validation checks coordinate dimensionality consistency,
     minimum cardinalities for line strings and rings, and polygon ring
     closure.


File: TheLogtalkHandbook-3.100.1.info,  Node: yaml,  Next: z_score_anomaly_detector,  Prev: wkt_wkb,  Up: Libraries

6.215 ‘yaml’
============

The ‘yaml’ library provides predicates for parsing and generating data
in the YAML format:

‘https://yaml.org’

It includes parsing and generation of simple scalar values, lists,
mappings, and nested structures.

* Menu:

* API documentation: API documentation<228>.
* Loading: Loading<230>.
* Testing: Testing<221>.
* API::
* Data Representation: Data Representation<2>.
* Examples: Examples<180>.
* Features: Features<80>.
* Supported YAML Features::
* Limitations: Limitations<6>.
* Error Handling: Error Handling<4>.
* File Organization::
* Test Files::
* Performance Considerations: Performance Considerations<2>.
* Integration with Other Libraries::
* Future Enhancements::
* See Also::


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<228>,  Next: Loading<230>,  Up: yaml

6.215.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#yaml’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<230>,  Next: Testing<221>,  Prev: API documentation<228>,  Up: yaml

6.215.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(yaml(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<221>,  Next: API,  Prev: Loading<230>,  Up: yaml

6.215.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(yaml(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: API,  Next: Data Representation<2>,  Prev: Testing<221>,  Up: yaml

6.215.4 API
-----------

* Menu:

* Parsing: Parsing<3>.
* Generating: Generating<3>.
* Multi-Document Parsing::
* Multi-Document Generation::


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing<3>,  Next: Generating<3>,  Up: API

6.215.4.1 Parsing
.................

The ‘parse/2’ predicate parses YAML content from various sources into a
structured Logtalk term representation.

     parse(+Source, -YAML)

Sources can be:

   - ‘file(Path)’ - parse YAML from a file

   - ‘stream(Stream)’ - parse YAML from an open stream

   - ‘codes(Codes)’ - parse YAML from a list of character codes

   - ‘chars(Chars)’ - parse YAML from a list of characters

   - ‘atom(Atom)’ - parse YAML from an atom

The parsed YAML is returned as a compound term with the functor
‘yaml/1’.


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating<3>,  Next: Multi-Document Parsing,  Prev: Parsing<3>,  Up: API

6.215.4.2 Generating
....................

The ‘generate/2’ predicate generates YAML output from a structured term.

     generate(+Sink, +YAML)

Sinks can be:

   - ‘file(Path)’ - write YAML to a file

   - ‘stream(Stream)’ - write YAML to an open stream

   - ‘codes(Codes)’ - get YAML as a list of character codes

   - ‘chars(Chars)’ - get YAML as a list of characters

   - ‘atom(Atom)’ - get YAML as an atom

The input must be a compound term representing YAML data (e.g.,
‘yaml([...])’ for mappings, ‘[...]’ for sequences).


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-Document Parsing,  Next: Multi-Document Generation,  Prev: Generating<3>,  Up: API

6.215.4.3 Multi-Document Parsing
................................

The ‘parse_all/2’ predicate parses all YAML documents from a source into
a list.

     parse_all(+Source, -YAMLs)

Documents are separated by ‘---’ markers and optionally terminated by
‘...’ markers.  Returns a list of YAML terms, even for single-document
sources.


File: TheLogtalkHandbook-3.100.1.info,  Node: Multi-Document Generation,  Prev: Multi-Document Parsing,  Up: API

6.215.4.4 Multi-Document Generation
...................................

The ‘generate_all/2’ predicate generates YAML output with multiple
documents.

     generate_all(+Sink, +YAMLs)

Takes a list of YAML terms and generates output with ‘---’ separators
between documents.  For a single document, no separator is added.


File: TheLogtalkHandbook-3.100.1.info,  Node: Data Representation<2>,  Next: Examples<180>,  Prev: API,  Up: yaml

6.215.5 Data Representation
---------------------------

YAML data is represented using the following mappings:

YAML Value          Logtalk Representation
                    
---------------------------------------------------
‘null’              ‘'@'(null)’
                    
‘true’              ‘'@'(true)’
                    
‘false’             ‘'@'(false)’
                    
Number (42)         ‘42’
                    
String (“text”)     ‘text’ (as atom)
                    
Array/List          ‘[item1, item2, ...]’
                    
Mapping/Object      ‘yaml([key1-val1, ...])’
                    


File: TheLogtalkHandbook-3.100.1.info,  Node: Examples<180>,  Next: Features<80>,  Prev: Data Representation<2>,  Up: yaml

6.215.6 Examples
----------------

* Menu:

* Parsing a Simple YAML String::
* Parsing a YAML List::
* Parsing a YAML File::
* Generating YAML from a Term::
* Generating YAML to a File::
* Working with Nested Structures::


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing a Simple YAML String,  Next: Parsing a YAML List,  Up: Examples<180>

6.215.6.1 Parsing a Simple YAML String
......................................

     ?- parse(atom('name: John\nage: 30'), YAML).
     YAML = yaml([name-'John', age-30]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing a YAML List,  Next: Parsing a YAML File,  Prev: Parsing a Simple YAML String,  Up: Examples<180>

6.215.6.2 Parsing a YAML List
.............................

     ?- parse(codes([0'-, 0' , 0'a, ...]), YAML).
     YAML = yaml([apple, banana, orange]).


File: TheLogtalkHandbook-3.100.1.info,  Node: Parsing a YAML File,  Next: Generating YAML from a Term,  Prev: Parsing a YAML List,  Up: Examples<180>

6.215.6.3 Parsing a YAML File
.............................

     ?- parse(file('config.yaml'), YAML).
     % Reads and parses config.yaml


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating YAML from a Term,  Next: Generating YAML to a File,  Prev: Parsing a YAML File,  Up: Examples<180>

6.215.6.4 Generating YAML from a Term
.....................................

     ?- generate(atom(Result), yaml([title-'Project', version-1])).
     Result = '{title:Project,version:1}'.


File: TheLogtalkHandbook-3.100.1.info,  Node: Generating YAML to a File,  Next: Working with Nested Structures,  Prev: Generating YAML from a Term,  Up: Examples<180>

6.215.6.5 Generating YAML to a File
...................................

     ?- Data = yaml([name-'Alice', score-95]),
        generate(file('output.yaml'), Data).
     % Writes YAML data to output.yaml


File: TheLogtalkHandbook-3.100.1.info,  Node: Working with Nested Structures,  Prev: Generating YAML to a File,  Up: Examples<180>

6.215.6.6 Working with Nested Structures
........................................

     ?- YAML = yaml([
          person-yaml([
            name-'Bob',
            age-25,
            skills-[logtalk, prolog, python]
          ])
        ]),
        generate(atom(Result), YAML).
     % Generates YAML representation of nested structure


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<80>,  Next: Supported YAML Features,  Prev: Examples<180>,  Up: yaml

6.215.7 Features
----------------

   - 'Scalar values': Supports atoms, numbers, booleans, and null

   - 'Collections': Supports lists (sequences) and mappings (objects)

   - 'Nested structures': Fully supports nested mappings and sequences

   - 'Comments': Handles YAML comments (lines starting with #)

   - 'Multiple source formats': Parse from files, streams, codes, chars,
     or atoms

   - 'Multiple output formats': Generate to files, streams, codes,
     chars, or atoms

   - 'Error handling': Provides appropriate error messages for invalid
     input


File: TheLogtalkHandbook-3.100.1.info,  Node: Supported YAML Features,  Next: Limitations<6>,  Prev: Features<80>,  Up: yaml

6.215.8 Supported YAML Features
-------------------------------

The library currently supports a subset of YAML 1.2 features suitable
for common configuration and data serialization tasks:

'Scalars'

   - Strings: unquoted, single-quoted (‘'...'’), and double-quoted
     (‘"..."’)

   - Multi-line flow scalars: quoted strings spanning multiple lines
     with proper line folding

        - Single newline becomes a space

        - Blank lines (consecutive newlines) become literal newlines

        - Leading/trailing whitespace around newlines is trimmed

   - Multi-word keys: keys containing spaces (e.g., ‘Mark McGwire: 65’)

   - Numbers:

        - Integers: decimal (‘42’), signed positive (‘+12345’), octal
          (‘0o14’), hexadecimal (‘0xC’)

        - Floats: decimal (‘3.14’), scientific notation (‘1.23e+3’)

        - Special values: ‘.inf’, ‘-.inf’, ‘.nan’ (represented as
          ‘'@'(inf)’, ‘'@'(-inf)’, ‘'@'(nan)’)

   - Booleans: ‘true’ and ‘false’

   - Null: ‘null’ or empty values

   - Timestamps: ISO 8601 dates and times (parsed as strings)

'Collections'

   - Block sequences: using ‘-’ indicator with proper indentation

   - Flow sequences: using ‘[ ]’ syntax with comma separation

   - Block mappings: using ‘key: value’ syntax with proper indentation

   - Flow mappings: using ‘{ key: value }’ syntax

   - Nested structures: arbitrary nesting of sequences and mappings

   - Trailing commas: supported in flow collections

'Block Scalars'

   - Literal block scalars: ‘|’ style preserves newlines exactly

   - Folded block scalars: ‘>’ style folds newlines into spaces

   - Chomping indicators: ‘-’ (strip), ‘+’ (keep), default (clip) for
     trailing newlines

   - More-indented lines: preserved with original indentation in folded
     scalars

   - Blank lines: preserved in both literal and folded block scalars

'Anchors and Aliases'

   - Anchor definitions: ‘&name’ to define a reusable node

   - Alias references: ‘*name’ to reference a previously defined anchor

   - Merge key: ‘<<’ to merge mappings from aliases

   - Works with scalars, sequences, and mappings

'Document Structure'

   - Document start marker: ‘---’ is recognized and skipped

   - Document end marker: ‘...’ is recognized and handled

   - Multi-document streams: multiple ‘---’ or ‘...’ separated documents
     (via ‘parse_all/2’)

   - Comments: lines starting with ‘#’ and inline comments after values

   - Tags: ‘!tag’, ‘!!type’, and ‘!<uri>’ tags are recognized and
     skipped

'Escape Sequences' (in double-quoted strings)

   - ‘\\’ - backslash

   - ‘\"’ - double quote

   - ‘\/’ - forward slash

   - ‘\n’ - newline

   - ‘\t’ - tab

   - ‘\r’ - carriage return

   - ‘\b’ - backspace

   - ‘\f’ - form feed

   - ‘\0’ - null character

   - ‘\xXX’ - hex escape (2 hex digits)

   - ‘\uXXXX’ - Unicode escape (4 hex digits)


File: TheLogtalkHandbook-3.100.1.info,  Node: Limitations<6>,  Next: Error Handling<4>,  Prev: Supported YAML Features,  Up: yaml

6.215.9 Limitations
-------------------

The following YAML features are 'not' currently supported:

   - Tag interpretation: Tags are recognized and skipped, but not
     interpreted

   - Complex keys: ‘?’ indicator for multi-line or complex keys

   - Multi-line plain scalars: plain scalars spanning multiple lines

   - Aliases in flow sequences: ‘[*alias1, *alias2]’ (aliases work in
     block context)

   - Merge with list of aliases: ‘<<: [*a, *b]’ (single alias merge
     works)

   - Directives: ‘%YAML’ and ‘%TAG’ directives


File: TheLogtalkHandbook-3.100.1.info,  Node: Error Handling<4>,  Next: File Organization,  Prev: Limitations<6>,  Up: yaml

6.215.10 Error Handling
-----------------------

The library raises the following errors:

   - ‘instantiation_error’ - when a required argument is a variable

   - ‘domain_error(yaml_source, Source)’ - when an invalid source is
     provided

   - ‘domain_error(yaml_sink, Sink)’ - when an invalid sink is provided

   - ‘domain_error(yaml_term, Term)’ - when an invalid YAML term is
     provided


File: TheLogtalkHandbook-3.100.1.info,  Node: File Organization,  Next: Test Files,  Prev: Error Handling<4>,  Up: yaml

6.215.11 File Organization
--------------------------

   - ‘yaml_protocol.lgt’ - Defines the protocol for YAML
     parser/generator

   - ‘yaml.lgt’ - Main implementation object

   - ‘loader.lgt’ - Library loader

   - ‘tester.lgt’ - Test runner

   - ‘test_files/’ - Directory containing test files and sample YAML
     files for testing


File: TheLogtalkHandbook-3.100.1.info,  Node: Test Files,  Next: Performance Considerations<2>,  Prev: File Organization,  Up: yaml

6.215.12 Test Files
-------------------

The library includes several sample YAML files for testing:

   - ‘simple.yaml’ - Simple key-value pairs

   - ‘list.yaml’ - A YAML list

   - ‘nested.yaml’ - Nested structures

   - ‘complex.yaml’ - Lists of mappings

   - ‘config.yaml’ - Configuration file example

   - ‘metadata.yaml’ - Metadata example with quoted strings


File: TheLogtalkHandbook-3.100.1.info,  Node: Performance Considerations<2>,  Next: Integration with Other Libraries,  Prev: Test Files,  Up: yaml

6.215.13 Performance Considerations
-----------------------------------

   - Parsing is done recursively, which may affect performance with
     deeply nested structures

   - Large YAML files are processed in memory

   - For very large files, consider splitting them into smaller chunks


File: TheLogtalkHandbook-3.100.1.info,  Node: Integration with Other Libraries,  Next: Future Enhancements,  Prev: Performance Considerations<2>,  Up: yaml

6.215.14 Integration with Other Libraries
-----------------------------------------

The YAML library can be integrated with other Logtalk libraries:

   - Use with ‘os’ library for file path handling

   - Use with ‘reader’ library for stream management

   - Compatible with ‘term_io’ library for term serialization


File: TheLogtalkHandbook-3.100.1.info,  Node: Future Enhancements,  Next: See Also,  Prev: Integration with Other Libraries,  Up: yaml

6.215.15 Future Enhancements
----------------------------

Potential future enhancements may include:

   - Support for tag interpretation (e.g., ‘!!binary’ for base64
     decoding)

   - Support for complex keys using ‘?’ indicator

   - Support for multi-line plain scalars

   - Aliases in flow sequences

   - Merge key with list of aliases

   - Parametric objects for custom representation choices


File: TheLogtalkHandbook-3.100.1.info,  Node: See Also,  Prev: Future Enhancements,  Up: yaml

6.215.16 See Also
-----------------

   - ‘json_lines’ library for JSON Lines format parsing and generation

   - Logtalk documentation on DCGs for grammar rules

   - YAML specification: ‘https://yaml.org’


File: TheLogtalkHandbook-3.100.1.info,  Node: z_score_anomaly_detector,  Next: zippers,  Prev: yaml,  Up: Libraries

6.216 ‘z_score_anomaly_detector’
================================

Statistical Z-score anomaly detector for continuous datasets.  It is a
statistical anomaly-detection method based on standard scores: the
detector estimates a population mean and standard deviation for each
continuous attribute and supports two learn-time score modes,
‘root_mean_square’ for dense multivariate deviation scores and
‘any_feature_extreme’ for the maximum absolute Z-score when sparse
single-feature anomalies are more informative.

The library implements the ‘anomaly_detector_protocol’ defined in the
‘anomaly_detection_protocols’ library.  It learns a detector from a
continuous dataset, computes anomaly scores for new instances, predicts
‘normal’ or ‘anomaly’, and exports learned detectors as clauses or
files.

Datasets are represented as objects implementing the
‘anomaly_dataset_protocol’ protocol from the
‘anomaly_detection_protocols’ library.  See the
‘anomaly_detection_protocols/test_datasets’ directory for examples.

* Menu:

* API documentation: API documentation<229>.
* Loading: Loading<231>.
* Testing: Testing<222>.
* Features: Features<81>.
* Options: Options<74>.
* Detector representation: Detector representation<8>.
* Notes: Notes<14>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<229>,  Next: Loading<231>,  Up: z_score_anomaly_detector

6.216.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#z-score’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<231>,  Next: Testing<222>,  Prev: API documentation<229>,  Up: z_score_anomaly_detector

6.216.2 Loading
---------------

To load this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(z_score_anomaly_detector(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<222>,  Next: Features<81>,  Prev: Loading<231>,  Up: z_score_anomaly_detector

6.216.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(z_score_anomaly_detector(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Features<81>,  Next: Options<74>,  Prev: Testing<222>,  Up: z_score_anomaly_detector

6.216.4 Features
----------------

   - 'Statistical method': implements anomaly detection based on
     standard scores, using the population mean and standard deviation
     of each continuous attribute to measure how far new observations
     deviate from the training data distribution.

   - 'Classical per-attribute Z-score': for each known attribute value
     ‘x’, the library computes the standard score ‘z = (x - mu) /
     sigma’, where ‘mu’ is the learned population mean for that
     attribute and ‘sigma’ is the learned population standard deviation.

   - 'Continuous features only': accepts datasets whose declared
     attributes are all ‘continuous’.

   - 'Population statistics': reuses the ‘statistics’ library
     ‘population’ object to compute per-attribute arithmetic means and
     standard deviations.

   - 'Baseline training selection': supports learn-time
     ‘baseline_class_values(ClassValues)’ and
     ‘baseline_selection_policy(Policy)’ options.  The default baseline
     class values are ‘[normal]’.  The default ‘reject’ policy throws an
     error if non-baseline examples are present, while ‘filter’ removes
     them before fitting.

   - 'Missing-value tolerant': ignores missing values when fitting
     attribute statistics.  During scoring, queries must provide at
     least one known value.  In the default
     ‘score_mode(root_mean_square)’, the raw score is normalized by the
     number of known values so that scores remain comparable across
     different missing-value patterns.

   - 'Configurable scoring semantics': supports both dense multivariate
     deviation scoring using ‘score_mode(root_mean_square)’ and sparse
     anomaly detection using ‘score_mode(any_feature_extreme)’.  The
     default root-mean-square mode reuses the ‘numberlist’ library
     Euclidean norm predicate as part of the computation.  The
     ‘score_mode/1’ option only controls how the per-attribute Z-scores
     are aggregated into a single raw anomaly score.

   - 'Bounded scoring': maps the raw multivariate Z-score to ‘[0.0,
     1.0)’ using ‘Score = Raw / (1 + Raw)’.

   - 'Default threshold': the default ‘anomaly_threshold(0.70)’ provides
     a practical out-of-the-box cutoff for the built-in anomaly fixtures
     while remaining overrideable in ‘learn/3’ and ‘predict/4’.

   - 'Learn-time score mode': ‘score_mode/1’ is recorded in the learned
     detector and reused for subsequent scoring and prediction.  Passing
     a ‘score_mode/1’ option to ‘predict/4’ does not override the
     learned mode.

   - 'All-missing queries rejected': scoring and prediction throw a
     ‘domain_error(non_empty_known_values, AttributeNames)’ exception
     when every declared feature is missing in the query.

   - 'Featureless datasets rejected': datasets must declare at least one
     continuous feature; otherwise ‘learn/2-3’ throws a
     ‘domain_error(non_empty_features, Dataset)’ exception.

   - 'Detector export': learned detectors can be exported as predicate
     clauses.

   - 'Explicit validation and diagnostics': supports the shared
     ‘check_anomaly_detector/1’, ‘valid_anomaly_detector/1’,
     ‘diagnostics/2’, ‘diagnostic/2’, and ‘anomaly_detector_options/2’
     predicates.


File: TheLogtalkHandbook-3.100.1.info,  Node: Options<74>,  Next: Detector representation<8>,  Prev: Features<81>,  Up: z_score_anomaly_detector

6.216.5 Options
---------------

The following options are supported by the public API:

   - ‘anomaly_threshold(Threshold)’: Threshold for ‘predict/3-4’
     (default: ‘0.70’)

   - ‘baseline_class_values(ClassValues)’: Learn-time class labels that
     are admissible for baseline fitting (default: ‘[normal]’)

   - ‘baseline_selection_policy(Policy)’: Learn-time handling of
     examples whose class is not listed in ‘baseline_class_values/1’.
     Supported values are ‘filter’ and ‘reject’ (default: ‘reject’)

   - ‘score_mode(Mode)’: Learn-time score aggregation mode for
     ‘learn/3’.  Supported values are ‘root_mean_square’ and
     ‘any_feature_extreme’ (default: ‘root_mean_square’).  If passed to
     ‘predict/4’, it is ignored and the value stored in the learned
     detector is used.


File: TheLogtalkHandbook-3.100.1.info,  Node: Detector representation<8>,  Next: Notes<14>,  Prev: Options<74>,  Up: z_score_anomaly_detector

6.216.6 Detector representation
-------------------------------

The learned detector is represented by default as:

     z_score_detector(TrainingDataset, Encoders, Diagnostics)

Where:

   - ‘TrainingDataset’: training dataset object identifier

   - ‘Encoders’: list of ‘zscore(Attribute, Mean, Scale)’ records

   - ‘Diagnostics’: learned metadata terms including ‘model/1’,
     ‘training_dataset/1’, ‘attribute_names/1’, ‘feature_count/1’,
     ‘example_count/1’, and ‘options/1’

When exported using ‘export_to_clauses/4’ or ‘export_to_file/4’, this
detector term is serialized directly as the single argument of the
generated predicate clause so that the exported model can be loaded and
reused as-is.


File: TheLogtalkHandbook-3.100.1.info,  Node: Notes<14>,  Prev: Detector representation<8>,  Up: z_score_anomaly_detector

6.216.7 Notes
-------------

Scoring has three stages.  First, the detector computes one classical
per-attribute Z-score for each known attribute value using ‘z = (x - mu)
/ sigma’.  Second, those per-attribute Z-scores are aggregated into a
single raw anomaly score according to the learned ‘score_mode/1’ option.
Third, the raw score is mapped to the interval ‘[0.0, 1.0)’ using ‘Score
= Raw / (1 + Raw)’.

With this normalization, a raw score of ‘3.0’ maps to ‘0.75’.

The ‘score_mode/1’ option does not change the classical per-attribute
formula.  It only changes the aggregation step.  With
‘score_mode(root_mean_square)’, the raw score is the root mean square of
the per-attribute Z-scores.  With ‘score_mode(any_feature_extreme)’, the
raw score is the maximum absolute per-attribute Z-score.

The ‘baseline_class_values/1’ option declares which dataset class labels
are admissible for fitting the baseline means and standard deviations.
The ‘baseline_selection_policy/1’ option then controls what happens when
other labels are present in the training data.  The default ‘reject’
policy raises a ‘domain_error(baseline_only_training_data, Dataset)’
exception when any non-baseline example is found.  The ‘filter’ policy
removes non-baseline examples before fitting.

Attributes with zero observed dispersion are assigned a fallback scale
of ‘1.0’.  This keeps the detector well-defined for singleton datasets
or constant columns while still yielding zero score for matching values
and positive scores for deviating values.

The root-mean-square aggregation keeps the default threshold stable as
the number of observed dimensions grows and avoids penalizing partially
observed queries solely for having fewer known attributes.

Use ‘score_mode(any_feature_extreme)’ when a single extreme feature
should be sufficient to flag an anomaly in high-dimensional data.


File: TheLogtalkHandbook-3.100.1.info,  Node: zippers,  Prev: z_score_anomaly_detector,  Up: Libraries

6.217 ‘zippers’
===============

This library implements zippers over lists.

* Menu:

* API documentation: API documentation<230>.
* Loading: Loading<232>.
* Testing: Testing<223>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<230>,  Next: Loading<232>,  Up: zippers

6.217.1 API documentation
-------------------------

Open the ‘../../apis/library_index.html#zippers’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<232>,  Next: Testing<223>,  Prev: API documentation<230>,  Up: zippers

6.217.2 Loading
---------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(zippers(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<223>,  Prev: Loading<232>,  Up: zippers

6.217.3 Testing
---------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(zippers(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Ports,  Next: Contributions,  Prev: Libraries,  Up: Top

7 Ports
*******

The documentation of each port can also be found in the port directory
in the ‘NOTES.md’ file.

* Menu:

* fcube::
* metagol::
* toychr::


File: TheLogtalkHandbook-3.100.1.info,  Node: fcube,  Next: metagol,  Up: Ports

7.1 ‘fcube’
===========

This folder contains a Logtalk port of FCube: An Efficient Prover for
Intuitionistic Propositional Logic available from:

     https://www.vidal-rosset.net/fCube/

The port includes portability changes (notably, operator names) plus
changes to use an ordered representation for sets.  Also some code
formatting changes for Logtalk coding guidelines.

The port tests are adapted from the examples available from the web page
above.

To load this port and for sample queries, please see the ‘SCRIPT.txt’
file.

For more information about FCube, see the following paper:

     @InProceedings{10.1007/978-3-642-16242-8_21,
         author="Ferrari, Mauro and Fiorentini, Camillo and Fiorino, Guido",
         editor="Ferm{\"u}ller, Christian G. and Voronkov, Andrei",
         title="fCube: An Efficient Prover for Intuitionistic Propositional Logic",
         booktitle="Logic for Programming, Artificial Intelligence, and Reasoning",
         year="2010",
         publisher="Springer Berlin Heidelberg",
         address="Berlin, Heidelberg",
         pages="294--301",
         isbn="978-3-642-16242-8"
     }

For sample queries, please see the ‘SCRIPT.txt’ file.

* Menu:

* API documentation: API documentation<231>.
* Loading: Loading<233>.
* Testing: Testing<224>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<231>,  Next: Loading<233>,  Up: fcube

7.1.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#fcube’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<233>,  Next: Testing<224>,  Prev: API documentation<231>,  Up: fcube

7.1.2 Loading
-------------

To load all entities in this port, load the ‘loader.lgt’ file:

     | ?- logtalk_load(fcube(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<224>,  Prev: Loading<233>,  Up: fcube

7.1.3 Testing
-------------

To test this port predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(fcube(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: metagol,  Next: toychr,  Prev: fcube,  Up: Ports

7.2 ‘metagol’
=============

This folder contains a Logtalk port of ‘metagol’, an inductive logic
programming (ILP) system based on meta-interpretive learning available
from:

     https://github.com/metagol/metagol

See the original code git repo for details and bibliography on Metagol
and ILP.

The port allows any number of datasets to be loaded simultaneously with
per-dataset learning options.  A dataset is simply wrapped in an object
that extends and is expanded by the ‘metagol’ object as illustrated by
the ported examples.

Both the original code and the port requires the coroutining ‘when/2’
predicate, which is only available in some backend Prolog systems.  The
port currently supports ECLiPSe, XVM, SICStus Prolog, SWI-Prolog, and
YAP. It can be used on both POSIX and Windows operating-systems.

The examples are ported from the original Metagol distribution.  Some of
the examples are taken from the following paper (with the original
Prolog examples source code files made available by MystikNinja):

     @article{DBLP:journals/jair/EvansG18,
         author    = {Richard Evans and Edward Grefenstette},
         title     = {Learning Explanatory Rules from Noisy Data},
         journal   = {J. Artif. Intell. Res.},
         volume    = {61},
         pages     = {1--64},
         year      = {2018},
         url       = {https://doi.org/10.1613/jair.5714},
         doi       = {10.1613/jair.5714},
         timestamp = {Mon, 21 Jan 2019 15:01:17 +0100},
         biburl    = {https://dblp.org/rec/bib/journals/jair/EvansG18},
         bibsource = {dblp computer science bibliography, https://dblp.org}
     }

The paper can be downloaded at

     https://arxiv.org/pdf/1711.04574.pdf

For sample queries, please see the ‘SCRIPT.txt’ file.

* Menu:

* API documentation: API documentation<232>.
* Loading: Loading<234>.
* Testing: Testing<225>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<232>,  Next: Loading<234>,  Up: metagol

7.2.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#metagol’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<234>,  Next: Testing<225>,  Prev: API documentation<232>,  Up: metagol

7.2.2 Loading
-------------

To load all entities in this port, load the ‘loader.lgt’ file:

     | ?- logtalk_load(metagol(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<225>,  Prev: Loading<234>,  Up: metagol

7.2.3 Testing
-------------

To test this port predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(metagol(tester)).

There are three lengthy tests that only run when the tests are being run
manually instead of automatically.


File: TheLogtalkHandbook-3.100.1.info,  Node: toychr,  Prev: metagol,  Up: Ports

7.3 ‘toychr’
============

This folder contains a Logtalk port of ToyCHR, a reference
implementation of Constraint Handling Rules (CHR) available from:

     https://www.comp.nus.edu.sg/~gregory/toychr/

The port is work in progress and includes significant modifications to
the original code:

   - Instead of compiling ‘.chr’ files, it uses the term-expansion
     mechanism, by defining ‘toychrdb’ as a hook object, to support
     writing rules inside objects and categories.  As a consequence, the
     original ‘chr_compile/1’ is not available.

   - The port is portable and should run on all supported backends.

The port also includes examples ported from the SWI-Prolog CHR package
examples and documentation.  These examples are ported using the same
license of the original code (BSD-2-Clause).

For sample queries, please see the ‘SCRIPT.txt’ file.

* Menu:

* API documentation: API documentation<233>.
* Loading: Loading<235>.
* Testing: Testing<226>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<233>,  Next: Loading<235>,  Up: toychr

7.3.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#toychr’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<235>,  Next: Testing<226>,  Prev: API documentation<233>,  Up: toychr

7.3.2 Loading
-------------

To load all entities in this port, load the ‘loader.lgt’ file:

     | ?- logtalk_load(toychr(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<226>,  Prev: Loading<235>,  Up: toychr

7.3.3 Testing
-------------

To test this port predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(toychr(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Contributions,  Next: Glossary,  Prev: Ports,  Up: Top

8 Contributions
***************

The documentation of contribution can also be found in the contribution
directory in the ‘NOTES.md’ file.

* Menu:

* flags::
* iso8601::
* pddl_parser::
* verdi_neruda::
* xml_parser::


File: TheLogtalkHandbook-3.100.1.info,  Node: flags,  Next: iso8601,  Up: Contributions

8.1 ‘flags’
===========

Flags was developed at Katholieke Universiteit Leuven

SPDX-FileCopyrightText: 2010 Katholieke Universiteit Leuven
SPDX-License-Identifier: Artistic-2.0

     Contributions to this file:
     Author: Theofrastos Mantadelis
     Suggestions: Paulo Moura
     Version: 1
     Date: 27/11/2010

* Menu:

* API documentation: API documentation<234>.
* Loading: Loading<236>.
* Testing: Testing<227>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<234>,  Next: Loading<236>,  Up: flags

8.1.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#flags’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<236>,  Next: Testing<227>,  Prev: API documentation<234>,  Up: flags

8.1.2 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

     ?- logtalk_load(flags(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<227>,  Prev: Loading<236>,  Up: flags

8.1.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(flags(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: iso8601,  Next: pddl_parser,  Prev: flags,  Up: Contributions

8.2 ‘iso8601’
=============

ISO 8601 (and European civil calendar) compliant library of date and
time (clock) related predicates.  That is, an ISO 8601 handler.

The library supports date and time-of-day representations plus ISO 8601
duration and interval string conversions using ‘time_string/3’,
‘date_time_string/3’, ‘duration_string/2’, and ‘interval_string/2’.

Supported 'time-of-day strings' include basic and extended forms with
the required ‘T’ prefix, e.g.  ‘T143000’, ‘T14:30:00’, ‘T143000.125’,
‘T14:30:00.125’, ‘T143000,125’, and ‘T14:30:00,125’.

Supported 'combined date-time strings' include calendar-date,
ordinal-date, and complete week-date basic and extended forms with
optional UTC ‘Z’ or numeric offsets, using either ‘.’ or ‘,’ as
fractional separator, e.g.  ‘20260407T143000’, ‘2026-04-07T14:30:00’,
‘2026097T143000Z’, ‘2026-097T14:30:00+05:45’, ‘2026W152T143000Z’,
‘2026-W15-2T14:30:00+05:45’, ‘20260407T143000.125+0545’, and
‘2026-04-07T14:30:00,125Z’.

Normalized term shapes are:

   - ‘time(Hours,Minutes,Seconds)’ for time-of-day strings

   - ‘date_time(Year,Month,Day,Hours,Minutes,Seconds)’ for local
     date-time strings

   - ‘date_time(Year,Month,Day,Hours,Minutes,Seconds,OffsetSeconds)’ for
     UTC or offset date-time strings, using an offset in seconds from
     UTC

An 'ISO 8601 duration string' represents a time amount (e.g.  ‘P3D’ for
three days or ‘P1Y2M3DT4H5M6S’ for a mixed date/time duration).

An 'ISO 8601 interval string' represents a time interval using two parts
separated by ‘/’, where each part can be a date, a date-time, or a
duration (e.g.  ‘2026-02-25/2026-03-01’,
‘2026-04-07T14:30:00Z/2026-04-07T15:00:00Z’,
‘2026-097T14:30:00Z/2026-097T15:00:00Z’, ‘2026-W15-2T14:30:00Z/PT30M’,
or ‘2026-02-25/P3D’).

Author: Daniel L. Dudley Created: 2004-02-18

     Modified: 2014-09-26 (to use the ‘os’ library object to get the current date)
     Modified: 2026-02-25 (to add ‘duration_string/2’ and ‘interval_string/2’ predicates) Modified: 2026-04-07 (to add ‘time_string/3’ and ‘date_time_string/3’ predicates and extend ‘interval_string/2’, including ordinal-date and week-date date-time forms) Modified: 2026-04-08 (to add support for comma as fractional separator in ‘time_string/3’ and ‘date_time_string/3’ and for corresponding interval parsing)

* Menu:

* API documentation: API documentation<235>.
* Loading: Loading<237>.
* Testing: Testing<228>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<235>,  Next: Loading<237>,  Up: iso8601

8.2.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#iso8601’ link in a web browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<237>,  Next: Testing<228>,  Prev: API documentation<235>,  Up: iso8601

8.2.2 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(iso8601(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<228>,  Prev: Loading<237>,  Up: iso8601

8.2.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(iso8601(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: pddl_parser,  Next: verdi_neruda,  Prev: iso8601,  Up: Contributions

8.3 ‘pddl_parser’
=================

     PDDL 3.0 parser
     Release 1.0

Copyright (c) 2011 Robert Sasak.  All Rights Reserved.  This is free
software.  You can redistribute it and/or modify it under the terms of
the “Artistic License 2.0” as published by The Perl Foundation.  Consult
the “LICENSE.txt” file for details.

This PDDL 3.0 file parser converts PDDL files to Logtalk/Prolog friendly
syntax.  For example:

     PDDL         Prolog
     (on ?x ?y)   on(?x, ?y)

Syntax sugar: op(200, fy, ?).

For whole example check the “pddl.lgt” file for usage and example
output.

* Menu:

* API documentation: API documentation<236>.
* Loading: Loading<238>.
* Testing: Testing<229>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<236>,  Next: Loading<238>,  Up: pddl_parser

8.3.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#pddl_parser’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<238>,  Next: Testing<229>,  Prev: API documentation<236>,  Up: pddl_parser

8.3.2 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

     ?- logtalk_load(pddl_parser(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<229>,  Prev: Loading<238>,  Up: pddl_parser

8.3.3 Testing
-------------

The provided unit tests are based on a collection of problem set files
from International Planning Competition 2008.  In order to run all unit
tests from the parser’s directory type:

     ?- logtalk_load(tester).

Or from any directory by typing:

     ?- logtalk_load(pddl_parser(tester)).

Some of the unit tests fail in some Prolog compilers due to limitations
to the maximum arity of a term.


File: TheLogtalkHandbook-3.100.1.info,  Node: verdi_neruda,  Next: xml_parser,  Prev: pddl_parser,  Up: Contributions

8.4 ‘verdi_neruda’
==================

     Verdi Neruda - Meta-interpreter collection for Prolog.
     Release 1.0

Copyright (c) 2010 Victor Lagerkvist.  All Rights Reserved.  Verdi
Neruda is free software.  You can redistribute it and/or modify it under
the terms of the simplified BSD license.

CONTENTS

  1. License

  2. About

  3. Verdi Neruda web site

  4. Installation and running

  5. Examples

  6. Authors

  7. LICENSE

Copyright 2010 Victor Lagerkvist.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

  1. Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the
     distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ‘’AS IS’’ AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation
are those of the authors and should not be interpreted as representing
official policies, either expressed or implied, of the copyright
holders.

  2. ABOUT

Verdi Neruda is a meta-interpreter collection for Prolog.  Or, to be
more precise, for a Prolog like language.  Or, to be pedantically
precise to the point that you are annoying people, it’s not really a
meta-interpreter collection at all since the interpreters themselves
aren’t interpreting the language that they are written in.  Let’s just
say that it is a collection of interpreters for a logic programming
language very much like pure Prolog with negation as finite failure.

Verdi Neruda is written entirely in Logtalk and compatible with most
major Prolog systems.  The name is sadly not a subtle wordplay or an
acronym, but was generated by a computer with the help of a soundex
algorithm.  The purpose of the interpreter suite was to compare top-down
methods to bottom-up methods and how resolution tree search rules
affected performance and completeness.  In the top-down family we find
such interpreters as the long-time standing champion depth-first, its
slow but orderly brother breadth-first and the youngster iterative
deepening.  A best-first framework can be found a stone throw away.
With it it’s possible to define interpreters that use greedy best-first
search as well as A* search.

In the bottom-up camp we find an interpreter that uses a semi naive
fixpoint construction.  Since bottom-up interpreters by their very
nature are not goal oriented a transformation technique called magic
transformation is used on logic programs before any inferences are made.
This technique allows the interpreter to only generate the facts that a
top-down interpreter would have used on the same logic program.

A shell akin to a Prolog top loop is also included.  It has commands
both for proving goals with an interpreter of choice and for
benchmarking logical inferences.  If Verdi Neruda is run with a Prolog
system that supports statistics/2 it’s possible to obtain statistics
such as CPU-time as well.

  3. VERDI NERUDA WEB SITE

Visit the Verdi Neruda GitHub www-page at:

‘https://github.com/Joelbyte/verdi-neruda’

  4. INSTALLATION AND RUNNING

Verdi Neruda requires Logtalk 2.40.0 or a later version.

To use the snapshot of Verdi Neruda bundled with Logtalk:

   - Start Logtalk.

   - Type ‘{verdi_neruda(loader)}.’ (Including ‘.’).

To use the latest version of Verdi Neruda, fetch the latest source code,
either as an archive or from the git repository, extract it to a
directory of your choice, and:

   - Start Logtalk from that directory.

   - Type ‘{loader}.’ (Including ‘.’).  If everything went according to
     the plan you should be greeted by the welcoming message.  If you
     replace the bundled version with the new one, you can use in
     alternative the steps above.

  5. EXAMPLES

Follow the previous instructions to get everything up and running.
First we’re going to run some predefined programs in the included
databases.  Begin by typing ‘databases.’ from the shell - this should
print a list of the currently loaded databases.  The demo database
‘demodb’ should be included in the list.  Next type ‘listing(demodb).’
to print the contents of the database.  The output should look something
like:

     append([],A,A) if
         true.
     append([A|B],C,[A|D]) if
         append(B,C,D).
     .
     .
     .

Which means that the ‘append/3’ program is loaded and ready for action.
Next we need to decide which interpreter to use.  Fortunately the shell
does not leave much to the imagination - as might be expected, the
‘interpreters.’ command prints the currently loaded interpreters.  The
list should look like:

     dfs_interpreter
     bfs_interpreter
     iddfs_interpreter(A)
     bup_interpreter
     a_star_interpreter(A)

The variables means that the interpreters are parametric objects and
that additional information is needed in order to run them.  The
iddfs-interpreter needs to know the increment and the A*-interpreter
needs to know what weight should be used when calculating the cost of
nodes.  To start with let’s use the dfs-interpreter and do something
exciting, namely appending two lists!

     prove(dfs_interpreter, append([a,b], [c,d], Xs), demodb).

The prove command takes three arguments.  The first is a interpreter,
the second the goal that shall be proved and the last the database that
the clauses are derived from.

To accomplish the same thing with the iddfs-interpreter with an
increment of 1 we need only type

     prove(iddfs_interpreter(1), append([a,b], [c,d], Xs), demodb).

The shell also has support for counting logical inferences.  To compare
the dfs- and iddfs-interpreter with the append program we could write:

     benchmark(dfs_interpreter, append([a,b,c,d],[e,f], Xs), demodb).  ->
     dfs_interpreter inferences: 5

     benchmark(iddfs_interpreter(1), append([a,b,c,d],[e,f], Xs), demodb).
     -> iddfs_interpreter(1) inferences: 15

For more information regarding the built in shell commands consult the
‘help.’ command.

  6. AUTHORS

The bulk of Verdi Neruda was written by Victor Lagerkvist during his
bachelor thesis at Linköping university in the spring of 2010.  Paulo
Moura also helped a great deal during the later stages of development,
especially with regards to compatibility between various Prolog systems.


File: TheLogtalkHandbook-3.100.1.info,  Node: xml_parser,  Prev: verdi_neruda,  Up: Contributions

8.5 ‘xml_parser’
================

This folder contains a Logtalk version of John Fletcher’s Prolog XML
parser:

‘https://binding-time.co.uk/index.php/Parsing_XML_with_Prolog’

For a detailed description of this XML parser, please see the comments
in the ‘xml.lgt’ source file or convert the automatically generated
documentation to HTML or PDF. For sample queries, please see the
‘SCRIPT.txt’ file.

See the copyright and license information on the contributed files for
usage and distributions conditions.

* Menu:

* API documentation: API documentation<237>.
* Loading: Loading<239>.
* Testing: Testing<230>.
* Known issues: Known issues<22>.


File: TheLogtalkHandbook-3.100.1.info,  Node: API documentation<237>,  Next: Loading<239>,  Up: xml_parser

8.5.1 API documentation
-----------------------

Open the ‘../../apis/library_index.html#xml_parser’ link in a web
browser.


File: TheLogtalkHandbook-3.100.1.info,  Node: Loading<239>,  Next: Testing<230>,  Prev: API documentation<237>,  Up: xml_parser

8.5.2 Loading
-------------

To load all entities in this library, load the ‘loader.lgt’ file:

     | ?- logtalk_load(xml_parser(loader)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Testing<230>,  Next: Known issues<22>,  Prev: Loading<239>,  Up: xml_parser

8.5.3 Testing
-------------

To test this library predicates, load the ‘tester.lgt’ file:

     | ?- logtalk_load(xml_parser(tester)).


File: TheLogtalkHandbook-3.100.1.info,  Node: Known issues<22>,  Prev: Testing<230>,  Up: xml_parser

8.5.4 Known issues
------------------

When using GNU Prolog as the backend compiler, you may need to to use a
larger default global stack size (see the GNU Prolog documentation on
the environment variable ‘GLOBALSZ’).


File: TheLogtalkHandbook-3.100.1.info,  Node: Glossary,  Next: Index<2>,  Prev: Contributions,  Up: Top

9 Glossary
**********

abstract class

     A *note class: 1347. that cannot be instantiated by sending it a
     message.  Usually used to contain common predicates that are
     inherited by other classes.

abstract method

     A *note method: 1349. implementing an algorithm whose step
     corresponds to calls to methods defined in the descendants of the
     object (or *note category: 134a.) containing it.

adapter file

     A Prolog source file defining a minimal abstraction layer between
     the Logtalk compiler/runtime and a specific *note backend Prolog
     compiler: 34.

after method

     The *note predicate definition: 58. used to answer an ‘after’
     event.

ancestor

     A *note class: 1347. or a parent *note prototype: 134d. that
     contributes (via inheritance) to the definition of an object.  For
     class-based hierarchies, the ancestors of an instance are its
     class(es) and all the superclasses of its class(es).  For
     prototype-based hierarchies, the ancestors of a prototype are its
     parent(s) and the ancestors of its parent(s).

around method

     An overriding definition for a predicate that calls additional
     goals before and after a call to the overriden predicate
     definition.

backend Prolog compiler

     The Prolog compiler that is used to host and run Logtalk and that
     is called for compiling the intermediate Prolog code generated by
     the Logtalk compiler when compiling source files.

before method

     The *note predicate definition: 58. used to answer a ‘before’
     event.

built-in method

     A predefined *note method: 1349. that can be called from within any
     object or *note category: 134a.  I.e.  built-in methods are
     built-in object and category predicates.  Built-in methods cannot
     be redefined.

built-in predicate

     A predefined predicate that can be called from anywhere.  Built-in
     predicates can be redefined within *note objects: 533. and *note
     categories: 134a.

category

     A set of *note predicates directives: 1352. and clauses that can be
     (virtually) imported by any object.  Categories support composing
     objects using fine-grained units of code reuse and also *note hot
     patching: 10b. of existing objects.  A category should be
     functionally-cohesive, defining a single functionality.

class

     An *note object: 533. that specializes another object, interpreted
     as its *note superclass: 60.  A class defines the common predicates
     of a set of objects that instantiate it.  An object can also be
     interpreted as a class when it instantiates itself.

clause reference

     An opaque term that uniquely identifies a clause.  Provided by some
     backends via alternative database built-in predicates.

closed-world assumption

     The assumption that what cannot be proved true is false.
     Therefore, sending a *note message: 43. corresponding to a
     'declared' but not 'defined' predicate, or calling a declared
     predicate with no clauses, fails.  But messages or calls to
     undeclared predicates generate an error.

closure

     A callable term (i.e., an atom or a compound term) passed to a
     *note meta-predicate: 52. call where it is extended with additional
     arguments to form a goal called by the meta-predicate.

coinductive predicate

     A predicate whose calls are proved using greatest fixed point
     semantics.  Coinductive predicates allows reasoning about infinite
     rational entities such as cyclic terms and ω-automata.

complementing category

     A category used for *note hot patching: 10b. an existing object (or
     a set of objects).

component

     A unique atom or compound term template identifying a library,
     tool, application, or application sub-system.  Component names are
     notably used by the message printing and question asking
     mechanisms.  Compound terms are used instead of atoms when
     parameterization is required.

debug handler

     An object or category that defines clauses for the multifile
     predicates that handle the trace and debug events generated by the
     runtime.

directive

     A source file term that affects the interpretation of source code.
     Directives use the ‘(:-)/1’ prefix operator as functor.

discontiguous predicate

     A predicate whose clauses are not contiguous in a *note source
     file: 61c.  I.e.  a predicate whose clauses are mixed with clauses
     for other predicates.

doclet file

     A *note source file: 61c. whose main purpose is to generate
     documentation for a *note library: 6e. or an application.

doclet object

     An object specifying the steps necessary to (re)generate the API
     documentation for a project.  See the *note doclet: 32d. and *note
     lgtdoc: 322. tools for details.

dynamic binding

     Runtime lookup of a *note predicate declaration: 57. and *note
     predicate definition: 58. to verify the validity of a *note
     message: 43. (or a *note super call: 115.) and find the predicate
     definition that will be used to answer the message (or the super
     call).  Also known as 'late binding'.  See also *note static
     binding: 35.

dynamic entity

     See *note entity: 1357.

dynamic predicate

     A predicate whose clauses can be dynamically added or retracted at
     runtime.

early binding

     See *note static binding: 35.

encapsulation

     The hiding of an object implementation.  This promotes software
     reuse by isolating the object clients from its implementation
     details.  Encapsulation is enforced in Logtalk by using *note
     predicate scope directives: 1e4.

entity

     Generic name for Logtalk compilation units: *note objects: 533,
     *note categories: 134a, and *note protocols: 59.  Entities share a
     single namespace (i.e., entity *note identifiers: 135a. must be
     unique) and can be static (the default) or dynamic.  Static
     entities are defined in source files.  Dynamic entities can also be
     defined in source files but are usually created and abolished at
     runtime using the language built-in predicates.

entity alias

     An alternative name for an entity.  Entity aliases can be defined
     using the *note uses/1: 4a. and *note use_module/1: 4c. directives.
     Entity aliases can be used to improve code clarity by using
     alternative names that are more meaningful in the calling context,
     to bind parametric entity parameters, and to simplify experimenting
     with alternative entities implementing the same protocol.

entity directive

     A directive that affects how Logtalk *note entities: 1357. are used
     or compiled.

event

     The sending of a *note message: 43. to an object.  An event can be
     expressed as an ordered tuple: ‘(Event, Object, Message, Sender)’.
     Logtalk distinguishes between the sending of a message — ‘before’
     event — and the return of control to the sender — ‘after’ event.

expansion workflow

     A sequence of *note term-expansion: 135e. or *note goal-expansion:
     135f. steps where each step is usually defined using a *note hook
     object: 39e. or a combination of hook objects.

flaky test

     A test that can unpredictably succeed, fail, or throw an error and
     thus can yield different results when repeated without any code
     changes.  Can result from, e.g., race conditions or dependencies on
     external resources outside user control.

goal-expansion

     The transformation of a goal into another goal, defined by clauses
     for the *note goal_expansion/2: fd. predicate that is declared by
     the expanding(1) built-in protocol.  Goal-expansion is usually
     recursively applied at compile time until a fixed-point is reached
     (i.e., until the result of an expansion cannot be further
     expanded).  See also *note term-expansion: 135e. and *note
     expansion workflow: 135d.

grammar rule

     An alternative notation for predicates used to parse or generate
     sentences in some language.  This notation hides the arguments used
     to pass the sequences of tokens being processed, thus simplifying
     the representation of grammars.  Grammar rules are represented
     using as functor the infix operator ‘(-->)/2’ instead of the
     ‘(:-)/2’ operator used with predicate clauses.

grammar rule non-terminal

     A syntactic category of words or phrases.  A non-terminal is
     identified by its 'non-terminal indicator', i.e.  by its name and
     number of arguments using the notation ‘Name//Arity’.

grammar rule terminal

     A word or basic symbol of a language.

homoiconic

     A property of programming languages where 'code' and 'data' use the
     same representation.  Logtalk (and Prolog) are examples of
     homoiconic programming languages.  A Logtalk program is a set of
     terms (clauses and directives) that can be handled as 'data' by
     e.g.  the *note term-expansion: 135e. mechanism.

hook object

     An object, implementing the expanding(2) built-in protocol,
     defining *note term-expansion: 135e. and *note goal-expansion:
     135f. predicates, used in the compilation of Logtalk or Prolog
     source files.  A hook object can be specified using the *note hook:
     fe. flag.  It can also be specified using a *note
     set_logtalk_flag/2: 50. directive in the source files to be
     expanded.

hook predicate

     A predicate, usually declared *note multifile: 16b, that allows the
     user to customize another predicate or provide alternative
     definitions for a default predicate definition.

hot patching

     The act of fixing *note entity directives: 135b. and predicates or
     adding new entity directives and predicates to loaded *note
     entities: 1357. in a running application without requiring access
     to the entities source code or restarting the application.
     Achieved using *note complementing categories: 1353.

identity

     Property of an *note entity: 1357. that distinguishes it from every
     other entity.  The identifier of an entity is its functor (i.e.,
     its name and arity), which must be unique.  Object and *note
     category: 134a. identifiers can be atoms or compound terms.
     Protocol identities must be atoms.  All Logtalk entities (objects,
     protocols, and categories) share the same namespace.

inheritance

     An *note entity: 1357. inherits *note predicates directives: 1352.
     and clauses from related entities.  In the particular case of
     objects, when an object extends other object, we have
     prototype-based inheritance.  When an object specializes or
     instantiates another object, we have class-based inheritance.  See
     also *note public inheritance: 1364, *note protected inheritance:
     1365, and *note private inheritance: 1366.

instance

     An *note object: 533. that instantiates another object, interpreted
     as its *note class: 1347.  An object may instantiate multiple
     objects (also known as multiple instantiation).

instantiation

     The process of creating a new *note class: 1347. *note instance:
     1367.  In Logtalk, this does not necessarily imply dynamic creation
     of an object at runtime; an instance may also be defined as a
     static object in a source file.

interface

     See *note protocol: 59.

lambda expression

     A compound term that can be used in place of a goal or *note
     closure: 14f. meta-argument and that abstracts a *note predicate
     definition: 58. by listing its variables and a callable term that
     implements the definition.  Lambda expressions help avoid the need
     of naming and defining auxiliary predicates.

lambda free variable

     A variable that is global to a *note lambda expression: 182.  All
     used global variables must be explicitly listed in a lambda
     expression for well-defined semantics.

lambda parameter

     A term (usually a variable or a non-ground compound term) that is
     local to a *note lambda expression: 182.  All lambda parameters
     must be explicitly enumerated in a lambda expression for
     well-defined semantics.

late binding

     See *note dynamic binding: 36.

library

     A directory containing source files.  See also *note library alias:
     136b. and *note library notation: 2a8.

library alias

     An atom that can be used as an alias for a *note library: 6e. full
     path.  Library aliases and their corresponding paths can be defined
     using the *note logtalk_library_path/2: 2a7. predicate.  See also
     *note library notation: 2a8.

library notation

     A compound term where the name is a *note library alias: 136b. and
     the single argument is a *note source file: 61c. relative path.
     Use of library notation simplifies compiling and loading source
     files and can make an application easily relocatable by defining an
     alias for the root directory of the application files.

loader file

     A *note source file: 61c. whose main purpose is to load a set of
     source files (possibly with specific compiler flags) and any
     library dependencies.

local predicate

     A predicate that is defined in an object (or in a *note category:
     134a.) but that is not listed in a *note scope directive: 1e4.
     These predicates behave like private predicates but are invisible
     to the reflection *note built-in methods: 1350.  Local predicates
     are usually auxiliary predicates and only relevant to the entity
     where they are defined.

message

     A query sent to an object.  In logical terms, a message can be
     interpreted as a request for proof construction using an object
     database and the databases of related entities.

message lookup

     Sending a message to an object requires a lookup for the *note
     predicate declaration: 57, to check if the message is within the
     scope of the sender, and a lookup for the *note predicate
     definition: 58. that is going to be called to answer the message.
     Message lookup can occur at *note compile: 35. time or at *note
     runtime: 36.

message to self

     A message sent to the object that received the original message
     under processing.  Messages to self require *note dynamic binding:
     36. as the value of self is only know at runtime.

meta-argument

     A predicate argument that is called as a goal, used as a *note
     closure: 14f. to construct a goal that will be called, or that is
     handled in a way that requires awareness of the predicate calling
     context.

meta-interpreter

     A program capable of running other programs written in the same
     language.

meta-predicate

     A predicate with one or more *note meta-arguments: 136c.  For
     example, *note call/1-N: 181. and *note findall/3: 1c0. are
     built-in meta-predicates.

meta-variable

     A variable in a *note meta-argument: 136c. position that is
     expected to be unified with a goal or a closure at runtime.

metaclass

     The *note class: 1347. of a class, when interpreted as an *note
     instance: 1367.  Metaclass instances are themselves classes.
     Metaclasses are optional, except for the root class, and can be
     shared by several classes.

method

     The *note predicate definition: 58. used to answer a *note message:
     43. sent to an object.  Logtalk supports both *note static binding:
     35. and *note dynamic binding: 36. to find which method to run to
     answer a message.  See also *note built-in method: 1350.

mocking

     Techniques used to replace dependencies in the code being tested
     with controlled substitutes, simplifying testing.  Can be
     accomplished using, e.g., *note term-expansion: 135e, hot patching,
     or message interception.

module

     A Prolog entity characterized by an identity and a set of *note
     predicates directives: 1352. and clauses.  Prolog modules are
     usually static although some Prolog systems allow the creation of
     dynamic modules at runtime.  Prolog modules can be interpreted as
     *note prototypes: 134d.

monitor

     Any object, implementing the monitoring(3) built-in protocol, that
     is notified by the runtime when a spied event occurs.  The spied
     *note events: 135c. can be set by the monitor itself or by any
     other object.

multifile predicate

     A predicate whose clauses can be defined in multiple *note
     entities: 1357. and *note source files: 61c.  The object or
     category holding the directive without an entity prefix qualifying
     the predicate holds the multifile predicate 'primary declaration',
     which consists of both a *note scope directive: 1e4. and a *note
     multifile/1: 16c. directive for the predicate.

naked meta-variable

     A *note meta-variable: 183. used as the body of a predicate clause
     or grammar rule or used in a cut-transparent argument of a control
     construct.  The “naked” designation highlights that the
     meta-variable is not wrapped by ‘call/1’ or ‘phrase//1’ goals.

object

     An entity characterized by an *note identity: 135a. and a set of
     *note predicates directives: 1352. and clauses.  Logtalk objects
     can be either static or dynamic.  Logtalk objects can play the
     'role' of classes, instances, or prototypes.  The role or roles an
     object plays are a function of its relations with other objects.

object database

     The set of predicates locally defined inside an object.

parameter

     An argument of a parametric object or a parametric category
     identifier.  Parameters are 'logical variables' implicitly shared
     by all the entity directives and predicate clauses.

parameter variable

     A variable used as parameter in a parametric object or a parametric
     category using the syntax ‘_ParameterName_’ (i.e., a variable whose
     name stars and ends with an underscore).  Parameter variables are
     'logical variables' shared by all entity terms.  Occurrences of
     parameter variables in *note entity directives: 135b. and clauses
     are implicitly unified with the corresponding entity parameters.

parametric category

     See *note parametric entity: 6a0.

parametric entity

     An *note object: 533. or *note category: 134a. whose *note
     identifier: 135a. is a compound term possibly containing free
     variables that can be used to parameterize the entity predicates.
     Parameters are 'logical variables' implicitly shared by all the
     entity clauses.  Note that the identifier of a parametric entity is
     its functor, irrespective of the possible values of its arguments
     (e.g., ‘foo(bar)’ and ‘foo(baz)’ are different parameterizations of
     the same parametric entity, ‘foo/1’).

parametric object

     See *note parametric entity: 6a0.

parametric object proxy

     A compound term (usually represented as a plain Prolog fact) with
     the same name and number of arguments as the identifier of a
     parametric object.

parent

     A *note prototype: 134d. that is extended by another prototype.

polymorphism

     Different objects (and categories) can provide different
     implementations of the same predicate.  The predicate declaration
     can be inherited from a common ancestor, also known as 'subtype
     polymorphism'.  Logtalk implements 'single dispatch' on the
     receiver of a message, which can be described as 'single-argument
     polymorphism'.  As *note message lookup: 37. only uses the
     predicate functor, multiple predicate implementations for different
     types of arguments are possible, also known as 'ad hoc
     polymorphism'.  *note Parametric objects and categories: 6a0.
     enable implementation of 'parametric polymorphism' by using one or
     more parameters to pass object identifiers that can be used to
     parameterize generic predicate definitions.

predicate

     Predicates describe what is true about the application domain.  A
     predicate is identified by its 'predicate indicator', i.e.  by its
     name and number of arguments using the notation ‘Name/Arity’.  See
     also *note built-in predicate: 1351. and *note method: 1349.

predicate alias

     An alternative functor (‘Name/Arity’) for a predicate.  Predicate
     aliases can be defined for any inherited predicate using the *note
     alias/2: 165. directive and for predicates listed in *note uses/2:
     4b. and *note use_module/2: 4d. directives.  Predicate aliases can
     be used to solve inheritance conflicts, to improve code clarity by
     using alternative names that are more meaningful in the calling
     context, and to use a different order of the predicate arguments.

predicate calling context

     The object or category from within a predicate is called (either
     directly or using a control construct such as a message-sending
     control construct).

predicate declaration

     A predicate declaration is composed by a set of *note predicates
     directives: 1352, which must include at least a *note scope
     directive: 1e4.

predicate definition

     The set of clauses for a predicate, contained in an object or
     category.  Predicate definitions can be overridden or specialized
     in descendant entities.

predicate definition context

     The object or category that contains the definition (i.e., clauses)
     for a predicate.

predicate directive

     A directive that specifies a predicate property that affects how
     predicates are called or compiled.

predicate execution context

     The implicit arguments (including *note sender: 399, *note self:
     69, and *note this: 114.) required for the correct execution of a
     predicate call.

predicate scope container

     The object that inherits a *note predicate declaration: 57. from an
     imported *note category: 134a. or an implemented *note protocol:
     59.

predicate scope directive

     A directive that declares a predicate by specifying its visibility
     as 'public', 'protected', or 'private'.

predicate shorthand

     A *note predicate alias: ca. that defines a call template, possibly
     using a different name, with a reduced number of arguments by
     hard-coding the value of the omitted arguments in the original call
     template.  Predicate shorthands can be defined using *note uses/2:
     4b. and *note use_module/2: 4d. directives.  They can be used to
     simplify predicate calls and to ensure consistent call patterns
     when some of the arguments always use the same fixed values in the
     calling context.

primary predicate declaration

     See *note multifile predicate: 16b.

private inheritance

     All public and protected predicates are inherited as private
     predicates.  See also *note public inheritance: 1364. and *note
     protected inheritance: 1365.

private predicate

     A predicate that can only be called from the object that contains
     its *note scope directive: 1e4.

profiler

     A program that collects data about other program performance.

protected inheritance

     All public predicates are inherited as protected.  No scope change
     for protected or private predicates.  See also *note public
     inheritance: 1364. and *note private inheritance: 1366.

protected predicate

     A predicate that can only be called from the object containing its
     *note scope directive: 1e4. or from an object that inherits the
     predicate.

protocol

     An entity that contains *note predicate declarations: 57.  A
     predicate is declared using a *note scope directive: 1e4.  It may
     be further specified by additional predicate directives.  Protocols
     support the separation between interface and implementation, can be
     implemented by both objects and categories, and can be extended by
     other protocols.  A protocol should be functionally-cohesive,
     specifying a single functionality.  Also known as 'interface'.

prototype

     A self-describing *note object: 533. that may extend or be extended
     by other objects.  A prototype typically describes a concrete
     object instead of an abstraction of a set of objects.  An object
     with no instantiation or specialization relations with other
     objects is always interpreted as a prototype.

public inheritance

     All inherited predicates maintain their declared scope.  See also
     *note protected inheritance: 1365. and *note private inheritance:
     1366.

public predicate

     A predicate that can be called from any object.

scratch directory

     The directory used to save the intermediate Prolog files generated
     by the compiler when compiling *note source files: 61c.

self

     The object that received the *note message: 43. under processing.

sender

     An object that sends a *note message: 43. to other object.  When a
     message is sent from within a *note category: 134a, the 'sender' is
     the object importing the category on which behalf the message was
     sent.

settings file

     A *note source file: 61c, compiled and loaded automatically by
     default at Logtalk startup, mainly defining default values for
     compiler flags that override the defaults found on the backend
     Prolog compiler *note adapter files: 154.

singleton method

     A *note method: 1349. defined in an *note instance: 1367. itself.
     Singleton methods are supported in Logtalk and can also be found in
     other object-oriented programming languages.

source file

     A text file defining Logtalk and/or Prolog code.  Multiple Logtalk
     entities may be defined in a single source file.  Plain Prolog code
     may be intermixed with Logtalk entity definitions.  Depending on
     the used *note backend Prolog compiler: 34, the text encoding may
     be specified using an *note encoding/1: 298. directive as the first
     term in the first line in the file.

source file directive

     A *note directive: 1354. that affects how a *note source file: 61c.
     is compiled.

specialization

     A *note class: 1347. is specialized by defining a new class that
     inherits its predicates and possibly adds new ones.

static binding

     Compile time lookup of a *note predicate declaration: 57. and *note
     predicate definition: 58. when compiling a *note message: 43.
     sending call (or a *note super call: 115.).  Dynamic binding is
     used whenever static binding is not possible (e.g., due to the
     predicate being dynamic or due to lack of enough information at
     compilation time).  Also known as 'early binding'.  See also *note
     dynamic binding: 36.

static entity

     See *note entity: 1357.

steadfastness

     A predicate definition is 'steadfast' when it still generates only
     correct answers when called with unexpectedly bound arguments
     (notably, bound output arguments).  Typically, a predicate may not
     be steadfast when output argument unifications can occur before a
     cut in a predicate clause body.

subclass

     A *note class: 1347. that is a specialization, direct or
     indirectly, of another class.  A class may have multiple
     subclasses.

super call

     Call of an inherited (or imported) *note predicate definition: 58.
     Mainly used when redefining an inherited (or imported) predicate to
     call the overridden definition while making additional calls.
     Super calls preserve *note self: 69. and may require *note dynamic
     binding: 36. if the predicate is dynamic.

superclass

     A *note class: 1347. from which another class is a specialization
     (directly or indirectly via another class).  A class may have
     multiple superclasses.

synchronized predicate

     A synchronized predicate is protected by a mutex ensuring that, in
     a multi-threaded application, it can only be called by a single
     thread at a time.

template method

     See *note abstract method: 1348.

term-expansion

     The transformation of a term (usually a directive or a clause) into
     another term or a list of terms, defined by clauses for the *note
     term_expansion/2: fc. predicate that is declared by the
     expanding(4) built-in protocol.  Term-expansion is usually applied
     at compile time once (i.e., the result of an expansion is not
     further expanded).  See also *note goal-expansion: 135f. and *note
     expansion workflow: 135d.

test dialect

     Predicate syntax for defining a test.  I.e., the predicate name;
     the number, syntax, and semantics of the predicate arguments; and
     the syntax and semantics of any options.

test outcome

     The expected result of a test goal.  E.g., success, failure, an
     error, deterministic success, success with bindings that subsume or
     are a variant of specific terms.

tester file

     A *note source file: 61c. whose main purpose is to load and a run a
     set of unit tests.

this

     The object that contains the predicate clause under execution.
     When the predicate clause is contained in a *note category: 134a,
     'this' is a reference to the object importing the category on which
     behalf the predicate clause is being used to prove the current
     goal.

threaded engine

     A computing thread running a goal whose solutions can be lazily and
     concurrently computed and retrieved.  A threaded engine also
     supports a term queue that allows passing arbitrary terms to the
     engine.  This queue can be used to pass e.g.  data and new goals to
     the engine.

top-level interpreter shorthand

     Aliases for frequently used built-in predicates such as *note
     logtalk_load/1: 46. and *note logtalk_make/1: 2a0.  These
     shorthands are 'not' part of the Logtalk language and must only be
     used at the top-level interpreter.

visible predicate

     A predicate that is within scope, a locally defined predicate, a
     *note built-in method: 1350, a Logtalk built-in predicate, or a
     Prolog built-in predicate.

(Alexiev93) Mutable Object State for Object-Oriented Logic Programming:
A Survey Alexiev, V. Technical Report TR 93-15, Department of Computing
Science, University of Alberta, Canada

(Belli_et_al_92) Object-oriented programming in Prolog: rationale and a
case study Belli, F., Jack, O., Naish, L. Technical Report 92/2,
Department of Electrical and Electronics Engineering, University of
Paderborn, Germany URL:
‘https://lee-naish.github.io/papers/oolp/index.html’

(Block89) An Extended Frame Language Block, F. P., Chan, N. C.
Proceedings OOPLSLA 89(10):151-157, ACM

(Bobrow_et_al_88) Common Lisp Object System Specification Bobrow, D. G.,
Michiel, L. G., Gabriel, R. P., Keene, S. E., Kiczales, G., Moon, D. A.
ACM SIGPLAN Notices(23)

(Bratko90) Prolog Programming for Artificial Intelligence Bratko, I.
Addison Wesley, 2º edition, 1990

(Champaux92) A comparative Study of Object-Oriented Analysis Methods
Champaux, D., Faure, P. Journal of Object-Oriented Programming, Vol.  5,
N.1, 1992

(Clocksin87) Programming in Prolog Clocksin, W.F., Mellish, C.S.
Springer-Verlag, New York, 1987

(Cointe87) Metaclasses are First Class: the ObjVlisp Model Cointe, P.
Proceedings OOPLSLA 87(10):156-167, ACM

(Cordes91) The Literate Programming Paradigm Cordes, D., Brown, M. IEEE
Computer, June 1991:52-61

(Covington94) ISO Prolog: A Summary of the Draft Proposed Standard
Covington, M. A. URL: ‘ftp://ai.uga.edu/pub/prolog.standard/’

(Cox86) Object-Oriented Programming: An Evolutionary Approach Cox, Brad
J. Addison-Wesley Publishing Company, Don Mills, Ontario

(Davison89) Polka: A Parlog Object oriented language Davison, A. Ph.D.
Thesis, Imperial College, London, 1989

(Davison92) A survey of logic programming-based object oriented
languages Davison, A. Tech Report 92/3, Dept.  of Computer Science,
University of Melbourne, Australia URL:
‘https://catalogue.nla.gov.au/catalog/772526’

(Davison93) The deductive and object oriented features of BeBOP Davison,
A. Tech Report 93/6, Dept.  of Computer Science, University of
Melbourne, Australia URL: ‘https://catalogue.nla.gov.au/catalog/1273317’

(Delzanno97) Logic and Object-Oriented Programming in Linear Logic
Delzanno, G. Ph.D. Thesis, University of Pisa, Italy URL:
‘https://opac.bncf.firenze.sbn.it/Record/BVE0136144?uri=BVE0136144’

(Dony90) Exception Handling and Object-Oriented Programming: Towards a
Synthesis Dony, C. Proceedings OOPLSLA 90:322-330, ACM

(Fornarino_et_al_89) An Original Object-Oriented Approach for Relation
Management Fornarino, M., Pinna, A.-M.,Trousse, B. Proceedings of the
4th Portuguese Conference on Artificial Intelligence Lecture Notes in
Artificial Intelligence, Springer-Verlag (390):13-26

(Fromherz93) OL(P): Object Layer for Prolog Fromherz, M. URL:
‘ftp://parcftp.xerox.com/ftp/pub/ol/’

(Fukunaga86) An Experience with a Prolog-based Object-Oriented Language
Fukunaga, K., Hirose, S. Proceedings OOPLSLA 86, 21(11):224-231, ACM

(Goldberg83) Smalltalk-80 The language and its implementation Goldberg,
A., Robson, D. Addison-Wesley Series in Computer Science

(Joy_et_al_00) The Java Language Specification, Second Edition Joy, B.,
Steele, G., Gosling, J., Bracha, G. Addison-Wesley, 2000

(ISO95) ISO/IEC DIS 13211-1 - Programming Language Prolog Part 1:
General Core Joint Technical Committee ISO/IEC JTC 1 URL:
‘https://www.iso.org/standard/21413.html’

(Knuth84) Literate Programming Knuth, D. E. Computer Journal, May 84,
27(2):97-111

(Lieberman86) Using Prototypical Objects to Implement Shared Behaviour
in Object Oriented Systems Lieberman, H. Proceedings OOPLSLA 86:189-214,
ACM

(Maes87) Concepts and Experiments in Computational Reflection Maes, P.
Proceedings OOPLSLA 87, ACM

(McCabe92) Logic and Objects McCabe, F. G. Prentice Hall Series in
Computer Science

(Moon86) Object-Oriented Programming in Flavors Moon, D. Proceedings
OOPLSLA 86:1-8, ACM

(Moss94) Prolog++ The Power of Object-Oriented and Logic Programming
Moss, C. Addison-Wesley International Series in Logic Programming, 1994

(Moura94) Logtalk: Programação Orientada para Objectos em Prolog Moura,
P., Costa, E. 2ª Conferência e Exposição Portuguesa de Tecnologia
Orientada por Objectos 3i Consultores, Lisboa

(Moura99) Porting Prolog: Notes on porting a Prolog program to 22 Prolog
compilers or the relevance of the ISO Prolog standard Moura, P. ALP
Newsletter, Vol.  12/2, May 1999

(Moura00) Logtalk 2.6 Documentation Moura, P. Technical Report DMI
2000/1 University of Beira Interior, Portugal

(Razek92) Combining Objects and Relations Razek, G. Communications of
the ACM, 27(12):66-70

(Rumbaugh87) Relations as Semantic Constructs in an Object-Oriented
Language Rumbaugh, J. Proceedings OOPLSLA 87:466-481, ACM

(Rumbaugh88) Controlling Propagation of Operations using Attributes on
Relations Rumbaugh, J. Proceedings OOPLSLA 88:285-296, ACM

(Schachte95) Efficient Object-Oriented Programming in Prolog Schachte,
P., Saab, G. Logic Programming: Formal Methods and Pratical Applications
Studies in Computer Science and Artificial Intelligence, 11 Elsevier
Science B.V. North-Holland, Amsterdam, 1995

(SICStus95) SICStus Prolog Manual SICStus URL: ‘https://sicstus.sics.se’

(Shan_et_al_93) Is Multiple Inheritance Essential to OOP? (Panel) Shan,
Y., Cargill, T., Cox, B., Cook, W., Loomis, M., Snyder, A. Proceedings
OOPLSLA 93:360-363

(Stefik_et_al_86) Integrating Acess-Oriented Programming into a
Multiparadigm Environment Stefik, M. J., Bobrow, D. G. , Kahn, K. M.
IEEE Software, January 1986:10-18

(Stroustrup86) The C++ Programming Language Stroustrup, B.
Addison-Wesley Series in Computer Science

(Taenzer89) Problems in Object-Oriented Software Reuse Taenzer, D.,
Ganti, M., Podar, S. Proceedings of ECOOP 89 British Computer Society
Workshop Series, Cambridge University Press

(Tanzer95) Remarks on Object-Oriented Modeling of Associations Tanzer,
C. Journal of Object-Oriented Programming, February 1995, SIGS
Publications

(Tanenbaum87) Operating Systems - Design and Implementation Tanenbaum,
A. Prentice-Hall Software Series, 1987

(Welsch89) Reasoning Objects with Dynamic Knowledge Bases Welsch, C.,
Barth, G. Proceedings of the 4th Portuguese Conference on Artificial
Intelligence(390):257-268 Lecture Notes in Artificial Intelligence,
Springer-Verlag, 1989

   ---------- Footnotes ----------

   (1) ../apis/expanding_0.html#expanding-0

   (2) ../apis/expanding_0.html#expanding-0

   (3) ../apis/monitoring_0.html#monitoring-0

   (4) ../apis/expanding_0.html#expanding-0


File: TheLogtalkHandbook-3.100.1.info,  Node: Index<2>,  Next: Index,  Prev: Glossary,  Up: Top

10 Index
********


File: TheLogtalkHandbook-3.100.1.info,  Node: Index,  Prev: Index<2>,  Up: Top

Index
*****

[index]
* Menu:

* !/0; Built-in method:                  Logic and control.   (line   8)
* (;;)/1; Control construct:             Examples<2>.         (line  19)
* (;;)/2; Control construct:             Message sending<2>.  (line   8)
* (@)/1; Control construct:              Calling predicates in this.
                                                              (line   8)
* (\+)/1; Built-in method:               Examples<122>.       (line  19)
* (^^)/1; Control construct:             Calling imported and inherited predicates<2>.
                                                              (line   8)
* (<<)/2; Control construct:             Context switching calls.
                                                              (line   8)
* []/1; Control construct:               Message delegation.  (line   8)
* {}/1; Control construct:               Calling external predicates.
                                                              (line   8)
* abolish_category/1; Built-in predicate: Abolishing objects categories and protocols.
                                                              (line   8)
* abolish_events/5; Built-in predicate:  Event handling<2>.   (line   8)
* abolish_object/1; Built-in predicate:  Examples<55>.        (line  16)
* abolish_protocol/1; Built-in predicate: Examples<56>.       (line  17)
* abolish/1; Built-in method:            Database.            (line   8)
* abstract class:                        Glossary.            (line   6)
* abstract method:                       Glossary.            (line  10)
* adapter file:                          Glossary.            (line  16)
* after method:                          Glossary.            (line  22)
* after/3; Built-in method:              Examples<143>.       (line  22)
* alias/2; Directive:                    Predicate directives<2>.
                                                              (line   8)
* always_true_or_false_goals; Flag:      Lint flags.          (line  83)
* ancestor:                              Glossary.            (line  27)
* arithmetic_expressions; Flag:          Lint flags.          (line  96)
* around method:                         Glossary.            (line  36)
* ask_question/5; Built-in method:       Question asking.     (line   8)
* asserta/1; Built-in method:            Examples<114>.       (line  21)
* assertz/1; Built-in method:            Examples<115>.       (line  60)
* backend Prolog compiler:               Glossary.            (line  42)
* bagof/3; Built-in method:              All solutions.       (line   8)
* before method:                         Glossary.            (line  48)
* before/3; Built-in method:             Event handling<3>.   (line   8)
* begin_of_file:                         Hook objects.        (line  89)
* behavioral reflection:                 Black-box view.      (line  18)
* black-box view:                        Transparent-box view.
                                                              (line  31)
* built_in/0; Directive:                 Entity directives.   (line   8)
* built-in method:                       Glossary.            (line  53)
* built-in predicate:                    Glossary.            (line  60)
* call//1-N; Built-in method:            Definite clause grammar rules<2>.
                                                              (line   8)
* call/1-N; Built-in method:             Meta-calls.          (line   8)
* catch/3; Built-in method:              Error handling<2>.   (line   8)
* catchall_catch; Flag:                  Lint flags.          (line 171)
* category:                              Glossary.            (line  66)
* category_property/2; Built-in predicate: Enumerating objects categories and protocols properties.
                                                              (line   8)
* category/1-4; Directive:               Examples<18>.        (line   9)
* class:                                 Glossary.            (line  74)
* clause reference:                      Glossary.            (line  81)
* clause/2; Built-in method:             Examples<116>.       (line  60)
* clean; Flag:                           Other flags.         (line 108)
* closed-world assumption:               Glossary.            (line  86)
* closure:                               Glossary.            (line  94)
* code_prefix; Flag:                     Other flags.         (line  29)
* coinduction; Flag:                     Read-only flags.     (line  88)
* coinductive predicate:                 Glossary.            (line 100)
* coinductive_success_hook/1-2; Built-in method: Coinduction hooks.
                                                              (line   8)
* coinductive/1; Directive:              Examples<30>.        (line  19)
* complementing category:                Glossary.            (line 106)
* complements_object/2; Built-in predicate: Examples<62>.     (line  25)
* complements; Flag:                     Optional features compilation flags.
                                                              (line   6)
* component:                             Glossary.            (line 111)
* conditionals; Flag:                    Lint flags.          (line 163)
* conforms_to_protocol/2-3; Built-in predicate: Examples<61>. (line  25)
* consistency_error/3; Built-in method:  Examples<129>.       (line  23)
* context_switching_calls; Flag:         Optional features compilation flags.
                                                              (line  41)
* context/1; Built-in method:            Execution context.   (line   8)
* create_category/4; Built-in predicate: Creating new objects categories and protocols.
                                                              (line   8)
* create_logtalk_flag/3; Built-in predicate: Examples<98>.    (line  16)
* create_object/4; Built-in predicate:   Examples<52>.        (line  21)
* create_protocol/3; Built-in predicate: Examples<53>.        (line  63)
* current_category/1; Built-in predicate: Enumerating objects categories and protocols.
                                                              (line   8)
* current_event/5; Built-in predicate:   Examples<67>.        (line  17)
* current_logtalk_flag/2; Built-in predicate: Flags.          (line   8)
* current_object/1; Built-in predicate:  Examples<46>.        (line  20)
* current_op/3; Built-in method:         Reflection<2>.       (line   8)
* current_predicate/1; Built-in method:  Examples<111>.       (line  20)
* current_protocol/1; Built-in predicate: Examples<47>.       (line  22)
* debug handler:                         Glossary.            (line 119)
* debug; Flag:                           Other flags.         (line  73)
* define_events/5; Built-in predicate:   Examples<68>.        (line  16)
* deprecated; Flag:                      Lint flags.          (line  58)
* directive:                             Glossary.            (line 125)
* discontiguous predicate:               Glossary.            (line 130)
* discontiguous/1; Directive:            Examples<31>.        (line  17)
* disjunctions; Flag:                    Lint flags.          (line 155)
* doclet file:                           Glossary.            (line 136)
* doclet object:                         Glossary.            (line 141)
* domain_error/2; Built-in method:       Examples<128>.       (line  22)
* duplicated_clauses; Flag:              Lint flags.          (line 146)
* duplicated_directives; Flag:           Lint flags.          (line  69)
* dynamic binding:                       Glossary.            (line 147)
* dynamic entity:                        Glossary.            (line 156)
* dynamic predicate:                     Glossary.            (line 160)
* dynamic_declarations; Flag:            Optional features compilation flags.
                                                              (line  19)
* dynamic/0; Directive:                  Examples<19>.        (line  27)
* dynamic/1; Directive:                  Examples<32>.        (line  13)
* early binding:                         Glossary.            (line 165)
* elif/1; Directive:                     Examples<14>.        (line  42)
* else/0; Directive:                     Examples<15>.        (line  26)
* encapsulation:                         Glossary.            (line 169)
* encoding_directive; Flag:              Read-only flags.     (line  52)
* encoding/1; Directive:                 Source file directives<2>.
                                                              (line   8)
* encodings; Flag:                       Lint flags.          (line 195)
* end_category/0; Directive:             Examples<20>.        (line  15)
* end_object/0; Directive:               Examples<21>.        (line  14)
* end_of_file:                           Hook objects.        (line  89)
* end_protocol/0; Directive:             Examples<22>.        (line  14)
* endif/0; Directive:                    Examples<16>.        (line  30)
* engines; Flag:                         Read-only flags.     (line  67)
* entity:                                Glossary.            (line 176)
* entity alias:                          Glossary.            (line 186)
* entity directive:                      Glossary.            (line 195)
* eos//0; Built-in method:               Examples<146>.       (line  22)
* evaluation_error/1; Built-in method:   Examples<133>.       (line  21)
* event:                                 Glossary.            (line 200)
* events; Flag:                          Optional features compilation flags.
                                                              (line  30)
* existence_error/2; Built-in method:    Examples<130>.       (line  33)
* expand_goal/2; Built-in method:        Examples<152>.       (line  16)
* expand_term/2; Built-in method:        Term and goal expansion<2>.
                                                              (line   8)
* expansion workflow:                    Glossary.            (line 207)
* extends_category/2-3; Built-in predicate: Examples<59>.     (line  19)
* extends_object/2-3; Built-in predicate: Objects categories and protocols relations.
                                                              (line   8)
* extends_protocol/2-3; Built-in predicate: Examples<58>.     (line  19)
* fail/0; Built-in method:               Examples<102>.       (line  15)
* false/0; Built-in method:              Examples<103>.       (line  15)
* findall/3; Built-in method:            Examples<138>.       (line  20)
* findall/4; Built-in method:            Examples<139>.       (line  20)
* flaky test:                            Glossary.            (line 213)
* forall/2; Built-in method:             Examples<140>.       (line  20)
* forward/1; Built-in method:            Message forwarding.  (line   8)
* general; Flag:                         Lint flags.          (line 200)
* goal_expansion/2; Built-in method:     Examples<153>.       (line  15)
* goal-expansion:                        Glossary.            (line 220)
* grammar rule:                          Glossary.            (line 230)
* grammar rule non-terminal:             Glossary.            (line 239)
* grammar rule terminal:                 Glossary.            (line 245)
* grammar_rules; Flag:                   Lint flags.          (line  90)
* homoiconic:                            Glossary.            (line 249)
* hook object:                           Glossary.            (line 257)
* hook predicate:                        Glossary.            (line 267)
* hook; Flag:                            Other flags.         (line  99)
* hot patching:                          Glossary.            (line 273)
* identity:                              Glossary.            (line 281)
* if/1; Directive:                       Conditional compilation directives<2>.
                                                              (line   8)
* ignore/1; Built-in method:             Examples<120>.       (line  19)
* implements_protocol/2-3; Built-in predicate: Examples<60>.  (line  19)
* imports_category/2-3; Built-in predicate: Examples<63>.     (line  15)
* include/1; Directive:                  Examples<9>.         (line   9)
* info/1; Directive:                     Examples<23>.        (line  14)
* info/2; Directive:                     Examples<33>.        (line  18)
* inheritance:                           Glossary.            (line 290)
* initialization/1; Directive:           Examples<10>.        (line  22)
* instance:                              Glossary.            (line 300)
* instantiates_class/2-3; Built-in predicate: Examples<64>.   (line  18)
* instantiation:                         Glossary.            (line 306)
* instantiation_error/0; Built-in method: Examples<125>.      (line  20)
* interface:                             Glossary.            (line 313)
* lambda expression:                     Glossary.            (line 317)
* lambda free variable:                  Glossary.            (line 325)
* lambda parameter:                      Glossary.            (line 331)
* lambda_variables; Flag:                Lint flags.          (line 102)
* late binding:                          Glossary.            (line 338)
* left_recursion; Flag:                  Lint flags.          (line 179)
* library:                               Glossary.            (line 342)
* library alias:                         Glossary.            (line 347)
* library notation:                      Glossary.            (line 354)
* linter; Flag:                          Lint flags.          (line   6)
* loader file:                           Glossary.            (line 362)
* local predicate:                       Glossary.            (line 368)
* logtalk_compile/1; Built-in predicate: Compiling and loading source files.
                                                              (line   8)
* logtalk_compile/2; Built-in predicate: Examples<88>.        (line  26)
* logtalk_library_path/2; Built-in predicate: Examples<94>.   (line  20)
* logtalk_linter_hook/7; Built-in predicate: Linter.          (line   8)
* logtalk_load_context/2; Built-in predicate: Examples<95>.   (line  54)
* logtalk_load/1; Built-in predicate:    Examples<89>.        (line  26)
* logtalk_load/2; Built-in predicate:    Examples<90>.        (line  26)
* logtalk_make_target_action/1; Built-in predicate: Examples<93>.
                                                              (line  24)
* logtalk_make/0; Built-in predicate:    Examples<91>.        (line  26)
* logtalk_make/1; Built-in predicate:    Examples<92>.        (line  17)
* message:                               Glossary.            (line 377)
* message lookup:                        Glossary.            (line 383)
* message to self:                       Glossary.            (line 392)
* message_hook/4; Built-in method:       Examples<157>.       (line  21)
* message_prefix_file/6; Built-in method: Examples<159>.      (line  21)
* message_prefix_stream/4; Built-in method: Examples<158>.    (line  23)
* message_tokens//2; Built-in method:    Examples<156>.       (line  17)
* meta_non_terminal/1; Directive:        Examples<35>.        (line  23)
* meta_predicate/1; Directive:           Examples<34>.        (line  21)
* meta-argument:                         Glossary.            (line 398)
* meta-interpreter:                      Glossary.            (line 405)
* meta-predicate:                        Glossary.            (line 410)
* meta-variable:                         Glossary.            (line 416)
* metaclass:                             Glossary.            (line 421)
* method:                                Glossary.            (line 428)
* missing_directives; Flag:              Lint flags.          (line  63)
* mocking:                               Glossary.            (line 435)
* mode_non_terminal/2; Directive:        Examples<37>.        (line  20)
* mode/2; Directive:                     Examples<36>.        (line  15)
* module:                                Glossary.            (line 442)
* modules; Flag:                         Read-only flags.     (line  81)
* monitor:                               Glossary.            (line 450)
* multifile predicate:                   Glossary.            (line 457)
* multifile/1; Directive:                Examples<38>.        (line  14)
* naked meta-variable:                   Glossary.            (line 466)
* naming; Flag:                          Lint flags.          (line 136)
* object:                                Glossary.            (line 473)
* object database:                       Glossary.            (line 481)
* object_property/2; Built-in predicate: Examples<49>.        (line  22)
* object/1-5; Directive:                 Examples<24>.        (line  20)
* once/1; Built-in method:               Examples<121>.       (line  19)
* op/3; Directive:                       Examples<11>.        (line  30)
* optimize; Flag:                        Other flags.         (line  44)
* parameter:                             Glossary.            (line 485)
* parameter variable:                    Glossary.            (line 491)
* parameter/2; Built-in method:          Examples<106>.       (line  21)
* parametric category:                   Glossary.            (line 500)
* parametric entity:                     Glossary.            (line 504)
* parametric object:                     Glossary.            (line 515)
* parametric object proxy:               Glossary.            (line 519)
* parent:                                Glossary.            (line 525)
* permission_error/3; Built-in method:   Examples<131>.       (line  21)
* phrase//1; Built-in method:            Examples<147>.       (line  15)
* phrase/2; Built-in method:             Examples<148>.       (line  14)
* phrase/3; Built-in method:             Examples<149>.       (line  19)
* polymorphism:                          Glossary.            (line 529)
* portability; Flag:                     Lint flags.          (line  50)
* predicate:                             Glossary.            (line 544)
* predicate alias:                       Glossary.            (line 551)
* predicate calling context:             Glossary.            (line 561)
* predicate declaration:                 Glossary.            (line 567)
* predicate definition:                  Glossary.            (line 573)
* predicate definition context:          Glossary.            (line 579)
* predicate directive:                   Glossary.            (line 584)
* predicate execution context:           Glossary.            (line 589)
* predicate scope container:             Glossary.            (line 595)
* predicate scope directive:             Glossary.            (line 601)
* predicate shorthand:                   Glossary.            (line 606)
* predicate_property/2; Built-in method: Examples<112>.       (line  42)
* primary predicate declaration:         Glossary.            (line 617)
* print_message_token/4; Built-in method: Examples<161>.      (line  19)
* print_message_tokens/3; Built-in method: Examples<160>.     (line  21)
* print_message/3; Built-in method:      Message printing.    (line   8)
* private inheritance:                   Glossary.            (line 621)
* private predicate:                     Glossary.            (line 627)
* private/1; Directive:                  Examples<39>.        (line  16)
* profiler:                              Glossary.            (line 632)
* prolog_compatible_version; Flag:       Read-only flags.     (line  36)
* prolog_compiler; Flag:                 Backend Prolog compiler and loader flags.
                                                              (line  16)
* prolog_dialect; Flag:                  Read-only flags.     (line  22)
* prolog_loader; Flag:                   Backend Prolog compiler and loader flags.
                                                              (line  26)
* prolog_version; Flag:                  Read-only flags.     (line  28)
* protected inheritance:                 Glossary.            (line 636)
* protected predicate:                   Glossary.            (line 642)
* protected/1; Directive:                Examples<40>.        (line  19)
* protocol:                              Glossary.            (line 648)
* protocol_property/2; Built-in predicate: Examples<50>.      (line  25)
* protocol/1-2; Directive:               Examples<25>.        (line  35)
* prototype:                             Glossary.            (line 658)
* public inheritance:                    Glossary.            (line 666)
* public predicate:                      Glossary.            (line 672)
* public/1; Directive:                   Examples<41>.        (line  19)
* question_hook/6; Built-in method:      Examples<163>.       (line  19)
* question_prompt_stream/4; Built-in method: Examples<164>.   (line  21)
* redefined_built_ins; Flag:             Lint flags.          (line 114)
* redefined_operators; Flag:             Lint flags.          (line 123)
* reflection:                            Message sending.     (line  27)
* relative_to; Flag:                     Other flags.         (line  93)
* reload; Flag:                          Other flags.         (line  82)
* repeat/0; Built-in method:             Examples<104>.       (line  15)
* report; Flag:                          Other flags.         (line  21)
* representation_error/1; Built-in method: Examples<132>.     (line  21)
* resource_error/1; Built-in method:     Examples<134>.       (line  21)
* retract/1; Built-in method:            Examples<117>.       (line  21)
* retractall/1; Built-in method:         Examples<118>.       (line  21)
* scratch directory:                     Glossary.            (line 676)
* scratch_directory; Flag:               Other flags.         (line   6)
* self:                                  Glossary.            (line 681)
* self/1; Built-in method:               Examples<107>.       (line  42)
* sender:                                Glossary.            (line 685)
* sender/1; Built-in method:             Examples<108>.       (line  20)
* set_logtalk_flag/2; Built-in predicate: Examples<97>.       (line  15)
* set_logtalk_flag/2; Directive:         Examples<12>.        (line  61)
* setof/3; Built-in method:              Examples<141>.       (line  20)
* settings file:                         Glossary.            (line 692)
* settings_file; Flag:                   Read-only flags.     (line  10)
* singleton method:                      Glossary.            (line 699)
* singleton_variables; Flag:             Lint flags.          (line 131)
* source file:                           Glossary.            (line 705)
* source file directive:                 Glossary.            (line 714)
* source_data; Flag:                     Other flags.         (line  61)
* specialization:                        Glossary.            (line 719)
* specializes_class/2-3; Built-in predicate: Examples<65>.    (line  20)
* static binding:                        Glossary.            (line 724)
* static entity:                         Glossary.            (line 734)
* steadfastness:                         Glossary.            (line 738)
* steadfastness; Flag:                   Lint flags.          (line  42)
* structural reflection:                 Reflection.          (line  13)
* subclass:                              Glossary.            (line 746)
* super call:                            Glossary.            (line 752)
* superclass:                            Glossary.            (line 760)
* suspicious_calls; Flag:                Lint flags.          (line 108)
* synchronized predicate:                Glossary.            (line 766)
* synchronized/1; Directive:             Examples<42>.        (line  19)
* syntax_error/1; Built-in method:       Examples<135>.       (line  21)
* system_error/0; Built-in method:       Examples<136>.       (line  19)
* tabling; Flag:                         Read-only flags.     (line  61)
* tail_recursive; Flag:                  Lint flags.          (line 186)
* template method:                       Glossary.            (line 772)
* term_expansion/2; Built-in method:     Examples<151>.       (line  15)
* term-expansion:                        Glossary.            (line 776)
* test dialect:                          Glossary.            (line 786)
* test outcome:                          Glossary.            (line 792)
* tester file:                           Glossary.            (line 798)
* this:                                  Glossary.            (line 803)
* this/1; Built-in method:               Examples<109>.       (line  20)
* threaded engine:                       Glossary.            (line 811)
* threaded_call/1-2; Built-in predicate: Examples<70>.        (line  18)
* threaded_cancel/1; Built-in predicate: Examples<75>.        (line  21)
* threaded_engine_create/3; Built-in predicate: Multi-threading engines.
                                                              (line   8)
* threaded_engine_destroy/1; Built-in predicate: Examples<79>.
                                                              (line  17)
* threaded_engine_fetch/1; Built-in predicate: Examples<86>.  (line  15)
* threaded_engine_next_reified/2; Built-in predicate: Examples<83>.
                                                              (line  16)
* threaded_engine_next/2; Built-in predicate: Examples<82>.   (line  19)
* threaded_engine_post/2; Built-in predicate: Examples<85>.   (line  16)
* threaded_engine_self/1; Built-in predicate: Examples<81>.   (line  22)
* threaded_engine_yield/1; Built-in predicate: Examples<84>.  (line  16)
* threaded_engine/1; Built-in predicate: Examples<80>.        (line  22)
* threaded_exit/1-2; Built-in predicate: Examples<73>.        (line  21)
* threaded_ignore/1; Built-in predicate: Examples<72>.        (line  21)
* threaded_notify/1; Built-in predicate: Examples<77>.        (line  15)
* threaded_once/1-2; Built-in predicate: Examples<71>.        (line  21)
* threaded_peek/1-2; Built-in predicate: Examples<74>.        (line  21)
* threaded_wait/1; Built-in predicate:   Examples<76>.        (line  16)
* threaded/0; Directive:                 Examples<26>.        (line  20)
* threaded/1; Built-in predicate:        Multi-threading.     (line   8)
* threads; Flag:                         Read-only flags.     (line  74)
* throw/1; Built-in method:              Examples<124>.       (line  20)
* top-level interpreter shorthand:       Glossary.            (line 819)
* transparent-box view:                  Structural reflection.
                                                              (line  11)
* trivial_goal_fails; Flag:              Lint flags.          (line  77)
* true/0; Built-in method:               Examples<101>.       (line  15)
* type_error/2; Built-in method:         Examples<127>.       (line  22)
* undefined_predicates; Flag:            Lint flags.          (line  34)
* underscore_variables; Flag:            Backend Prolog compiler and loader flags.
                                                              (line   6)
* unicode; Flag:                         Read-only flags.     (line  45)
* unknown_entities; Flag:                Lint flags.          (line  16)
* unknown_predicates; Flag:              Lint flags.          (line  24)
* ununinstantiation_error/1; Built-in method: Examples<126>.  (line  22)
* use_module/1; Directive:               Examples<28>.        (line  33)
* use_module/2; Directive:               Examples<44>.        (line  68)
* uses/1; Directive:                     Examples<27>.        (line  14)
* uses/2; Directive:                     Examples<43>.        (line  18)
* version_data; Flag:                    Version flags.       (line   6)
* visible predicate:                     Glossary.            (line 826)


Tag Table:
Node: Top474
Ref: index doc712
Ref: 0712
Node: User Manual119533
Ref: userman/index doc119641
Ref: 1119641
Ref: userman/index the-logtalk-handbook119641
Ref: 2119641
Ref: userman/index user-manual119641
Ref: 3119641
Node: Declarative object-oriented programming120168
Ref: userman/declarative doc120297
Ref: 4120297
Ref: userman/declarative declarative-declarative120297
Ref: 5120297
Ref: userman/declarative declarative-object-oriented-programming120297
Ref: 6120297
Node: Main features124148
Ref: userman/features doc124298
Ref: 9124298
Ref: userman/features features-features124298
Ref: a124298
Ref: userman/features main-features124298
Ref: b124298
Node: Integration of logic and object-oriented programming126244
Ref: userman/features features-logic126434
Ref: c126434
Ref: userman/features integration-of-logic-and-object-oriented-programming126434
Ref: d126434
Node: Integration of event-driven and object-oriented programming127485
Ref: userman/features features-events127723
Ref: e127723
Ref: userman/features integration-of-event-driven-and-object-oriented-programming127723
Ref: f127723
Node: Support for component-based programming128995
Ref: userman/features features-categories129231
Ref: 15129231
Ref: userman/features support-for-component-based-programming129231
Ref: 16129231
Node: Support for both prototype and class-based systems130064
Ref: userman/features features-both130280
Ref: 17130280
Ref: userman/features support-for-both-prototype-and-class-based-systems130280
Ref: 18130280
Node: Support for multiple object hierarchies131289
Ref: userman/features features-multiple131513
Ref: 1a131513
Ref: userman/features support-for-multiple-object-hierarchies131513
Ref: 1b131513
Node: Separation between interface and implementation132334
Ref: userman/features features-interface132548
Ref: 1f132548
Ref: userman/features separation-between-interface-and-implementation132548
Ref: 20132548
Node: Private protected and public inheritance133048
Ref: userman/features features-inheritance133269
Ref: 21133269
Ref: userman/features private-protected-and-public-inheritance133269
Ref: 22133269
Node: Private protected and public object predicates133615
Ref: userman/features features-predicates133807
Ref: 24133807
Ref: userman/features private-protected-and-public-object-predicates133807
Ref: 25133807
Node: Parametric objects134299
Ref: userman/features features-parametric134497
Ref: 26134497
Ref: userman/features parametric-objects134497
Ref: 27134497
Node: High level multi-threading programming support135241
Ref: userman/features features-threading135414
Ref: 2b135414
Ref: userman/features high-level-multi-threading-programming-support135414
Ref: 2c135414
Node: Smooth learning curve135970
Ref: userman/features features-learning136184
Ref: 2d136184
Ref: userman/features smooth-learning-curve136184
Ref: 2e136184
Node: Compatibility with most Prolog systems and the ISO standard136404
Ref: userman/features compatibility-with-most-prolog-systems-and-the-iso-standard136583
Ref: 2f136583
Ref: userman/features features-compatibility136583
Ref: 30136583
Node: Performance136958
Ref: userman/features features-performance137129
Ref: 32137129
Ref: userman/features performance137129
Ref: 33137129
Node: Logtalk scope138447
Ref: userman/features features-scope138550
Ref: 39138550
Ref: userman/features logtalk-scope138550
Ref: 3a138550
Node: Nomenclature141223
Ref: userman/nomenclature doc141342
Ref: 3b141342
Ref: userman/nomenclature nomenclature141342
Ref: 3c141342
Ref: userman/nomenclature nomenclature-nomenclature141342
Ref: 3d141342
Node: Prolog nomenclature143040
Ref: userman/nomenclature nomenclature-prolog143159
Ref: 40143159
Ref: userman/nomenclature prolog-nomenclature143159
Ref: 41143159
Node: Smalltalk nomenclature150183
Ref: userman/nomenclature nomenclature-smalltalk150327
Ref: 5a150327
Ref: userman/nomenclature smalltalk-nomenclature150327
Ref: 5b150327
Node: C++ nomenclature155598
Ref: userman/nomenclature c-nomenclature155740
Ref: 5e155740
Ref: userman/nomenclature nomenclature-cpp155740
Ref: 5f155740
Node: Java nomenclature158992
Ref: userman/nomenclature java-nomenclature159131
Ref: 6b159131
Ref: userman/nomenclature nomenclature-java159131
Ref: 6c159131
Node: Python nomenclature164106
Ref: userman/nomenclature nomenclature-python164220
Ref: 75164220
Ref: userman/nomenclature python-nomenclature164220
Ref: 76164220
Node: Messages168300
Ref: userman/messages doc168413
Ref: 77168413
Ref: userman/messages messages168413
Ref: 78168413
Ref: userman/messages messages-messages168413
Ref: 79168413
Node: Operators used in message-sending170111
Ref: userman/messages messages-operators170248
Ref: 7a170248
Ref: userman/messages operators-used-in-message-sending170248
Ref: 7b170248
Node: Sending a message to an object170803
Ref: userman/messages messages-sending170982
Ref: 7c170982
Ref: userman/messages sending-a-message-to-an-object170982
Ref: 7d170982
Node: Delegating a message to an object171510
Ref: userman/messages delegating-a-message-to-an-object171681
Ref: 7f171681
Ref: userman/messages messages-delegating171681
Ref: 80171681
Node: Sending a message to self172239
Ref: userman/messages sending-a-message-to-self172392
Ref: 82172392
Node: Broadcasting173158
Ref: userman/messages broadcasting173319
Ref: 83173319
Ref: userman/messages messages-broadcasting173319
Ref: 84173319
Node: Calling imported and inherited predicates174198
Ref: userman/messages calling-imported-and-inherited-predicates174370
Ref: 85174370
Ref: userman/messages messages-super174370
Ref: 86174370
Node: Message sending and event generation175542
Ref: userman/messages message-sending-and-event-generation175733
Ref: 87175733
Ref: userman/messages messages-events175733
Ref: 88175733
Node: Sending a message from a module177434
Ref: userman/messages messages-from-module177611
Ref: 8a177611
Ref: userman/messages sending-a-message-from-a-module177611
Ref: 8b177611
Node: Message sending performance178612
Ref: userman/messages message-sending-performance178744
Ref: 8d178744
Ref: userman/messages messages-performance178744
Ref: 8e178744
Node: Objects178912
Ref: userman/objects doc179022
Ref: 8f179022
Ref: userman/objects objects179022
Ref: 90179022
Ref: userman/objects objects-objects179022
Ref: 91179022
Ref: Objects-Footnote-1179997
Ref: Objects-Footnote-2180035
Node: Objects prototypes classes and instances180079
Ref: userman/objects objects-prototypes-classes-and-instances180213
Ref: 92180213
Ref: userman/objects objects-roles180213
Ref: 93180213
Node: Prototypes181845
Ref: userman/objects objects-prototypes181968
Ref: 94181968
Ref: userman/objects prototypes181968
Ref: 95181968
Node: Classes182587
Ref: userman/objects classes182710
Ref: 96182710
Ref: userman/objects objects-classes182710
Ref: 97182710
Node: Defining a new object183267
Ref: userman/objects defining-a-new-object183431
Ref: 98183431
Ref: userman/objects objects-defining183431
Ref: 99183431
Node: Parametric objects<2>189285
Ref: userman/objects objects-parametric189432
Ref: 66189432
Ref: userman/objects parametric-objects189432
Ref: 9f189432
Node: Accessing object parameters190288
Ref: userman/objects accessing-object-parameters190427
Ref: a0190427
Node: Parametric object proxies192710
Ref: userman/objects parametric-object-proxies192849
Ref: a3192849
Node: Finding defined objects194372
Ref: userman/objects finding-defined-objects194530
Ref: a4194530
Ref: userman/objects objects-finding194530
Ref: a5194530
Node: Creating a new object at runtime194959
Ref: userman/objects creating-a-new-object-at-runtime195125
Ref: a7195125
Ref: userman/objects objects-creating195125
Ref: a8195125
Node: Abolishing an existing object196383
Ref: userman/objects abolishing-an-existing-object196543
Ref: a9196543
Ref: userman/objects objects-abolishing196543
Ref: aa196543
Node: Object directives196843
Ref: userman/objects object-directives196991
Ref: ab196991
Ref: userman/objects objects-directives196991
Ref: ac196991
Node: Object initialization197372
Ref: userman/objects object-initialization197491
Ref: ad197491
Ref: userman/objects objects-initialization197491
Ref: ae197491
Node: Dynamic objects198713
Ref: userman/objects dynamic-objects198861
Ref: af198861
Ref: userman/objects objects-dynamic198861
Ref: b0198861
Node: Object documentation199587
Ref: userman/objects object-documentation199742
Ref: b2199742
Ref: userman/objects objects-documentation199742
Ref: b3199742
Node: Loading files into an object199972
Ref: userman/objects loading-files-into-an-object200136
Ref: b6200136
Ref: userman/objects objects-include200136
Ref: b7200136
Node: Declaring object aliases200883
Ref: userman/objects declaring-object-aliases201018
Ref: b9201018
Ref: userman/objects objects-object-aliases201018
Ref: ba201018
Node: Object relationships201432
Ref: userman/objects object-relationships201568
Ref: bb201568
Ref: userman/objects objects-relationships201568
Ref: bc201568
Node: Object properties203668
Ref: userman/objects object-properties203803
Ref: c4203803
Ref: userman/objects objects-properties203803
Ref: c5203803
Node: Built-in objects212624
Ref: userman/objects built-in-objects212767
Ref: cd212767
Ref: userman/objects objects-built-in212767
Ref: ce212767
Node: The built-in pseudo-object user212980
Ref: userman/objects objects-user213120
Ref: cf213120
Ref: userman/objects the-built-in-pseudo-object-user213120
Ref: d0213120
Ref: The built-in pseudo-object user-Footnote-1214110
Node: The built-in object logtalk214148
Ref: userman/objects objects-logtalk214288
Ref: d1214288
Ref: userman/objects the-built-in-object-logtalk214288
Ref: d2214288
Ref: The built-in object logtalk-Footnote-1214806
Node: Multi-threading applications214850
Ref: userman/objects multi-threading-applications214967
Ref: d6214967
Node: Protocols215265
Ref: userman/protocols doc215377
Ref: d7215377
Ref: userman/protocols protocols215377
Ref: d8215377
Ref: userman/protocols protocols-protocols215377
Ref: d9215377
Ref: Protocols-Footnote-1216339
Ref: Protocols-Footnote-2216389
Ref: Protocols-Footnote-3216437
Node: Defining a new protocol216487
Ref: userman/protocols defining-a-new-protocol216610
Ref: da216610
Ref: userman/protocols protocols-defining216610
Ref: db216610
Node: Finding defined protocols218699
Ref: userman/protocols finding-defined-protocols218865
Ref: de218865
Ref: userman/protocols protocols-finding218865
Ref: df218865
Node: Creating a new protocol at runtime219233
Ref: userman/protocols creating-a-new-protocol-at-runtime219407
Ref: e1219407
Ref: userman/protocols protocols-creating219407
Ref: e2219407
Node: Abolishing an existing protocol220453
Ref: userman/protocols abolishing-an-existing-protocol220621
Ref: e4220621
Ref: userman/protocols protocols-abolishing220621
Ref: e5220621
Node: Protocol directives220935
Ref: userman/protocols protocol-directives221091
Ref: e7221091
Node: Dynamic protocols221316
Ref: userman/protocols dynamic-protocols221440
Ref: e8221440
Ref: userman/protocols protocols-dynamic221440
Ref: e9221440
Node: Protocol documentation222083
Ref: userman/protocols protocol-documentation222245
Ref: ea222245
Ref: userman/protocols protocols-documentation222245
Ref: eb222245
Node: Loading files into a protocol222480
Ref: userman/protocols loading-files-into-a-protocol222616
Ref: ec222616
Ref: userman/protocols protocols-include222616
Ref: ed222616
Node: Protocol relationships222865
Ref: userman/protocols protocol-relationships223009
Ref: ee223009
Ref: userman/protocols protocols-relationships223009
Ref: ef223009
Node: Protocol properties224044
Ref: userman/protocols protocol-properties224191
Ref: f2224191
Ref: userman/protocols protocols-properties224191
Ref: f3224191
Node: Implementing protocols226703
Ref: userman/protocols implementing-protocols226846
Ref: f6226846
Ref: userman/protocols protocols-implementing226846
Ref: f7226846
Node: Built-in protocols227838
Ref: userman/protocols built-in-protocols227993
Ref: f8227993
Ref: userman/protocols protocols-built-in227993
Ref: f9227993
Node: The built-in protocol expanding228256
Ref: userman/protocols protocols-expanding228403
Ref: fa228403
Ref: userman/protocols the-built-in-protocol-expanding228403
Ref: fb228403
Ref: The built-in protocol expanding-Footnote-1228725
Node: The built-in protocol monitoring228773
Ref: userman/protocols protocols-monitoring228961
Ref: ff228961
Ref: userman/protocols the-built-in-protocol-monitoring228961
Ref: 100228961
Ref: The built-in protocol monitoring-Footnote-1229287
Node: The built-in protocol forwarding229337
Ref: userman/protocols protocols-forwarding229485
Ref: 103229485
Ref: userman/protocols the-built-in-protocol-forwarding229485
Ref: 104229485
Ref: The built-in protocol forwarding-Footnote-1229895
Node: Multi-threading applications<2>229945
Ref: userman/protocols multi-threading-applications230069
Ref: 106230069
Node: Categories230371
Ref: userman/categories doc230486
Ref: 107230486
Ref: userman/categories categories230486
Ref: 108230486
Ref: userman/categories categories-categories230486
Ref: 109230486
Ref: Categories-Footnote-1231992
Node: Defining a new category232048
Ref: userman/categories categories-defining232159
Ref: 10c232159
Ref: userman/categories defining-a-new-category232159
Ref: 10d232159
Node: Hot patching237570
Ref: userman/categories categories-patching237716
Ref: 110237716
Ref: userman/categories hot-patching237716
Ref: 111237716
Node: Finding defined categories241260
Ref: userman/categories categories-finding241417
Ref: 116241417
Ref: userman/categories finding-defined-categories241417
Ref: 117241417
Node: Creating a new category at runtime241808
Ref: userman/categories categories-creating241984
Ref: 118241984
Ref: userman/categories creating-a-new-category-at-runtime241984
Ref: 119241984
Node: Abolishing an existing category243235
Ref: userman/categories abolishing-an-existing-category243404
Ref: 11b243404
Ref: userman/categories categories-abolishing243404
Ref: 11c243404
Node: Category directives243720
Ref: userman/categories categories-directives243877
Ref: 11d243877
Ref: userman/categories category-directives243877
Ref: 11e243877
Node: Dynamic categories244248
Ref: userman/categories categories-dynamic244373
Ref: 11f244373
Ref: userman/categories dynamic-categories244373
Ref: 120244373
Node: Category documentation245031
Ref: userman/categories categories-documentation245194
Ref: 121245194
Ref: userman/categories category-documentation245194
Ref: 122245194
Node: Loading files into a category245429
Ref: userman/categories categories-include245601
Ref: 123245601
Ref: userman/categories loading-files-into-a-category245601
Ref: 124245601
Node: Declaring object aliases<2>245850
Ref: userman/categories categories-object-aliases245991
Ref: 125245991
Ref: userman/categories declaring-object-aliases245991
Ref: 126245991
Node: Category relationships246324
Ref: userman/categories categories-relationships246469
Ref: 127246469
Ref: userman/categories category-relationships246469
Ref: 128246469
Node: Category properties248115
Ref: userman/categories categories-properties248261
Ref: 12a248261
Ref: userman/categories category-properties248261
Ref: 12b248261
Node: Importing categories256222
Ref: userman/categories categories-importing256373
Ref: 12d256373
Ref: userman/categories importing-categories256373
Ref: 12e256373
Node: Calling category predicates257199
Ref: userman/categories calling-category-predicates257352
Ref: 12f257352
Ref: userman/categories categories-predicates257352
Ref: 130257352
Node: Parametric categories259146
Ref: userman/categories categories-parametric259298
Ref: 131259298
Ref: userman/categories parametric-categories259298
Ref: 132259298
Node: Built-in categories260519
Ref: userman/categories built-in-categories260675
Ref: 133260675
Ref: userman/categories categories-built-in260675
Ref: 134260675
Node: The built-in category core_messages260863
Ref: userman/categories categories-core-messages260974
Ref: 135260974
Ref: userman/categories the-built-in-category-core-messages260974
Ref: 136260974
Ref: The built-in category core_messages-Footnote-1261297
Node: Multi-threading applications<3>261353
Ref: userman/categories multi-threading-applications261479
Ref: 137261479
Node: Predicates261781
Ref: userman/predicates doc261898
Ref: 138261898
Ref: userman/predicates predicates261898
Ref: 139261898
Ref: userman/predicates predicates-predicates261898
Ref: 13a261898
Node: Reserved predicate names262692
Ref: userman/predicates predicates-reserved262812
Ref: 13b262812
Ref: userman/predicates reserved-predicate-names262812
Ref: 13c262812
Ref: Reserved predicate names-Footnote-1263487
Ref: Reserved predicate names-Footnote-2263535
Ref: Reserved predicate names-Footnote-3263585
Node: Declaring predicates263635
Ref: userman/predicates declaring-predicates263783
Ref: 13d263783
Ref: userman/predicates predicates-declaring263783
Ref: 13e263783
Node: Scope directives264894
Ref: userman/predicates predicates-scope265010
Ref: 13f265010
Ref: userman/predicates scope-directives265010
Ref: 140265010
Node: Mode directive268099
Ref: userman/predicates mode-directive268248
Ref: 147268248
Ref: userman/predicates predicates-mode268248
Ref: 148268248
Ref: userman/predicates predicates-mode-instantiation268644
Ref: 14b268644
Ref: userman/predicates predicates-mode-number-of-proofs270709
Ref: 14d270709
Node: Meta-predicate directive274750
Ref: userman/predicates meta-predicate-directive274906
Ref: 14e274906
Ref: userman/predicates predicates-meta274906
Ref: 65274906
Node: Discontiguous directive278853
Ref: userman/predicates discontiguous-directive279012
Ref: 155279012
Ref: userman/predicates predicates-discontiguous279012
Ref: 156279012
Node: Dynamic directive279711
Ref: userman/predicates dynamic-directive279864
Ref: 158279864
Ref: userman/predicates predicates-dynamic279864
Ref: 159279864
Node: Operator directive281098
Ref: userman/predicates operator-directive281242
Ref: 15b281242
Ref: userman/predicates predicates-op281242
Ref: 15c281242
Node: Uses directive282794
Ref: userman/predicates predicates-uses282936
Ref: 15f282936
Ref: userman/predicates uses-directive282936
Ref: 160282936
Node: Alias directive286784
Ref: userman/predicates alias-directive286929
Ref: 163286929
Ref: userman/predicates predicates-alias286929
Ref: 164286929
Node: Documenting directive291075
Ref: userman/predicates documenting-directive291225
Ref: 166291225
Ref: userman/predicates predicates-info291225
Ref: 167291225
Node: Multifile directive291546
Ref: userman/predicates multifile-directive291702
Ref: 169291702
Ref: userman/predicates predicates-multifile291702
Ref: 16a291702
Node: Coinductive directive295696
Ref: userman/predicates coinductive-directive295853
Ref: 16e295853
Ref: userman/predicates predicates-coinductive295853
Ref: 16f295853
Node: Synchronized directive296356
Ref: userman/predicates predicates-synchronized296485
Ref: 173296485
Ref: userman/predicates synchronized-directive296485
Ref: 174296485
Node: Defining predicates296825
Ref: userman/predicates defining-predicates296978
Ref: 177296978
Ref: userman/predicates predicates-defining296978
Ref: 178296978
Node: Object predicates297165
Ref: userman/predicates object-predicates297286
Ref: 179297286
Ref: userman/predicates predicates-objects297286
Ref: 17a297286
Node: Category predicates298462
Ref: userman/predicates category-predicates298607
Ref: 17b298607
Ref: userman/predicates predicates-categories298607
Ref: 17c298607
Node: Meta-predicates300399
Ref: userman/predicates meta-predicates300545
Ref: 17e300545
Ref: userman/predicates predicates-metadef300545
Ref: 17f300545
Node: Lambda expressions303684
Ref: userman/predicates lambda-expressions303841
Ref: 184303841
Ref: userman/predicates predicates-lambdas303841
Ref: 162303841
Ref: Lambda expressions-Footnote-1310437
Node: Redefining built-in predicates310491
Ref: userman/predicates predicates-redefining310624
Ref: 187310624
Ref: userman/predicates redefining-built-in-predicates310624
Ref: 188310624
Node: Definite clause grammar rules312968
Ref: userman/predicates definite-clause-grammar-rules313117
Ref: 18c313117
Ref: userman/predicates predicates-dcgs313117
Ref: 18d313117
Node: Built-in methods320915
Ref: userman/predicates built-in-methods321065
Ref: 192321065
Ref: userman/predicates predicates-methods321065
Ref: 193321065
Node: Logic and control methods321815
Ref: userman/predicates logic-and-control-methods321947
Ref: 194321947
Ref: userman/predicates predicates-logic321947
Ref: 195321947
Node: Execution context methods322409
Ref: userman/predicates execution-context-methods322585
Ref: 19b322585
Ref: userman/predicates predicates-context322585
Ref: 19c322585
Node: Error handling and throwing methods327034
Ref: userman/predicates error-handling-and-throwing-methods327201
Ref: 19f327201
Ref: userman/predicates predicates-errors327201
Ref: 1a0327201
Node: Database methods327994
Ref: userman/predicates database-methods328153
Ref: 1ae328153
Ref: userman/predicates predicates-database328153
Ref: 1af328153
Node: Meta-call methods329556
Ref: userman/predicates meta-call-methods329701
Ref: 1b9329701
Ref: userman/predicates predicates-metacalls329701
Ref: 1ba329701
Node: All solutions methods330154
Ref: userman/predicates all-solutions-methods330301
Ref: 1bd330301
Ref: userman/predicates predicates-solutions330301
Ref: 1be330301
Node: Reflection methods330672
Ref: userman/predicates predicates-reflection330859
Ref: 1c4330859
Ref: userman/predicates reflection-methods330859
Ref: 1c5330859
Node: Definite clause grammar parsing methods and non-terminals332090
Ref: userman/predicates definite-clause-grammar-parsing-methods-and-non-terminals332247
Ref: 1c6332247
Ref: userman/predicates predicates-parsing332247
Ref: 1c7332247
Node: Predicate properties333049
Ref: userman/predicates predicate-properties333197
Ref: 1cb333197
Ref: userman/predicates predicates-properties333197
Ref: 1cc333197
Node: Finding declared predicates338702
Ref: userman/predicates finding-declared-predicates338859
Ref: 1cd338859
Ref: userman/predicates predicates-finding338859
Ref: 1ce338859
Node: Calling Prolog predicates339751
Ref: userman/predicates calling-prolog-predicates339924
Ref: 1cf339924
Ref: userman/predicates predicates-prolog339924
Ref: 3e339924
Node: Calling Prolog built-in predicates341004
Ref: userman/predicates calling-prolog-built-in-predicates341181
Ref: 1d0341181
Node: Calling Prolog non-standard built-in meta-predicates343141
Ref: userman/predicates calling-prolog-non-standard-built-in-meta-predicates343360
Ref: 1d2343360
Ref: userman/predicates predicates-prolog-meta343360
Ref: 1d3343360
Node: Calling Prolog foreign predicates344596
Ref: userman/predicates calling-prolog-foreign-predicates344825
Ref: 1d4344825
Ref: userman/predicates predicates-prolog-foreign344825
Ref: 1d5344825
Node: Calling Prolog user-defined plain predicates346099
Ref: userman/predicates calling-prolog-user-defined-plain-predicates346308
Ref: 1d6346308
Ref: userman/predicates predicates-prolog-user346308
Ref: 1d7346308
Node: Calling Prolog module predicates347399
Ref: userman/predicates calling-prolog-module-predicates347612
Ref: 1d8347612
Ref: userman/predicates predicates-prolog-module347612
Ref: 1d9347612
Node: Calling Prolog module meta-predicates351156
Ref: userman/predicates calling-prolog-module-meta-predicates351316
Ref: 1da351316
Ref: userman/predicates predicates-prolog-module-meta-predicates351316
Ref: 1db351316
Node: Defining Prolog multifile predicates354100
Ref: userman/predicates defining-prolog-multifile-predicates354288
Ref: 1dc354288
Ref: userman/predicates predicates-prolog-multifile354288
Ref: 1dd354288
Node: Asserting and retracting Prolog predicates355469
Ref: userman/predicates asserting-and-retracting-prolog-predicates355623
Ref: 1de355623
Ref: userman/predicates predicates-prolog-dynamic355623
Ref: 1df355623
Node: Inheritance357468
Ref: userman/inheritance doc357599
Ref: 1e0357599
Ref: userman/inheritance inheritance357599
Ref: 1e1357599
Ref: userman/inheritance inheritance-inheritance357599
Ref: 8357599
Node: Protocol inheritance359607
Ref: userman/inheritance inheritance-protocol359730
Ref: 1e2359730
Ref: userman/inheritance protocol-inheritance359730
Ref: 1e3359730
Node: Lookup order for prototype hierarchies360208
Ref: userman/inheritance inheritance-protocol-prototype360366
Ref: 1e5360366
Ref: userman/inheritance lookup-order-for-prototype-hierarchies360366
Ref: 1e6360366
Node: Lookup order for class hierarchies360938
Ref: userman/inheritance inheritance-protocol-class361096
Ref: 1e7361096
Ref: userman/inheritance lookup-order-for-class-hierarchies361096
Ref: 1e8361096
Node: Implementation inheritance361686
Ref: userman/inheritance implementation-inheritance361858
Ref: 1e9361858
Ref: userman/inheritance inheritance-implementation361858
Ref: 1ea361858
Node: Lookup order for prototype hierarchies<2>362581
Ref: userman/inheritance id1362751
Ref: 1eb362751
Ref: userman/inheritance inheritance-implementation-prototype362751
Ref: 1ec362751
Node: Lookup order for class hierarchies<2>363038
Ref: userman/inheritance id2363259
Ref: 1ed363259
Ref: userman/inheritance inheritance-implementation-class363259
Ref: 1ee363259
Node: Redefining inherited predicate definitions363757
Ref: userman/inheritance inheritance-implementation-redefinition363981
Ref: 1ef363981
Ref: userman/inheritance redefining-inherited-predicate-definitions363981
Ref: 1f0363981
Node: Specializing inherited predicate definitions365006
Ref: userman/inheritance inheritance-specialization365243
Ref: 1f1365243
Ref: userman/inheritance specializing-inherited-predicate-definitions365243
Ref: 1f2365243
Node: Union of inherited and local predicate definitions366059
Ref: userman/inheritance inheritance-union366300
Ref: 1f3366300
Ref: userman/inheritance union-of-inherited-and-local-predicate-definitions366300
Ref: 1f4366300
Node: Selective inheritance of predicate definitions367201
Ref: userman/inheritance inheritance-selective367389
Ref: 1f5367389
Ref: userman/inheritance selective-inheritance-of-predicate-definitions367389
Ref: 1f6367389
Node: Public protected and private inheritance368220
Ref: userman/inheritance inheritance-scope368392
Ref: 9e368392
Ref: userman/inheritance public-protected-and-private-inheritance368392
Ref: 1f7368392
Node: Multiple inheritance369689
Ref: userman/inheritance inheritance-multiple369874
Ref: 1f8369874
Ref: userman/inheritance multiple-inheritance369874
Ref: 1f9369874
Node: Composition versus multiple inheritance370763
Ref: userman/inheritance composition-versus-multiple-inheritance370899
Ref: 1fa370899
Ref: userman/inheritance inheritance-composition370899
Ref: 1fb370899
Node: Event-driven programming372605
Ref: userman/events doc372753
Ref: 200372753
Ref: userman/events event-driven-programming372753
Ref: 201372753
Ref: userman/events events-events372753
Ref: 6d372753
Node: Definitions374561
Ref: userman/events definitions374678
Ref: 204374678
Ref: userman/events events-definitions374678
Ref: 205374678
Node: Event374905
Ref: userman/events event374994
Ref: 206374994
Ref: userman/events events-event374994
Ref: 207374994
Node: Monitor376861
Ref: userman/events events-monitor376950
Ref: 208376950
Ref: userman/events monitor376950
Ref: 209376950
Ref: Monitor-Footnote-1378452
Node: Event generation378502
Ref: userman/events event-generation378660
Ref: 20a378660
Ref: userman/events events-generation378660
Ref: 20b378660
Node: Communicating events to monitors379311
Ref: userman/events communicating-events-to-monitors379478
Ref: 20c379478
Ref: userman/events events-communicating379478
Ref: 20d379478
Ref: Communicating events to monitors-Footnote-1380008
Node: Performance concerns380058
Ref: userman/events events-performance380226
Ref: 20e380226
Ref: userman/events performance-concerns380226
Ref: 20f380226
Node: Monitor semantics381133
Ref: userman/events events-semantics381297
Ref: 210381297
Ref: userman/events monitor-semantics381297
Ref: 211381297
Node: Activation order of monitors382191
Ref: userman/events activation-order-of-monitors382349
Ref: 212382349
Ref: userman/events events-order382349
Ref: 213382349
Node: Event handling383519
Ref: userman/events event-handling383651
Ref: 214383651
Ref: userman/events events-handling383651
Ref: 215383651
Node: Defining new events384118
Ref: userman/events defining-new-events384242
Ref: 216384242
Ref: userman/events events-defining384242
Ref: 217384242
Node: Abolishing defined events384644
Ref: userman/events abolishing-defined-events384799
Ref: 219384799
Ref: userman/events events-abolishing384799
Ref: 21a384799
Node: Finding defined events385123
Ref: userman/events events-finding385282
Ref: 21c385282
Ref: userman/events finding-defined-events385282
Ref: 21d385282
Node: Defining event handlers385672
Ref: userman/events defining-event-handlers385797
Ref: 21f385797
Ref: userman/events events-handlers385797
Ref: 220385797
Ref: Defining event handlers-Footnote-1388916
Ref: Defining event handlers-Footnote-2388966
Node: Multi-threading programming389016
Ref: userman/threads doc389167
Ref: 221389167
Ref: userman/threads multi-threading-programming389167
Ref: 222389167
Ref: userman/threads threads-threads389167
Ref: 73389167
Node: Enabling multi-threading support390350
Ref: userman/threads enabling-multi-threading-support390521
Ref: 223390521
Ref: userman/threads threads-enabling390521
Ref: 224390521
Node: Enabling objects to make multi-threading calls390804
Ref: userman/threads enabling-objects-to-make-multi-threading-calls391019
Ref: 226391019
Ref: userman/threads threads-directive391019
Ref: 227391019
Node: Multi-threading built-in predicates391251
Ref: userman/threads multi-threading-built-in-predicates391460
Ref: 229391460
Ref: userman/threads threads-predicates391460
Ref: 22a391460
Node: Proving goals concurrently using threads392223
Ref: userman/threads proving-goals-concurrently-using-threads392406
Ref: 22c392406
Ref: userman/threads threads-threaded392406
Ref: 22d392406
Node: Proving goals asynchronously using threads394767
Ref: userman/threads proving-goals-asynchronously-using-threads394950
Ref: 22e394950
Ref: userman/threads threads-call394950
Ref: 22f394950
Node: One-way asynchronous calls399437
Ref: userman/threads one-way-asynchronous-calls399646
Ref: 235399646
Ref: userman/threads threads-ignore399646
Ref: 236399646
Node: Asynchronous calls and synchronized predicates400320
Ref: userman/threads asynchronous-calls-and-synchronized-predicates400537
Ref: 238400537
Ref: userman/threads threads-synchronized-predicates400537
Ref: 176400537
Node: Synchronizing threads through notifications403947
Ref: userman/threads synchronizing-threads-through-notifications404154
Ref: 239404154
Ref: userman/threads threads-notifications404154
Ref: 23a404154
Node: Threaded engines405571
Ref: userman/threads threaded-engines405759
Ref: 23d405759
Ref: userman/threads threads-engines405759
Ref: 23e405759
Node: Multi-threading performance409634
Ref: userman/threads multi-threading-performance409770
Ref: 246409770
Ref: userman/threads threads-performance409770
Ref: 247409770
Node: Error handling410825
Ref: userman/errors doc410962
Ref: 248410962
Ref: userman/errors error-handling410962
Ref: 249410962
Ref: userman/errors errors-errors410962
Ref: 24a410962
Ref: Error handling-Footnote-1412185
Node: Raising Exceptions412249
Ref: userman/errors raising-exceptions412360
Ref: 24b412360
Node: Type-checking412918
Ref: userman/errors type-checking413052
Ref: 24d413052
Ref: Type-checking-Footnote-1415691
Ref: Type-checking-Footnote-2415729
Ref: Type-checking-Footnote-3415775
Ref: Type-checking-Footnote-4415821
Node: Expected terms415867
Ref: userman/errors expected-terms416011
Ref: 24e416011
Node: Compiler warnings and errors416300
Ref: userman/errors compiler-warnings-and-errors416445
Ref: 250416445
Node: Unknown entities417884
Ref: userman/errors errors-unknown418013
Ref: 252418013
Ref: userman/errors unknown-entities418013
Ref: 253418013
Node: Singleton variables418398
Ref: userman/errors errors-singletons418578
Ref: 254418578
Ref: userman/errors singleton-variables418578
Ref: 255418578
Node: Redefinition of Prolog built-in predicates419014
Ref: userman/errors errors-prolog419221
Ref: 256419221
Ref: userman/errors redefinition-of-prolog-built-in-predicates419221
Ref: 257419221
Node: Redefinition of Logtalk built-in predicates419751
Ref: userman/errors errors-redefinition-predicates419979
Ref: 258419979
Ref: userman/errors redefinition-of-logtalk-built-in-predicates419979
Ref: 259419979
Node: Redefinition of Logtalk built-in methods420298
Ref: userman/errors errors-redefinition-methods420518
Ref: 25a420518
Ref: userman/errors redefinition-of-logtalk-built-in-methods420518
Ref: 25b420518
Node: Misspell calls of local predicates420810
Ref: userman/errors errors-misspell421007
Ref: 25c421007
Ref: userman/errors misspell-calls-of-local-predicates421007
Ref: 25d421007
Node: Portability warnings421348
Ref: userman/errors errors-portability421524
Ref: 25e421524
Ref: userman/errors portability-warnings421524
Ref: 25f421524
Node: Deprecated elements421884
Ref: userman/errors deprecated-elements422044
Ref: 260422044
Ref: userman/errors errors-deprecated422044
Ref: 261422044
Node: Missing directives422339
Ref: userman/errors errors-missing-directives422500
Ref: 262422500
Ref: userman/errors missing-directives422500
Ref: 263422500
Node: Duplicated directives422673
Ref: userman/errors duplicated-directives422833
Ref: 264422833
Ref: userman/errors errors-duplicated-directives422833
Ref: 265422833
Node: Duplicated clauses423155
Ref: userman/errors duplicated-clauses423332
Ref: 266423332
Ref: userman/errors errors-duplicated-clauses423332
Ref: 267423332
Node: Goals that are always true or false423536
Ref: userman/errors errors-always-true-or-false-goals423705
Ref: 268423705
Ref: userman/errors goals-that-are-always-true-or-false423705
Ref: 269423705
Node: Trivial fails423974
Ref: userman/errors errors-trivial-fails424141
Ref: 26a424141
Ref: userman/errors trivial-fails424141
Ref: 26b424141
Node: Suspicious calls424284
Ref: userman/errors errors-suspicious-calls424432
Ref: 26c424432
Ref: userman/errors suspicious-calls424432
Ref: 26d424432
Node: Lambda variables424779
Ref: userman/errors errors-lambda-variables424986
Ref: 26e424986
Ref: userman/errors lambda-variables424986
Ref: 26f424986
Node: Redefinition of predicates declared in uses/2 or use_module/2 directives425364
Ref: userman/errors errors-predicate-redefinition425580
Ref: 272425580
Ref: userman/errors redefinition-of-predicates-declared-in-uses-2-or-use-module-2-directives425580
Ref: 273425580
Node: Other warnings and errors425922
Ref: userman/errors errors-others426113
Ref: 274426113
Ref: userman/errors other-warnings-and-errors426113
Ref: 275426113
Node: Runtime errors426369
Ref: userman/errors errors-runtime426491
Ref: 276426491
Ref: userman/errors runtime-errors426491
Ref: 277426491
Node: Logtalk built-in predicates426869
Ref: userman/errors errors-predicates427000
Ref: 278427000
Ref: userman/errors logtalk-built-in-predicates427000
Ref: 279427000
Node: Logtalk built-in methods427200
Ref: userman/errors errors-methods427355
Ref: 27a427355
Ref: userman/errors logtalk-built-in-methods427355
Ref: 27b427355
Node: Message sending427545
Ref: userman/errors errors-sending427664
Ref: 27c427664
Ref: userman/errors message-sending427664
Ref: 27d427664
Ref: Message sending-Footnote-1428581
Node: Reflection428631
Ref: userman/reflection doc428773
Ref: 27e428773
Ref: userman/reflection reflection428773
Ref: 27f428773
Ref: userman/reflection reflection-reflection428773
Ref: 48428773
Node: Structural reflection429238
Ref: userman/reflection reflection-structural429356
Ref: 281429356
Ref: userman/reflection structural-reflection429356
Ref: 282429356
Node: Transparent-box view429704
Ref: userman/reflection transparent-box-view429825
Ref: 283429825
Ref: Transparent-box view-Footnote-1431250
Node: Black-box view431294
Ref: userman/reflection black-box-view431415
Ref: 286431415
Node: Behavioral reflection432141
Ref: userman/reflection behavioral-reflection432259
Ref: 287432259
Ref: userman/reflection reflection-behavioral432259
Ref: 288432259
Ref: Behavioral reflection-Footnote-1432872
Node: Writing and running applications432916
Ref: userman/programming doc433082
Ref: 28a433082
Ref: userman/programming programming-programming433082
Ref: 28b433082
Ref: userman/programming writing-and-running-applications433082
Ref: 28c433082
Node: Starting Logtalk434803
Ref: userman/programming programming-starting434951
Ref: 28e434951
Ref: userman/programming starting-logtalk434951
Ref: 28f434951
Node: Running parallel Logtalk processes436038
Ref: userman/programming programming-parallel-processes436207
Ref: 290436207
Ref: userman/programming running-parallel-logtalk-processes436207
Ref: 291436207
Node: Source files438383
Ref: userman/programming programming-source-files438555
Ref: 294438555
Ref: userman/programming source-files438555
Ref: 295438555
Ref: Source files-Footnote-1441581
Ref: Source files-Footnote-2441658
Node: Naming conventions441735
Ref: userman/programming naming-conventions441856
Ref: 296441856
Node: Source file text encoding442448
Ref: userman/programming source-file-text-encoding442569
Ref: 297442569
Node: Multi-pass compiler442916
Ref: userman/programming multi-pass-compiler443093
Ref: 29a443093
Ref: userman/programming programming-multi-pass-compiler443093
Ref: 29b443093
Node: Compiling and loading your applications445371
Ref: userman/programming compiling-and-loading-your-applications445573
Ref: 29c445573
Ref: userman/programming programming-compiling445573
Ref: 29d445573
Node: Compiler errors warnings and comments448575
Ref: userman/programming compiler-errors-warnings-and-comments448770
Ref: 2a1448770
Ref: userman/programming programming-errors-warnings-comments448770
Ref: 2a2448770
Node: Loader files449679
Ref: userman/programming loader-files449860
Ref: 2a3449860
Ref: userman/programming programming-loaders449860
Ref: 2a4449860
Node: Libraries of source files453419
Ref: userman/programming libraries-of-source-files453577
Ref: 2a5453577
Ref: userman/programming programming-libraries453577
Ref: 2a6453577
Node: Settings files456448
Ref: userman/programming programming-settings456609
Ref: 2a9456609
Ref: userman/programming settings-files456609
Ref: 2aa456609
Node: Compiler linter459358
Ref: userman/programming compiler-linter459508
Ref: 2ad459508
Ref: userman/programming programming-linter459508
Ref: 2ae459508
Node: Compiler flags460280
Ref: userman/programming compiler-flags460438
Ref: 2b1460438
Ref: userman/programming programming-flags460438
Ref: 251460438
Node: Read-only flags463036
Ref: userman/programming read-only-flags463144
Ref: 2b4463144
Ref: userman/programming flag-settings-file463354
Ref: 2ab463354
Ref: userman/programming flag-prolog-dialect464025
Ref: 2ac464025
Ref: userman/programming flag-prolog-version464223
Ref: 2b5464223
Ref: userman/programming flag-prolog-compatible-version464565
Ref: 2b6464565
Ref: userman/programming flag-unicode464963
Ref: 2b7464963
Ref: userman/programming flag-encoding-directive465236
Ref: 299465236
Ref: userman/programming flag-tabling465668
Ref: 2b8465668
Ref: userman/programming flag-engines465860
Ref: 2b9465860
Ref: userman/programming flag-threads466120
Ref: 225466120
Ref: userman/programming flag-modules466402
Ref: 2bb466402
Ref: userman/programming flag-coinduction466698
Ref: 172466698
Node: Version flags466978
Ref: userman/programming version-flags467105
Ref: 2bc467105
Ref: userman/programming flag-version-data467154
Ref: 2bd467154
Node: Lint flags467671
Ref: userman/programming lint-flags467818
Ref: 2be467818
Ref: userman/programming programming-flags-lint467818
Ref: 2b0467818
Ref: userman/programming flag-linter467861
Ref: 2bf467861
Ref: userman/programming flag-unknown-entities468389
Ref: 2c0468389
Ref: userman/programming flag-unknown-predicates468782
Ref: 2c1468782
Ref: userman/programming flag-undefined-predicates469258
Ref: 2c2469258
Ref: userman/programming flag-steadfastness469616
Ref: 2c3469616
Ref: userman/programming flag-portability469948
Ref: 1d1469948
Ref: userman/programming flag-deprecated470268
Ref: 2c5470268
Ref: userman/programming flag-missing-directives470429
Ref: 2c6470429
Ref: userman/programming flag-duplicated-directives470628
Ref: 2c7470628
Ref: userman/programming flag-trivial-goal-fails470961
Ref: 2c8470961
Ref: userman/programming flag-always-true-or-false-goals471206
Ref: 2c9471206
Ref: userman/programming flag-grammar-rules471510
Ref: 190471510
Ref: userman/programming flag-arithmetic-expressions471710
Ref: 2ca471710
Ref: userman/programming flag-lambda-variables471927
Ref: 186471927
Ref: userman/programming flag-suspicious-calls472131
Ref: 2cb472131
Ref: userman/programming flag-redefined-built-ins472328
Ref: 189472328
Ref: userman/programming flag-redefined-operators472748
Ref: 2cc472748
Ref: userman/programming flag-singleton-variables473117
Ref: 2cd473117
Ref: userman/programming flag-naming473303
Ref: 2ce473303
Ref: userman/programming flag-duplicated-clauses473779
Ref: 2cf473779
Ref: userman/programming flag-disjunctions474211
Ref: 2d0474211
Ref: userman/programming flag-conditionals474548
Ref: 2d1474548
Ref: userman/programming flag-catchall-catch474882
Ref: 2d2474882
Ref: userman/programming flag-left-recursion475215
Ref: 2d3475215
Ref: userman/programming flag-tail-recursive475511
Ref: 2d4475511
Ref: userman/programming flag-encodings475960
Ref: 2d5475960
Ref: userman/programming flag-general476125
Ref: 2d6476125
Node: Optional features compilation flags476305
Ref: userman/programming optional-features-compilation-flags476479
Ref: 2d7476479
Ref: userman/programming flag-complements476572
Ref: 112476572
Ref: userman/programming flag-dynamic-declarations477260
Ref: 2d8477260
Ref: userman/programming flag-events477865
Ref: 89477865
Ref: userman/programming flag-context-switching-calls478421
Ref: 2d9478421
Node: Backend Prolog compiler and loader flags478749
Ref: userman/programming backend-prolog-compiler-and-loader-flags478924
Ref: 2da478924
Ref: userman/programming flag-underscore-variables479027
Ref: 2db479027
Ref: userman/programming flag-prolog-compiler479517
Ref: 2dc479517
Ref: userman/programming flag-prolog-loader480019
Ref: 2dd480019
Node: Other flags480363
Ref: userman/programming other-flags480521
Ref: 2de480521
Ref: userman/programming flag-scratch-directory480566
Ref: 2df480566
Ref: userman/programming flag-report481452
Ref: 2e0481452
Ref: userman/programming flag-code-prefix481830
Ref: 2e1481830
Ref: userman/programming flag-optimize482698
Ref: 8c482698
Ref: userman/programming flag-source-data483646
Ref: cc483646
Ref: userman/programming flag-debug484294
Ref: 2e2484294
Ref: userman/programming flag-reload484717
Ref: 2e3484717
Ref: userman/programming flag-relative-to485274
Ref: 2e4485274
Ref: userman/programming flag-hook485457
Ref: fe485457
Ref: userman/programming flag-clean485882
Ref: 292485882
Ref: Other flags-Footnote-1486914
Ref: Other flags-Footnote-2486952
Node: User-defined flags487000
Ref: userman/programming user-defined-flags487109
Ref: 2e5487109
Node: Reloading source files487273
Ref: userman/programming programming-reloading487432
Ref: 2e7487432
Ref: userman/programming reloading-source-files487432
Ref: 2e8487432
Node: Batch processing489921
Ref: userman/programming batch-processing490088
Ref: 2e9490088
Ref: userman/programming programming-batch490088
Ref: 2ea490088
Node: Optimizing performance490475
Ref: userman/programming optimizing-performance490641
Ref: 2eb490641
Ref: userman/programming programming-performance490641
Ref: 2ec490641
Node: Portable applications492692
Ref: userman/programming portable-applications492865
Ref: 2ee492865
Ref: userman/programming programming-portability492865
Ref: 2ef492865
Node: Conditional compilation493805
Ref: userman/programming conditional-compilation493978
Ref: 2f0493978
Ref: userman/programming programming-cc493978
Ref: 2f1493978
Node: Avoiding common errors494349
Ref: userman/programming avoiding-common-errors494524
Ref: 2f6494524
Ref: userman/programming programming-errors494524
Ref: 2f7494524
Node: Coding style guidelines496242
Ref: userman/programming coding-style-guidelines496385
Ref: 2f8496385
Ref: userman/programming programming-style496385
Ref: 2f9496385
Node: Printing messages and asking questions497184
Ref: userman/printing doc497363
Ref: 2fa497363
Ref: userman/printing printing-messages-and-asking-questions497363
Ref: 2fb497363
Ref: userman/printing printing-printing497363
Ref: 18b497363
Ref: Printing messages and asking questions-Footnote-1500689
Node: Printing messages500733
Ref: userman/printing id1500874
Ref: 2fd500874
Ref: userman/printing printing-messages500874
Ref: d3500874
Node: Message tokenization504593
Ref: userman/printing message-tokenization504756
Ref: 2ff504756
Node: Meta-messages507071
Ref: userman/printing meta-messages507261
Ref: 301507261
Ref: Meta-messages-Footnote-1507699
Node: Defining message prefixes and output streams507743
Ref: userman/printing defining-message-prefixes-and-output-streams507955
Ref: 303507955
Node: Defining message prefixes and output files509648
Ref: userman/printing defining-message-prefixes-and-output-files509868
Ref: 305509868
Node: Intercepting messages511506
Ref: userman/printing id2511698
Ref: 308511698
Ref: userman/printing intercepting-messages511698
Ref: 309511698
Node: Asking questions513348
Ref: userman/printing asking-questions513520
Ref: 30a513520
Ref: userman/printing printing-questions513520
Ref: d4513520
Node: Intercepting questions516388
Ref: userman/printing intercepting-questions516570
Ref: 30c516570
Node: Multi-threading applications<4>518096
Ref: userman/printing multi-threading-applications518253
Ref: 30e518253
Node: Term and goal expansion518536
Ref: userman/expansion doc518694
Ref: 30f518694
Ref: userman/expansion expansion-expansion518694
Ref: cb518694
Ref: userman/expansion term-and-goal-expansion518694
Ref: 310518694
Node: Defining expansions520153
Ref: userman/expansion defining-expansions520284
Ref: 311520284
Ref: Defining expansions-Footnote-1524094
Node: Expanding grammar rules524142
Ref: userman/expansion expanding-grammar-rules524302
Ref: 313524302
Node: Bypassing expansions524903
Ref: userman/expansion bypassing-expansions525056
Ref: 314525056
Node: Hook objects525466
Ref: userman/expansion hook-objects525641
Ref: 315525641
Ref: Hook objects-Footnote-1528064
Node: Virtual source file terms and loading context528112
Ref: userman/expansion virtual-source-file-terms-and-loading-context528302
Ref: 316528302
Node: Default compiler expansion workflow530278
Ref: userman/expansion default-compiler-expansion-workflow530488
Ref: 318530488
Node: User defined expansion workflows531234
Ref: userman/expansion user-defined-expansion-workflows531430
Ref: 319531430
Ref: User defined expansion workflows-Footnote-1533149
Ref: User defined expansion workflows-Footnote-2533205
Ref: User defined expansion workflows-Footnote-3533251
Ref: User defined expansion workflows-Footnote-4533321
Node: Using Prolog defined expansions533377
Ref: userman/expansion using-prolog-defined-expansions533558
Ref: 31c533558
Ref: Using Prolog defined expansions-Footnote-1535311
Node: Debugging expansions535377
Ref: userman/expansion debugging-expansions535517
Ref: 31d535517
Node: Documenting538540
Ref: userman/documenting doc538669
Ref: 320538669
Ref: userman/documenting documenting538669
Ref: 321538669
Ref: userman/documenting documenting-documenting538669
Ref: b5538669
Node: Entity documenting directives540169
Ref: userman/documenting documenting-entity540307
Ref: 323540307
Ref: userman/documenting entity-documenting-directives540307
Ref: 324540307
Ref: Entity documenting directives-Footnote-1543371
Ref: Entity documenting directives-Footnote-2543398
Node: Predicate documenting directives543433
Ref: userman/documenting documenting-predicate543601
Ref: 325543601
Ref: userman/documenting predicate-documenting-directives543601
Ref: 326543601
Node: Describing predicates547288
Ref: userman/documenting describing-predicates547459
Ref: 327547459
Ref: userman/documenting documenting-descriptions547459
Ref: 328547459
Node: Documenting predicate exceptions548718
Ref: userman/documenting documenting-exceptions548897
Ref: 329548897
Ref: userman/documenting documenting-predicate-exceptions548897
Ref: 32a548897
Node: Processing and viewing documenting files551703
Ref: userman/documenting documenting-processing551895
Ref: 32b551895
Ref: userman/documenting processing-and-viewing-documenting-files551895
Ref: 32c551895
Node: Inline formatting in comments text555646
Ref: userman/documenting documenting-formatting555814
Ref: 32e555814
Ref: userman/documenting inline-formatting-in-comments-text555814
Ref: 32f555814
Node: Diagrams556856
Ref: userman/documenting diagrams556975
Ref: 330556975
Node: Debugging557609
Ref: userman/debugging doc557729
Ref: 331557729
Ref: userman/debugging debugging557729
Ref: 332557729
Ref: userman/debugging debugging-debugging557729
Ref: 47557729
Node: Compiling source files in debug mode559517
Ref: userman/debugging compiling-source-files-in-debug-mode559647
Ref: 333559647
Ref: userman/debugging debugging-debug-mode559647
Ref: 334559647
Node: Procedure box model561577
Ref: userman/debugging debugging-box-model561739
Ref: 335561739
Ref: userman/debugging procedure-box-model561739
Ref: 336561739
Node: Activating the debugger563673
Ref: userman/debugging activating-the-debugger563819
Ref: 337563819
Ref: Activating the debugger-Footnote-1564358
Ref: Activating the debugger-Footnote-2564414
Ref: Activating the debugger-Footnote-3564470
Node: Defining breakpoints564528
Ref: userman/debugging defining-breakpoints564674
Ref: 339564674
Node: Defining predicate and clause breakpoints566719
Ref: userman/debugging defining-predicate-and-clause-breakpoints566878
Ref: 33a566878
Node: Defining conditional breakpoints568234
Ref: userman/debugging defining-conditional-breakpoints568432
Ref: 33b568432
Node: Defining hit count breakpoints569642
Ref: userman/debugging defining-hit-count-breakpoints569829
Ref: 33c569829
Node: Defining triggered breakpoints570849
Ref: userman/debugging defining-triggered-breakpoints571032
Ref: 33d571032
Node: Defining context breakpoints571894
Ref: userman/debugging defining-context-breakpoints572071
Ref: 33e572071
Node: Removing all breakpoints573263
Ref: userman/debugging removing-all-breakpoints573401
Ref: 33f573401
Node: Defining log points573778
Ref: userman/debugging defining-log-points573926
Ref: 340573926
Node: Tracing program execution575824
Ref: userman/debugging programming-trace575979
Ref: 341575979
Ref: userman/debugging tracing-program-execution575979
Ref: 342575979
Node: Debugging using breakpoints578139
Ref: userman/debugging debugging-debug578293
Ref: 343578293
Ref: userman/debugging debugging-using-breakpoints578293
Ref: 344578293
Node: Debugging commands578975
Ref: userman/debugging debugging-commands579128
Ref: 345579128
Ref: userman/debugging id1579128
Ref: 346579128
Node: Customizing term writing582248
Ref: userman/debugging customizing-term-writing582397
Ref: 347582397
Ref: userman/debugging debugging-term-write582397
Ref: 348582397
Node: Term write depth582948
Ref: userman/debugging debugging-term-write-depth583073
Ref: 349583073
Ref: userman/debugging term-write-depth583073
Ref: 34a583073
Ref: Term write depth-Footnote-1584128
Ref: Term write depth-Footnote-2584194
Node: Custom term writing584264
Ref: userman/debugging custom-term-writing584389
Ref: 34b584389
Ref: userman/debugging debugging-custom-term-writing584389
Ref: 34c584389
Node: Context-switching calls585012
Ref: userman/debugging context-switching-calls585161
Ref: 34d585161
Ref: userman/debugging debugging-context585161
Ref: 34e585161
Node: Debugging messages587126
Ref: userman/debugging debugging-messages587299
Ref: 302587299
Ref: userman/debugging id2587299
Ref: 34f587299
Node: Meta-messages<2>587911
Ref: userman/debugging meta-messages588047
Ref: 350588047
Node: Selective printing of debug messages591172
Ref: userman/debugging selective-printing-of-debug-messages591308
Ref: 351591308
Node: Using the term-expansion mechanism for debugging592385
Ref: userman/debugging debugging-hooks592550
Ref: 354592550
Ref: userman/debugging using-the-term-expansion-mechanism-for-debugging592550
Ref: 355592550
Ref: Using the term-expansion mechanism for debugging-Footnote-1593148
Node: Ports profiling593208
Ref: userman/debugging debugging-ports-profiling593377
Ref: 356593377
Ref: userman/debugging ports-profiling593377
Ref: 357593377
Node: Debug and trace events593718
Ref: userman/debugging debug-and-trace-events593860
Ref: 359593860
Ref: userman/debugging debugging-events593860
Ref: d5593860
Ref: Debug and trace events-Footnote-1596389
Ref: Debug and trace events-Footnote-2596447
Ref: Debug and trace events-Footnote-3596507
Ref: Debug and trace events-Footnote-4596567
Ref: Debug and trace events-Footnote-5596636
Ref: Debug and trace events-Footnote-6596707
Node: Source-level debugger596765
Ref: userman/debugging debugging-source-level-debugger596883
Ref: 35a596883
Ref: userman/debugging source-level-debugger596883
Ref: 35b596883
Node: Performance<2>597275
Ref: userman/performance doc597402
Ref: 35c597402
Ref: userman/performance performance597402
Ref: 35d597402
Ref: userman/performance performance-performance597402
Ref: 38597402
Node: Source code compilation modes599053
Ref: userman/performance source-code-compilation-modes599191
Ref: 361599191
Node: Source code compilation order599925
Ref: userman/performance source-code-compilation-order600093
Ref: 362600093
Ref: Source code compilation order-Footnote-1600825
Ref: Source code compilation order-Footnote-2600902
Node: Local predicate calls600979
Ref: userman/performance local-predicate-calls601159
Ref: 363601159
Node: Calls to imported or inherited predicates601370
Ref: userman/performance calls-to-imported-or-inherited-predicates601547
Ref: 364601547
Node: Calls to module predicates601799
Ref: userman/performance calls-to-module-predicates601966
Ref: 365601966
Node: Messages<2>602190
Ref: userman/performance messages602363
Ref: 366602363
Node: Automatic expansion of built-in meta-predicates604996
Ref: userman/performance automatic-expansion-of-built-in-meta-predicates605151
Ref: 367605151
Node: Inlining605694
Ref: userman/performance inlining605885
Ref: 368605885
Node: Generated code simplification and optimizations606418
Ref: userman/performance generated-code-simplification-and-optimizations606588
Ref: 369606588
Node: Size of the generated code607199
Ref: userman/performance size-of-the-generated-code607380
Ref: 36b607380
Node: Circular references608550
Ref: userman/performance circular-references608703
Ref: 36c608703
Node: Debug mode overhead609139
Ref: userman/performance debug-mode-overhead609286
Ref: 36d609286
Ref: Debug mode overhead-Footnote-1610651
Ref: Debug mode overhead-Footnote-2610709
Node: Other considerations610769
Ref: userman/performance other-considerations610888
Ref: 36e610888
Ref: Other considerations-Footnote-1611502
Ref: Other considerations-Footnote-2611580
Ref: Other considerations-Footnote-3611663
Node: Installing Logtalk611708
Ref: userman/installing doc611858
Ref: 36f611858
Ref: userman/installing installing-installing611858
Ref: 370611858
Ref: userman/installing installing-logtalk611858
Ref: 371611858
Node: Hardware and software requirements613823
Ref: userman/installing hardware-and-software-requirements613959
Ref: 372613959
Ref: userman/installing installing-requirements613959
Ref: 373613959
Node: Computer and operating system614108
Ref: userman/installing computer-and-operating-system614252
Ref: 374614252
Ref: userman/installing installing-computer614252
Ref: 375614252
Node: Prolog compiler614459
Ref: userman/installing installing-compiler614603
Ref: 376614603
Ref: userman/installing prolog-compiler614603
Ref: 377614603
Node: Logtalk installers615885
Ref: userman/installing installing-installers616049
Ref: 378616049
Ref: userman/installing logtalk-installers616049
Ref: 379616049
Node: Source distribution616347
Ref: userman/installing installing-sources616498
Ref: 37a616498
Ref: userman/installing source-distribution616498
Ref: 37b616498
Node: Distribution overview617146
Ref: userman/installing distribution-overview617270
Ref: 37c617270
Ref: userman/installing installing-organization617270
Ref: 37d617270
Node: Adapter files621600
Ref: userman/installing adapter-files621720
Ref: 37e621720
Ref: userman/installing installing-adapters621720
Ref: 37f621720
Node: Compiler and runtime623212
Ref: userman/installing compiler-and-runtime623348
Ref: 380623348
Ref: userman/installing installing-runtime623348
Ref: 381623348
Node: Library623710
Ref: userman/installing installing-library623841
Ref: 382623841
Ref: userman/installing library623841
Ref: 383623841
Node: Examples624060
Ref: userman/installing examples624191
Ref: 384624191
Ref: userman/installing installing-examples624191
Ref: 385624191
Node: Logtalk source files624701
Ref: userman/installing installing-entities624816
Ref: 386624816
Ref: userman/installing logtalk-source-files624816
Ref: 387624816
Node: Prolog integration and migration625468
Ref: userman/migration doc625595
Ref: 388625595
Ref: userman/migration migration-migration625595
Ref: 389625595
Ref: userman/migration prolog-integration-and-migration625595
Ref: 38a625595
Node: Source files with both Prolog code and Logtalk code626617
Ref: userman/migration migration-hybrid626808
Ref: 38c626808
Ref: userman/migration source-files-with-both-prolog-code-and-logtalk-code626808
Ref: 38d626808
Node: Encapsulating plain Prolog code in objects627675
Ref: userman/migration encapsulating-plain-prolog-code-in-objects627913
Ref: 38e627913
Ref: userman/migration migration-encapsulating627913
Ref: 38f627913
Node: Prolog multifile predicates629924
Ref: userman/migration migration-multifile630050
Ref: 390630050
Ref: userman/migration prolog-multifile-predicates630050
Ref: 391630050
Node: Converting Prolog modules into objects631742
Ref: userman/migration converting-prolog-modules-into-objects631964
Ref: 393631964
Ref: userman/migration migration-converting631964
Ref: 394631964
Node: Compiling Prolog modules as objects636842
Ref: userman/migration compiling-prolog-modules-as-objects637079
Ref: 395637079
Ref: userman/migration migration-compiling637079
Ref: 396637079
Node: Supported module directives638988
Ref: userman/migration migration-compatibility639145
Ref: 397639145
Ref: userman/migration supported-module-directives639145
Ref: 398639145
Node: Unsupported module directives643219
Ref: userman/migration migration-unsupported-module-directives643425
Ref: 39a643425
Ref: userman/migration unsupported-module-directives643425
Ref: 39b643425
Node: Modules using a term-expansion mechanism644594
Ref: userman/migration migration-module-expansions644790
Ref: 39c644790
Ref: userman/migration modules-using-a-term-expansion-mechanism644790
Ref: 39d644790
Node: File search paths647003
Ref: userman/migration file-search-paths647161
Ref: 39f647161
Ref: userman/migration migration-file-search-paths647161
Ref: 3a0647161
Node: Dealing with proprietary Prolog directives and predicates647772
Ref: userman/migration dealing-with-proprietary-prolog-directives-and-predicates648006
Ref: 3a1648006
Ref: userman/migration migration-proprietary648006
Ref: 3a2648006
Node: Calling Prolog module predicates<2>650371
Ref: userman/migration calling-prolog-module-predicates650607
Ref: 3a3650607
Ref: userman/migration migration-calling650607
Ref: 3a4650607
Node: Loading converted Prolog applications653104
Ref: userman/migration loading-converted-prolog-applications653274
Ref: 3a5653274
Ref: userman/migration migration-loading653274
Ref: 3a6653274
Node: Reference Manual654737
Ref: refman/index doc654850
Ref: 3a7654850
Ref: refman/index reference-manual654850
Ref: 3a8654850
Node: Grammar655028
Ref: refman/grammar doc655135
Ref: 3a9655135
Ref: refman/grammar grammar655135
Ref: 3aa655135
Ref: refman/grammar grammar-grammar655135
Ref: 3ab655135
Node: Entities655783
Ref: refman/grammar entities655881
Ref: 3ac655881
Ref: refman/grammar grammar-entities655881
Ref: 3ad655881
Node: Object definition655982
Ref: refman/grammar grammar-object-definition656108
Ref: 3ae656108
Ref: refman/grammar object-definition656108
Ref: 3af656108
Node: Category definition656992
Ref: refman/grammar category-definition657129
Ref: 3b0657129
Ref: refman/grammar grammar-category-definition657129
Ref: 3b1657129
Node: Protocol definition657670
Ref: refman/grammar grammar-protocol-definition657806
Ref: 3b2657806
Ref: refman/grammar protocol-definition657806
Ref: 3b3657806
Node: Entity relations658128
Ref: refman/grammar entity-relations658263
Ref: 3b4658263
Ref: refman/grammar grammar-entity-relations658263
Ref: 3b5658263
Node: Implemented protocols659137
Ref: refman/grammar grammar-implemented-protocols659258
Ref: 3b6659258
Ref: refman/grammar implemented-protocols659258
Ref: 3b7659258
Node: Extended protocols659762
Ref: refman/grammar extended-protocols659911
Ref: 3b8659911
Ref: refman/grammar grammar-extended-protocols659911
Ref: 3b9659911
Node: Imported categories660376
Ref: refman/grammar grammar-imported-categories660520
Ref: 3ba660520
Ref: refman/grammar imported-categories660520
Ref: 3bb660520
Node: Extended objects660988
Ref: refman/grammar extended-objects661133
Ref: 3bc661133
Ref: refman/grammar grammar-extended-objects661133
Ref: 3bd661133
Node: Extended categories661568
Ref: refman/grammar extended-categories661714
Ref: 3be661714
Ref: refman/grammar grammar-extended-categories661714
Ref: 3bf661714
Node: Instantiated objects662182
Ref: refman/grammar grammar-instantiated-objects662331
Ref: 3c0662331
Ref: refman/grammar instantiated-objects662331
Ref: 3c1662331
Node: Specialized objects662818
Ref: refman/grammar grammar-specialized-objects662968
Ref: 3c2662968
Ref: refman/grammar specialized-objects662968
Ref: 3c3662968
Node: Complemented objects663442
Ref: refman/grammar complemented-objects663598
Ref: 3c4663598
Ref: refman/grammar grammar-complemented-objects663598
Ref: 3c5663598
Node: Entity and predicate scope663980
Ref: refman/grammar entity-and-predicate-scope664108
Ref: 3c6664108
Ref: refman/grammar grammar-scope664108
Ref: 3c7664108
Node: Entity identifiers664254
Ref: refman/grammar entity-identifiers664385
Ref: 3c8664385
Ref: refman/grammar grammar-entity-identifiers664385
Ref: 3c9664385
Node: Object identifiers664656
Ref: refman/grammar grammar-object-identifiers664778
Ref: 3ca664778
Ref: refman/grammar object-identifiers664778
Ref: 3cb664778
Node: Category identifiers664893
Ref: refman/grammar category-identifiers665044
Ref: 3cc665044
Ref: refman/grammar grammar-category-identifiers665044
Ref: 3cd665044
Node: Protocol identifiers665165
Ref: refman/grammar grammar-protocol-identifiers665316
Ref: 3ce665316
Ref: refman/grammar protocol-identifiers665316
Ref: 3cf665316
Node: Module identifiers665418
Ref: refman/grammar grammar-module-identifiers665540
Ref: 3d0665540
Ref: refman/grammar module-identifiers665540
Ref: 3d1665540
Node: Source files<2>665636
Ref: refman/grammar grammar-source-files665768
Ref: 3d2665768
Ref: refman/grammar source-files665768
Ref: 3d3665768
Node: Source file names665979
Ref: refman/grammar grammar-source-file-names666098
Ref: 3d4666098
Ref: refman/grammar source-file-names666098
Ref: 3d5666098
Node: Terms666327
Ref: refman/grammar grammar-terms666441
Ref: 3d6666441
Ref: refman/grammar terms666441
Ref: 3d7666441
Node: Object terms666512
Ref: refman/grammar grammar-object-terms666609
Ref: 3d8666609
Ref: refman/grammar object-terms666609
Ref: 3d9666609
Node: Category terms666739
Ref: refman/grammar category-terms666836
Ref: 3da666836
Ref: refman/grammar grammar-category-terms666836
Ref: 3db666836
Node: Directives666974
Ref: refman/grammar directives667088
Ref: 3dc667088
Ref: refman/grammar grammar-directives667088
Ref: 3dd667088
Node: Source file directives667363
Ref: refman/grammar grammar-source-file-directives667495
Ref: 3de667495
Ref: refman/grammar source-file-directives667495
Ref: 3df667495
Node: Conditional compilation directives667752
Ref: refman/grammar conditional-compilation-directives667913
Ref: 3e0667913
Ref: refman/grammar grammar-conditional-compilation-directives667913
Ref: 3e1667913
Node: Object directives<2>668155
Ref: refman/grammar grammar-object-directives668316
Ref: 3e2668316
Ref: refman/grammar object-directives668316
Ref: 3e3668316
Node: Category directives<2>668826
Ref: refman/grammar category-directives668975
Ref: 3e4668975
Ref: refman/grammar grammar-category-directives668975
Ref: 3e5668975
Node: Protocol directives<2>669421
Ref: refman/grammar grammar-protocol-directives669570
Ref: 3e6669570
Ref: refman/grammar protocol-directives669570
Ref: 3e7669570
Node: Predicate directives669922
Ref: refman/grammar grammar-predicate-directives670040
Ref: 3e8670040
Ref: refman/grammar predicate-directives670040
Ref: 3e9670040
Node: Clauses and goals680209
Ref: refman/grammar clauses-and-goals680339
Ref: 3ea680339
Ref: refman/grammar grammar-clauses680339
Ref: 3eb680339
Node: Lambda expressions<2>681490
Ref: refman/grammar grammar-lambdas681627
Ref: 185681627
Ref: refman/grammar lambda-expressions681627
Ref: 3ec681627
Node: Entity properties682095
Ref: refman/grammar entity-properties682238
Ref: 3ed682238
Ref: refman/grammar grammar-entity-properties682238
Ref: c8682238
Node: Predicate properties<2>689131
Ref: refman/grammar grammar-predicate-properties689270
Ref: 3ee689270
Ref: refman/grammar predicate-properties689270
Ref: 3ef689270
Node: Compiler flags<2>690622
Ref: refman/grammar compiler-flags690735
Ref: 3f0690735
Ref: refman/grammar grammar-compiler-flags690735
Ref: 3f1690735
Node: Control constructs690836
Ref: refman/control/index doc690965
Ref: 3f2690965
Ref: refman/control/index control-constructs690965
Ref: 3f3690965
Node: Message sending<2>691266
Ref: refman/control/message_sending doc691386
Ref: 3f4691386
Ref: refman/control/message_sending id1691386
Ref: 3f5691386
Ref: refman/control/message_sending message-sending691386
Ref: 360691386
Node: /2691490
Ref: refman/control/send_to_object_2 doc691578
Ref: 3f6691578
Ref: refman/control/send_to_object_2 control-send-to-object-2691578
Ref: 7e691578
Ref: refman/control/send_to_object_2 id1691578
Ref: 3f7691578
Node: Description691710
Ref: refman/control/send_to_object_2 description691815
Ref: 3f8691815
Node: Modes and number of proofs693485
Ref: refman/control/send_to_object_2 modes-and-number-of-proofs693605
Ref: 3fb693605
Node: Errors693779
Ref: refman/control/send_to_object_2 errors693899
Ref: 3fc693899
Node: Examples<2>695149
Ref: refman/control/send_to_object_2 examples695234
Ref: 3fd695234
Node: /1695448
Ref: refman/control/send_to_self_1 doc695536
Ref: 3fe695536
Ref: refman/control/send_to_self_1 control-send-to-self-1695536
Ref: 5c695536
Ref: refman/control/send_to_self_1 id1695536
Ref: 3ff695536
Node: Description<2>695723
Ref: refman/control/send_to_self_1 description695834
Ref: 400695834
Node: Modes and number of proofs<2>696962
Ref: refman/control/send_to_self_1 modes-and-number-of-proofs697091
Ref: 401697091
Node: Errors<2>697195
Ref: refman/control/send_to_self_1 errors697321
Ref: 402697321
Node: Examples<3>697834
Ref: refman/control/send_to_self_1 examples697922
Ref: 403697922
Node: Message delegation698136
Ref: refman/control/message_delegation doc698309
Ref: 404698309
Ref: refman/control/message_delegation id1698309
Ref: 405698309
Ref: refman/control/message_delegation message-delegation698309
Ref: 406698309
Node: []/1698400
Ref: refman/control/delegate_message_1 doc698479
Ref: 407698479
Ref: refman/control/delegate_message_1 control-delegate-message-1698479
Ref: 81698479
Ref: refman/control/delegate_message_1 id1698479
Ref: 408698479
Node: Description<3>698662
Ref: refman/control/delegate_message_1 description698775
Ref: 409698775
Node: Modes and number of proofs<3>699703
Ref: refman/control/delegate_message_1 modes-and-number-of-proofs699834
Ref: 40a699834
Node: Errors<3>700012
Ref: refman/control/delegate_message_1 errors700140
Ref: 40b700140
Node: Examples<4>701572
Ref: refman/control/delegate_message_1 examples701662
Ref: 40c701662
Node: Calling imported and inherited predicates<2>701904
Ref: refman/control/super_calls doc702085
Ref: 40d702085
Ref: refman/control/super_calls calling-imported-and-inherited-predicates702085
Ref: 40e702085
Ref: refman/control/super_calls super-calls702085
Ref: 40f702085
Node: ^^ /1702230
Ref: refman/control/call_super_1 doc702336
Ref: 410702336
Ref: refman/control/call_super_1 control-call-super-1702336
Ref: 5d702336
Ref: refman/control/call_super_1 id1702336
Ref: 411702336
Node: Description<4>702523
Ref: refman/control/call_super_1 description702637
Ref: 412702637
Node: Modes and number of proofs<4>704607
Ref: refman/control/call_super_1 modes-and-number-of-proofs704739
Ref: 413704739
Node: Errors<4>704843
Ref: refman/control/call_super_1 errors704972
Ref: 414704972
Node: Examples<5>705495
Ref: refman/control/call_super_1 examples705586
Ref: 415705586
Node: Calling predicates in this705829
Ref: refman/control/call_in_this doc706019
Ref: 416706019
Ref: refman/control/call_in_this call-in-this706019
Ref: 417706019
Ref: refman/control/call_in_this calling-predicates-in-this706019
Ref: 418706019
Node: @ /1706136
Ref: refman/control/call_in_this_1 doc706223
Ref: 419706223
Ref: refman/control/call_in_this_1 call-in-this-1706223
Ref: 113706223
Ref: refman/control/call_in_this_1 id1706223
Ref: 41a706223
Node: Description<5>706408
Ref: refman/control/call_in_this_1 description706521
Ref: 41b706521
Node: Modes and number of proofs<5>707185
Ref: refman/control/call_in_this_1 modes-and-number-of-proofs707316
Ref: 41c707316
Node: Errors<5>707420
Ref: refman/control/call_in_this_1 errors707548
Ref: 41d707548
Node: Examples<6>707729
Ref: refman/control/call_in_this_1 examples707819
Ref: 41e707819
Node: Calling external predicates708182
Ref: refman/control/external_calls doc708351
Ref: 41f708351
Ref: refman/control/external_calls calling-external-predicates708351
Ref: 420708351
Ref: refman/control/external_calls external-calls708351
Ref: 421708351
Node: {}/1708460
Ref: refman/control/external_call_1 doc708548
Ref: 422708548
Ref: refman/control/external_call_1 control-external-call-1708548
Ref: 191708548
Ref: refman/control/external_call_1 id1708548
Ref: 423708548
Node: Description<6>708731
Ref: refman/control/external_call_1 description708844
Ref: 424708844
Node: Modes and number of proofs<6>710345
Ref: refman/control/external_call_1 modes-and-number-of-proofs710476
Ref: 426710476
Node: Errors<6>710580
Ref: refman/control/external_call_1 errors710708
Ref: 427710708
Node: Examples<7>711278
Ref: refman/control/external_call_1 examples711368
Ref: 428711368
Node: Context switching calls711989
Ref: refman/control/context_switching_calls doc712123
Ref: 429712123
Ref: refman/control/context_switching_calls context-switching-calls712123
Ref: 42a712123
Ref: refman/control/context_switching_calls id1712123
Ref: 42b712123
Node: << /2712232
Ref: refman/control/context_switch_2 doc712317
Ref: 42c712317
Ref: refman/control/context_switch_2 control-context-switch-2712317
Ref: c7712317
Ref: refman/control/context_switch_2 id1712317
Ref: 42d712317
Node: Description<7>712504
Ref: refman/control/context_switch_2 description712618
Ref: 42e712618
Node: Modes and number of proofs<7>714161
Ref: refman/control/context_switch_2 modes-and-number-of-proofs714293
Ref: 42f714293
Node: Errors<7>714467
Ref: refman/control/context_switch_2 errors714596
Ref: 430714596
Node: Examples<8>715704
Ref: refman/control/context_switch_2 examples715795
Ref: 431715795
Node: Directives<2>715964
Ref: refman/directives/index doc716105
Ref: 432716105
Ref: refman/directives/index directives716105
Ref: 433716105
Node: Source file directives<2>716347
Ref: refman/directives/source_file_directives doc716488
Ref: 434716488
Ref: refman/directives/source_file_directives id1716488
Ref: 435716488
Ref: refman/directives/source_file_directives source-file-directives716488
Ref: 436716488
Node: encoding/1716652
Ref: refman/directives/encoding_1 doc716762
Ref: 437716762
Ref: refman/directives/encoding_1 directives-encoding-1716762
Ref: 298716762
Ref: refman/directives/encoding_1 encoding-1716762
Ref: 438716762
Node: Description<8>716898
Ref: refman/directives/encoding_1 description717006
Ref: 439717006
Ref: Description<8>-Footnote-1718479
Node: Template and modes718556
Ref: refman/directives/encoding_1 template-and-modes718684
Ref: 43a718684
Node: Examples<9>718761
Ref: refman/directives/encoding_1 examples718866
Ref: 43b718866
Node: include/1718942
Ref: refman/directives/include_1 doc719077
Ref: 43c719077
Ref: refman/directives/include_1 directives-include-1719077
Ref: b8719077
Ref: refman/directives/include_1 include-1719077
Ref: 43d719077
Node: Description<9>719234
Ref: refman/directives/include_1 description719344
Ref: 43e719344
Node: Template and modes<2>721693
Ref: refman/directives/include_1 template-and-modes721824
Ref: 43f721824
Node: Examples<10>721912
Ref: refman/directives/include_1 examples722020
Ref: 440722020
Node: initialization/1722626
Ref: refman/directives/initialization_1 doc722755
Ref: 441722755
Ref: refman/directives/initialization_1 directives-initialization-1722755
Ref: 42722755
Ref: refman/directives/initialization_1 initialization-1722755
Ref: 442722755
Node: Description<10>722927
Ref: refman/directives/initialization_1 description723045
Ref: 443723045
Node: Template and modes<3>724669
Ref: refman/directives/initialization_1 template-and-modes724808
Ref: 444724808
Node: Examples<11>724897
Ref: refman/directives/initialization_1 examples725012
Ref: 445725012
Node: op/3725592
Ref: refman/directives/op_3 doc725730
Ref: 446725730
Ref: refman/directives/op_3 directives-op-3725730
Ref: 15d725730
Ref: refman/directives/op_3 op-3725730
Ref: 447725730
Node: Description<11>725880
Ref: refman/directives/op_3 description725986
Ref: 448725986
Node: Template and modes<4>726437
Ref: refman/directives/op_3 template-and-modes726564
Ref: 449726564
Node: Examples<12>726676
Ref: refman/directives/op_3 examples726779
Ref: 44a726779
Node: set_logtalk_flag/2727859
Ref: refman/directives/set_logtalk_flag_2 doc727972
Ref: 44b727972
Ref: refman/directives/set_logtalk_flag_2 directives-set-logtalk-flag-2727972
Ref: 50727972
Ref: refman/directives/set_logtalk_flag_2 set-logtalk-flag-2727972
Ref: 44c727972
Node: Description<12>728171
Ref: refman/directives/set_logtalk_flag_2 description728291
Ref: 44d728291
Node: Template and modes<5>728838
Ref: refman/directives/set_logtalk_flag_2 template-and-modes728976
Ref: 44e728976
Node: Errors<8>729072
Ref: refman/directives/set_logtalk_flag_2 errors729207
Ref: 44f729207
Node: Examples<13>729706
Ref: refman/directives/set_logtalk_flag_2 examples729811
Ref: 450729811
Node: Conditional compilation directives<2>730382
Ref: refman/directives/conditional_compilation_directives doc730549
Ref: 451730549
Ref: refman/directives/conditional_compilation_directives conditional-compilation-directives730549
Ref: 18a730549
Ref: refman/directives/conditional_compilation_directives id1730549
Ref: 452730549
Node: if/1730698
Ref: refman/directives/if_1 doc730811
Ref: 453730811
Ref: refman/directives/if_1 directives-if-1730811
Ref: 2f2730811
Ref: refman/directives/if_1 if-1730811
Ref: 454730811
Node: Description<13>730959
Ref: refman/directives/if_1 description731065
Ref: 455731065
Node: Template and modes<6>732076
Ref: refman/directives/if_1 template-and-modes732203
Ref: 456732203
Node: Examples<14>732278
Ref: refman/directives/if_1 examples732381
Ref: 457732381
Node: elif/1733273
Ref: refman/directives/elif_1 doc733401
Ref: 458733401
Ref: refman/directives/elif_1 directives-elif-1733401
Ref: 2f3733401
Ref: refman/directives/elif_1 elif-1733401
Ref: 459733401
Node: Description<14>733553
Ref: refman/directives/elif_1 description733661
Ref: 45a733661
Node: Template and modes<7>734626
Ref: refman/directives/elif_1 template-and-modes734755
Ref: 45b734755
Node: Examples<15>734832
Ref: refman/directives/elif_1 examples734937
Ref: 45c734937
Node: else/0735290
Ref: refman/directives/else_0 doc735421
Ref: 45d735421
Ref: refman/directives/else_0 directives-else-0735421
Ref: 2f4735421
Ref: refman/directives/else_0 else-0735421
Ref: 45e735421
Node: Description<15>735573
Ref: refman/directives/else_0 description735681
Ref: 45f735681
Node: Template and modes<8>735936
Ref: refman/directives/else_0 template-and-modes736065
Ref: 460736065
Node: Examples<16>736133
Ref: refman/directives/else_0 examples736238
Ref: 461736238
Node: endif/0736842
Ref: refman/directives/endif_0 doc736958
Ref: 462736958
Ref: refman/directives/endif_0 directives-endif-0736958
Ref: 2f5736958
Ref: refman/directives/endif_0 endif-0736958
Ref: 463736958
Node: Description<16>737114
Ref: refman/directives/endif_0 description737223
Ref: 464737223
Node: Template and modes<9>737353
Ref: refman/directives/endif_0 template-and-modes737483
Ref: 465737483
Node: Examples<17>737552
Ref: refman/directives/endif_0 examples737658
Ref: 466737658
Node: Entity directives737878
Ref: refman/directives/entity_directives doc738043
Ref: 467738043
Ref: refman/directives/entity_directives entity-directives738043
Ref: 468738043
Ref: refman/directives/entity_directives id1738043
Ref: 469738043
Node: built_in/0738302
Ref: refman/directives/built_in_0 doc738407
Ref: 46a738407
Ref: refman/directives/built_in_0 built-in-0738407
Ref: 46b738407
Ref: refman/directives/built_in_0 directives-built-in-0738407
Ref: 46c738407
Node: Description<17>738568
Ref: refman/directives/built_in_0 description738681
Ref: 46d738681
Node: Template and modes<10>738961
Ref: refman/directives/built_in_0 template-and-modes739095
Ref: 46e739095
Node: Examples<18>739165
Ref: refman/directives/built_in_0 examples739275
Ref: 46f739275
Node: category/1-4739342
Ref: refman/directives/category_1_4 doc739465
Ref: 470739465
Ref: refman/directives/category_1_4 category-1-4739465
Ref: 471739465
Ref: refman/directives/category_1_4 directives-category-1-4739465
Ref: 10e739465
Node: Description<18>739630
Ref: refman/directives/category_1_4 description739745
Ref: 472739745
Node: Template and modes<11>740388
Ref: refman/directives/category_1_4 template-and-modes740524
Ref: 473740524
Node: Examples<19>741395
Ref: refman/directives/category_1_4 examples741507
Ref: 474741507
Node: dynamic/0741921
Ref: refman/directives/dynamic_0 doc742048
Ref: 475742048
Ref: refman/directives/dynamic_0 directives-dynamic-0742048
Ref: b1742048
Ref: refman/directives/dynamic_0 dynamic-0742048
Ref: 476742048
Node: Description<19>742207
Ref: refman/directives/dynamic_0 description742319
Ref: 477742319
Node: Template and modes<12>742951
Ref: refman/directives/dynamic_0 template-and-modes743084
Ref: 478743084
Node: Examples<20>743155
Ref: refman/directives/dynamic_0 examples743264
Ref: 479743264
Node: end_category/0743466
Ref: refman/directives/end_category_0 doc743593
Ref: 47a743593
Ref: refman/directives/end_category_0 directives-end-category-0743593
Ref: 10f743593
Ref: refman/directives/end_category_0 end-category-0743593
Ref: 47b743593
Node: Description<20>743764
Ref: refman/directives/end_category_0 description743881
Ref: 47c743881
Node: Template and modes<13>743971
Ref: refman/directives/end_category_0 template-and-modes744109
Ref: 47d744109
Node: Examples<21>744185
Ref: refman/directives/end_category_0 examples744299
Ref: 47e744299
Node: end_object/0744417
Ref: refman/directives/end_object_0 doc744549
Ref: 47f744549
Ref: refman/directives/end_object_0 directives-end-object-0744549
Ref: 9b744549
Ref: refman/directives/end_object_0 end-object-0744549
Ref: 480744549
Node: Description<21>744716
Ref: refman/directives/end_object_0 description744831
Ref: 481744831
Node: Template and modes<14>744917
Ref: refman/directives/end_object_0 template-and-modes745053
Ref: 482745053
Node: Examples<22>745127
Ref: refman/directives/end_object_0 examples745239
Ref: 483745239
Node: end_protocol/0745352
Ref: refman/directives/end_protocol_0 doc745476
Ref: 484745476
Ref: refman/directives/end_protocol_0 directives-end-protocol-0745476
Ref: dd745476
Ref: refman/directives/end_protocol_0 end-protocol-0745476
Ref: 485745476
Node: Description<22>745647
Ref: refman/directives/end_protocol_0 description745764
Ref: 486745764
Node: Template and modes<15>745854
Ref: refman/directives/end_protocol_0 template-and-modes745992
Ref: 487745992
Node: Examples<23>746068
Ref: refman/directives/end_protocol_0 examples746182
Ref: 488746182
Node: info/1746299
Ref: refman/directives/info_1 doc746421
Ref: 489746421
Ref: refman/directives/info_1 directives-info-1746421
Ref: b4746421
Ref: refman/directives/info_1 info-1746421
Ref: 48a746421
Node: Description<23>746576
Ref: refman/directives/info_1 description746685
Ref: 48b746685
Node: Template and modes<16>746998
Ref: refman/directives/info_1 template-and-modes747128
Ref: 48c747128
Node: Examples<24>747215
Ref: refman/directives/info_1 examples747321
Ref: 48d747321
Node: object/1-5747654
Ref: refman/directives/object_1_5 doc747774
Ref: 48e747774
Ref: refman/directives/object_1_5 directives-object-1-5747774
Ref: 9a747774
Ref: refman/directives/object_1_5 object-1-5747774
Ref: 48f747774
Node: Description<24>747937
Ref: refman/directives/object_1_5 description748050
Ref: 490748050
Node: Template and modes<17>749891
Ref: refman/directives/object_1_5 template-and-modes750025
Ref: 491750025
Node: Examples<25>752576
Ref: refman/directives/object_1_5 examples752686
Ref: 492752686
Node: protocol/1-2753229
Ref: refman/directives/protocol_1_2 doc753353
Ref: 493753353
Ref: refman/directives/protocol_1_2 directives-protocol-1-2753353
Ref: dc753353
Ref: refman/directives/protocol_1_2 protocol-1-2753353
Ref: 494753353
Node: Description<25>753520
Ref: refman/directives/protocol_1_2 description753635
Ref: 495753635
Node: Template and modes<18>753787
Ref: refman/directives/protocol_1_2 template-and-modes753923
Ref: 496753923
Node: Examples<26>754093
Ref: refman/directives/protocol_1_2 examples754205
Ref: 497754205
Node: threaded/0754445
Ref: refman/directives/threaded_0 doc754565
Ref: 498754565
Ref: refman/directives/threaded_0 directives-threaded-0754565
Ref: 228754565
Ref: refman/directives/threaded_0 threaded-0754565
Ref: 499754565
Node: Description<26>754728
Ref: refman/directives/threaded_0 description754841
Ref: 49a754841
Node: Template and modes<19>755920
Ref: refman/directives/threaded_0 template-and-modes756054
Ref: 49b756054
Node: Examples<27>756126
Ref: refman/directives/threaded_0 examples756236
Ref: 49c756236
Node: uses/1756380
Ref: refman/directives/uses_1 doc756500
Ref: 49d756500
Ref: refman/directives/uses_1 directives-uses-1756500
Ref: 4a756500
Ref: refman/directives/uses_1 uses-1756500
Ref: 49e756500
Node: Description<27>756655
Ref: refman/directives/uses_1 description756764
Ref: 49f756764
Node: Template and modes<20>757872
Ref: refman/directives/uses_1 template-and-modes758002
Ref: 4a0758002
Node: Examples<28>758090
Ref: refman/directives/uses_1 examples758196
Ref: 4a1758196
Node: use_module/1758963
Ref: refman/directives/use_module_1 doc759064
Ref: 4a2759064
Ref: refman/directives/use_module_1 directives-use-module-1759064
Ref: 4c759064
Ref: refman/directives/use_module_1 use-module-1759064
Ref: 4a3759064
Node: Description<28>759231
Ref: refman/directives/use_module_1 description759346
Ref: 4a4759346
Node: Template and modes<21>760510
Ref: refman/directives/use_module_1 template-and-modes760646
Ref: 4a5760646
Node: Examples<29>760740
Ref: refman/directives/use_module_1 examples760852
Ref: 4a6760852
Node: Predicate directives<2>761348
Ref: refman/directives/predicate_directives doc761467
Ref: 4a7761467
Ref: refman/directives/predicate_directives id1761467
Ref: 4a8761467
Ref: refman/directives/predicate_directives predicate-directives761467
Ref: 4a9761467
Node: alias/2761806
Ref: refman/directives/alias_2 doc761915
Ref: 4aa761915
Ref: refman/directives/alias_2 alias-2761915
Ref: 4ab761915
Ref: refman/directives/alias_2 directives-alias-2761915
Ref: 165761915
Node: Description<29>762070
Ref: refman/directives/alias_2 description762180
Ref: 4ac762180
Node: Template and modes<22>763291
Ref: refman/directives/alias_2 template-and-modes763422
Ref: 4ad763422
Node: Examples<30>763611
Ref: refman/directives/alias_2 examples763718
Ref: 4ae763718
Node: coinductive/1764095
Ref: refman/directives/coinductive_1 doc764228
Ref: 4af764228
Ref: refman/directives/coinductive_1 coinductive-1764228
Ref: 4b0764228
Ref: refman/directives/coinductive_1 directives-coinductive-1764228
Ref: 171764228
Node: Description<30>764395
Ref: refman/directives/coinductive_1 description764511
Ref: 4b1764511
Node: Template and modes<23>766140
Ref: refman/directives/coinductive_1 template-and-modes766277
Ref: 4b3766277
Node: Examples<31>766479
Ref: refman/directives/coinductive_1 examples766592
Ref: 4b4766592
Node: discontiguous/1766852
Ref: refman/directives/discontiguous_1 doc766987
Ref: 4b5766987
Ref: refman/directives/discontiguous_1 directives-discontiguous-1766987
Ref: 157766987
Ref: refman/directives/discontiguous_1 discontiguous-1766987
Ref: 4b6766987
Node: Description<31>767158
Ref: refman/directives/discontiguous_1 description767276
Ref: 4b7767276
Node: Template and modes<24>768499
Ref: refman/directives/discontiguous_1 template-and-modes768638
Ref: 4b9768638
Node: Examples<32>768791
Ref: refman/directives/discontiguous_1 examples768906
Ref: 4ba768906
Node: dynamic/1769082
Ref: refman/directives/dynamic_1 doc769210
Ref: 4bb769210
Ref: refman/directives/dynamic_1 directives-dynamic-1769210
Ref: 15a769210
Ref: refman/directives/dynamic_1 dynamic-1769210
Ref: 4bc769210
Node: Description<32>769371
Ref: refman/directives/dynamic_1 description769483
Ref: 4bd769483
Node: Template and modes<25>771234
Ref: refman/directives/dynamic_1 template-and-modes771367
Ref: 4bf771367
Node: Examples<33>771528
Ref: refman/directives/dynamic_1 examples771637
Ref: 4c0771637
Node: info/2771869
Ref: refman/directives/info_2 doc771998
Ref: 4c1771998
Ref: refman/directives/info_2 directives-info-2771998
Ref: 168771998
Ref: refman/directives/info_2 info-2771998
Ref: 4c2771998
Node: Description<33>772153
Ref: refman/directives/info_2 description772262
Ref: 4c3772262
Node: Template and modes<26>772732
Ref: refman/directives/info_2 template-and-modes772862
Ref: 4c4772862
Node: Examples<34>773031
Ref: refman/directives/info_2 examples773137
Ref: 4c5773137
Node: meta_predicate/1773521
Ref: refman/directives/meta_predicate_1 doc773660
Ref: 4c6773660
Ref: refman/directives/meta_predicate_1 directives-meta-predicate-1773660
Ref: 152773660
Ref: refman/directives/meta_predicate_1 meta-predicate-1773660
Ref: 4c7773660
Node: Description<34>773835
Ref: refman/directives/meta_predicate_1 description773954
Ref: 4c8773954
Node: Template and modes<27>776114
Ref: refman/directives/meta_predicate_1 template-and-modes776254
Ref: 4c9776254
Node: Examples<35>776579
Ref: refman/directives/meta_predicate_1 examples776695
Ref: 4ca776695
Node: meta_non_terminal/1777205
Ref: refman/directives/meta_non_terminal_1 doc777344
Ref: 4cb777344
Ref: refman/directives/meta_non_terminal_1 directives-meta-non-terminal-1777344
Ref: 153777344
Ref: refman/directives/meta_non_terminal_1 meta-non-terminal-1777344
Ref: 4cc777344
Node: Description<35>777525
Ref: refman/directives/meta_non_terminal_1 description777647
Ref: 4cd777647
Node: Template and modes<28>778959
Ref: refman/directives/meta_non_terminal_1 template-and-modes779102
Ref: 4ce779102
Node: Examples<36>779451
Ref: refman/directives/meta_non_terminal_1 examples779570
Ref: 4cf779570
Node: mode/2779778
Ref: refman/directives/mode_2 doc779920
Ref: 4d0779920
Ref: refman/directives/mode_2 directives-mode-2779920
Ref: 149779920
Ref: refman/directives/mode_2 mode-2779920
Ref: 4d1779920
Node: Description<36>780075
Ref: refman/directives/mode_2 description780184
Ref: 4d2780184
Node: Template and modes<29>780569
Ref: refman/directives/mode_2 template-and-modes780699
Ref: 4d3780699
Node: Examples<37>780862
Ref: refman/directives/mode_2 examples780968
Ref: 4d4780968
Node: mode_non_terminal/2781336
Ref: refman/directives/mode_non_terminal_2 doc781470
Ref: 4d5781470
Ref: refman/directives/mode_non_terminal_2 directives-mode-non-terminal-2781470
Ref: 14a781470
Ref: refman/directives/mode_non_terminal_2 mode-non-terminal-2781470
Ref: 4d6781470
Node: Description<37>781651
Ref: refman/directives/mode_non_terminal_2 description781773
Ref: 4d7781773
Node: Template and modes<30>782174
Ref: refman/directives/mode_non_terminal_2 template-and-modes782317
Ref: 4d8782317
Node: Examples<38>782506
Ref: refman/directives/mode_non_terminal_2 examples782625
Ref: 4d9782625
Node: multifile/1782828
Ref: refman/directives/multifile_1 doc782965
Ref: 4da782965
Ref: refman/directives/multifile_1 directives-multifile-1782965
Ref: 16c782965
Ref: refman/directives/multifile_1 multifile-1782965
Ref: 4db782965
Node: Description<38>783130
Ref: refman/directives/multifile_1 description783244
Ref: 4dc783244
Node: Template and modes<31>784848
Ref: refman/directives/multifile_1 template-and-modes784983
Ref: 4dd784983
Node: Examples<39>785148
Ref: refman/directives/multifile_1 examples785259
Ref: 4de785259
Node: private/1785491
Ref: refman/directives/private_1 doc785620
Ref: 4df785620
Ref: refman/directives/private_1 directives-private-1785620
Ref: 145785620
Ref: refman/directives/private_1 private-1785620
Ref: 4e0785620
Node: Description<39>785781
Ref: refman/directives/private_1 description785893
Ref: 4e1785893
Node: Template and modes<32>786643
Ref: refman/directives/private_1 template-and-modes786776
Ref: 4e2786776
Node: Examples<40>786953
Ref: refman/directives/private_1 examples787062
Ref: 4e3787062
Node: protected/1787318
Ref: refman/directives/protected_1 doc787444
Ref: 4e4787444
Ref: refman/directives/protected_1 directives-protected-1787444
Ref: 144787444
Ref: refman/directives/protected_1 protected-1787444
Ref: 4e5787444
Node: Description<40>787609
Ref: refman/directives/protected_1 description787723
Ref: 4e6787723
Node: Template and modes<33>788744
Ref: refman/directives/protected_1 template-and-modes788879
Ref: 4e7788879
Node: Examples<41>789062
Ref: refman/directives/protected_1 examples789173
Ref: 4e8789173
Node: public/1789427
Ref: refman/directives/public_1 doc789558
Ref: 4e9789558
Ref: refman/directives/public_1 directives-public-1789558
Ref: 143789558
Ref: refman/directives/public_1 public-1789558
Ref: 4ea789558
Node: Description<41>789717
Ref: refman/directives/public_1 description789828
Ref: 4eb789828
Node: Template and modes<34>790782
Ref: refman/directives/public_1 template-and-modes790914
Ref: 4ec790914
Node: Examples<42>791088
Ref: refman/directives/public_1 examples791196
Ref: 4ed791196
Node: synchronized/1791455
Ref: refman/directives/synchronized_1 doc791581
Ref: 4ee791581
Ref: refman/directives/synchronized_1 directives-synchronized-1791581
Ref: 74791581
Ref: refman/directives/synchronized_1 synchronized-1791581
Ref: 4ef791581
Node: Description<42>791752
Ref: refman/directives/synchronized_1 description791869
Ref: 4f0791869
Node: Template and modes<35>793257
Ref: refman/directives/synchronized_1 template-and-modes793395
Ref: 4f1793395
Node: Examples<43>793546
Ref: refman/directives/synchronized_1 examples793660
Ref: 4f2793660
Node: uses/2793917
Ref: refman/directives/uses_2 doc794047
Ref: 4f3794047
Ref: refman/directives/uses_2 directives-uses-2794047
Ref: 4b794047
Ref: refman/directives/uses_2 uses-2794047
Ref: 4f4794047
Node: Description<43>794202
Ref: refman/directives/uses_2 description794311
Ref: 4f5794311
Node: Template and modes<36>796758
Ref: refman/directives/uses_2 template-and-modes796888
Ref: 4f6796888
Node: Examples<44>797303
Ref: refman/directives/uses_2 examples797409
Ref: 4f7797409
Node: use_module/2799203
Ref: refman/directives/use_module_2 doc799310
Ref: 4f8799310
Ref: refman/directives/use_module_2 directives-use-module-2799310
Ref: 4d799310
Ref: refman/directives/use_module_2 use-module-2799310
Ref: 4f9799310
Node: Description<44>799477
Ref: refman/directives/use_module_2 description799592
Ref: 4fa799592
Node: Template and modes<37>802948
Ref: refman/directives/use_module_2 template-and-modes803084
Ref: 4fb803084
Node: Examples<45>803549
Ref: refman/directives/use_module_2 examples803661
Ref: 4fc803661
Node: Built-in predicates805028
Ref: refman/predicates/index doc805170
Ref: 4fd805170
Ref: refman/predicates/index built-in-predicates805170
Ref: 4fe805170
Node: Enumerating objects categories and protocols805868
Ref: refman/predicates/enumerating_entity_predicates doc806052
Ref: 4ff806052
Ref: refman/predicates/enumerating_entity_predicates enumerating-entity-predicates806052
Ref: 284806052
Ref: refman/predicates/enumerating_entity_predicates enumerating-objects-categories-and-protocols806052
Ref: 500806052
Node: current_category/1806256
Ref: refman/predicates/current_category_1 doc806400
Ref: 501806400
Ref: refman/predicates/current_category_1 current-category-1806400
Ref: 502806400
Ref: refman/predicates/current_category_1 predicates-current-category-1806400
Ref: f1806400
Node: Description<45>806613
Ref: refman/predicates/current_category_1 description806741
Ref: 503806741
Node: Modes and number of proofs<8>806943
Ref: refman/predicates/current_category_1 modes-and-number-of-proofs807089
Ref: 504807089
Node: Errors<9>807220
Ref: refman/predicates/current_category_1 errors807363
Ref: 505807363
Node: Examples<46>807528
Ref: refman/predicates/current_category_1 examples807633
Ref: 506807633
Node: current_object/1808021
Ref: refman/predicates/current_object_1 doc808192
Ref: 507808192
Ref: refman/predicates/current_object_1 current-object-1808192
Ref: 508808192
Ref: refman/predicates/current_object_1 predicates-current-object-1808192
Ref: a6808192
Node: Description<46>808402
Ref: refman/predicates/current_object_1 description808528
Ref: 509808528
Node: Modes and number of proofs<9>808719
Ref: refman/predicates/current_object_1 modes-and-number-of-proofs808864
Ref: 50a808864
Node: Errors<10>808991
Ref: refman/predicates/current_object_1 errors809133
Ref: 50b809133
Node: Examples<47>809290
Ref: refman/predicates/current_object_1 examples809394
Ref: 50c809394
Node: current_protocol/1809814
Ref: refman/predicates/current_protocol_1 doc809958
Ref: 50d809958
Ref: refman/predicates/current_protocol_1 current-protocol-1809958
Ref: 50e809958
Ref: refman/predicates/current_protocol_1 predicates-current-protocol-1809958
Ref: e0809958
Node: Description<47>810175
Ref: refman/predicates/current_protocol_1 description810304
Ref: 50f810304
Node: Modes and number of proofs<10>810506
Ref: refman/predicates/current_protocol_1 modes-and-number-of-proofs810654
Ref: 510810654
Node: Errors<11>810787
Ref: refman/predicates/current_protocol_1 errors810932
Ref: 511810932
Node: Examples<48>811099
Ref: refman/predicates/current_protocol_1 examples811205
Ref: 512811205
Node: Enumerating objects categories and protocols properties811630
Ref: refman/predicates/enumerating_entity_property_predicates doc811868
Ref: 513811868
Ref: refman/predicates/enumerating_entity_property_predicates enumerating-entity-property-predicates811868
Ref: 6f811868
Ref: refman/predicates/enumerating_entity_property_predicates enumerating-objects-categories-and-protocols-properties811868
Ref: 514811868
Node: category_property/2812097
Ref: refman/predicates/category_property_2 doc812254
Ref: 515812254
Ref: refman/predicates/category_property_2 category-property-2812254
Ref: 516812254
Ref: refman/predicates/category_property_2 predicates-category-property-2812254
Ref: 12c812254
Node: Description<48>812471
Ref: refman/predicates/category_property_2 description812601
Ref: 517812601
Node: Modes and number of proofs<11>812944
Ref: refman/predicates/category_property_2 modes-and-number-of-proofs813093
Ref: 518813093
Node: Errors<12>813245
Ref: refman/predicates/category_property_2 errors813391
Ref: 519813391
Node: Examples<49>813809
Ref: refman/predicates/category_property_2 examples813916
Ref: 51a813916
Node: object_property/2814399
Ref: refman/predicates/object_property_2 doc814584
Ref: 51b814584
Ref: refman/predicates/object_property_2 object-property-2814584
Ref: 51c814584
Ref: refman/predicates/object_property_2 predicates-object-property-2814584
Ref: c6814584
Node: Description<49>814797
Ref: refman/predicates/object_property_2 description814925
Ref: 51d814925
Node: Modes and number of proofs<12>815258
Ref: refman/predicates/object_property_2 modes-and-number-of-proofs815405
Ref: 51e815405
Node: Errors<13>815551
Ref: refman/predicates/object_property_2 errors815695
Ref: 51f815695
Node: Examples<50>816090
Ref: refman/predicates/object_property_2 examples816195
Ref: 520816195
Node: protocol_property/2816758
Ref: refman/predicates/protocol_property_2 doc816915
Ref: 521816915
Ref: refman/predicates/protocol_property_2 predicates-protocol-property-2816915
Ref: f4816915
Ref: refman/predicates/protocol_property_2 protocol-property-2816915
Ref: 522816915
Node: Description<50>817134
Ref: refman/predicates/protocol_property_2 description817264
Ref: 523817264
Node: Modes and number of proofs<13>817617
Ref: refman/predicates/protocol_property_2 modes-and-number-of-proofs817766
Ref: 524817766
Node: Errors<14>817920
Ref: refman/predicates/protocol_property_2 errors818066
Ref: 525818066
Node: Examples<51>818475
Ref: refman/predicates/protocol_property_2 examples818582
Ref: 526818582
Node: Creating new objects categories and protocols819044
Ref: refman/predicates/creating_entity_predicates doc819281
Ref: 527819281
Ref: refman/predicates/creating_entity_predicates creating-entity-predicates819281
Ref: 528819281
Ref: refman/predicates/creating_entity_predicates creating-new-objects-categories-and-protocols819281
Ref: 529819281
Node: create_category/4819484
Ref: refman/predicates/create_category_4 doc819627
Ref: 52a819627
Ref: refman/predicates/create_category_4 create-category-4819627
Ref: 52b819627
Ref: refman/predicates/create_category_4 predicates-create-category-4819627
Ref: 11a819627
Node: Description<51>819840
Ref: refman/predicates/create_category_4 description819968
Ref: 52c819968
Node: Modes and number of proofs<14>820863
Ref: refman/predicates/create_category_4 modes-and-number-of-proofs821010
Ref: 52d821010
Node: Errors<15>821199
Ref: refman/predicates/create_category_4 errors821343
Ref: 52e821343
Node: Examples<52>822577
Ref: refman/predicates/create_category_4 examples822682
Ref: 52f822682
Node: create_object/4823143
Ref: refman/predicates/create_object_4 doc823312
Ref: 530823312
Ref: refman/predicates/create_object_4 create-object-4823312
Ref: 531823312
Ref: refman/predicates/create_object_4 predicates-create-object-4823312
Ref: 62823312
Node: Description<52>823521
Ref: refman/predicates/create_object_4 description823647
Ref: 532823647
Node: Modes and number of proofs<15>824788
Ref: refman/predicates/create_object_4 modes-and-number-of-proofs824933
Ref: 534824933
Node: Errors<16>825114
Ref: refman/predicates/create_object_4 errors825256
Ref: 535825256
Node: Examples<53>826629
Ref: refman/predicates/create_object_4 examples826732
Ref: 536826732
Node: create_protocol/3828276
Ref: refman/predicates/create_protocol_3 doc828419
Ref: 537828419
Ref: refman/predicates/create_protocol_3 create-protocol-3828419
Ref: 538828419
Ref: refman/predicates/create_protocol_3 predicates-create-protocol-3828419
Ref: e3828419
Node: Description<53>828634
Ref: refman/predicates/create_protocol_3 description828762
Ref: 539828762
Node: Modes and number of proofs<16>829497
Ref: refman/predicates/create_protocol_3 modes-and-number-of-proofs829644
Ref: 53a829644
Node: Errors<17>829820
Ref: refman/predicates/create_protocol_3 errors829964
Ref: 53b829964
Node: Examples<54>830783
Ref: refman/predicates/create_protocol_3 examples830888
Ref: 53c830888
Node: Abolishing objects categories and protocols831295
Ref: refman/predicates/abolishing_entity_predicates doc831519
Ref: 53d831519
Ref: refman/predicates/abolishing_entity_predicates abolishing-entity-predicates831519
Ref: 53e831519
Ref: refman/predicates/abolishing_entity_predicates abolishing-objects-categories-and-protocols831519
Ref: 53f831519
Node: abolish_category/1831721
Ref: refman/predicates/abolish_category_1 doc831864
Ref: 540831864
Ref: refman/predicates/abolish_category_1 abolish-category-1831864
Ref: 541831864
Ref: refman/predicates/abolish_category_1 predicates-abolish-category-1831864
Ref: f5831864
Node: Description<54>832079
Ref: refman/predicates/abolish_category_1 description832208
Ref: 542832208
Node: Modes and number of proofs<17>832387
Ref: refman/predicates/abolish_category_1 modes-and-number-of-proofs832535
Ref: 543832535
Node: Errors<18>832657
Ref: refman/predicates/abolish_category_1 errors832802
Ref: 544832802
Node: Examples<55>833253
Ref: refman/predicates/abolish_category_1 examples833359
Ref: 545833359
Node: abolish_object/1833666
Ref: refman/predicates/abolish_object_1 doc833836
Ref: 546833836
Ref: refman/predicates/abolish_object_1 abolish-object-1833836
Ref: 547833836
Ref: refman/predicates/abolish_object_1 predicates-abolish-object-1833836
Ref: 64833836
Node: Description<55>834047
Ref: refman/predicates/abolish_object_1 description834174
Ref: 548834174
Node: Modes and number of proofs<18>834343
Ref: refman/predicates/abolish_object_1 modes-and-number-of-proofs834489
Ref: 549834489
Node: Errors<19>834607
Ref: refman/predicates/abolish_object_1 errors834750
Ref: 54a834750
Node: Examples<56>835177
Ref: refman/predicates/abolish_object_1 examples835281
Ref: 54b835281
Node: abolish_protocol/1835606
Ref: refman/predicates/abolish_protocol_1 doc835749
Ref: 54c835749
Ref: refman/predicates/abolish_protocol_1 abolish-protocol-1835749
Ref: 54d835749
Ref: refman/predicates/abolish_protocol_1 predicates-abolish-protocol-1835749
Ref: e6835749
Node: Description<56>835966
Ref: refman/predicates/abolish_protocol_1 description836095
Ref: 54e836095
Node: Modes and number of proofs<19>836276
Ref: refman/predicates/abolish_protocol_1 modes-and-number-of-proofs836424
Ref: 54f836424
Node: Errors<20>836548
Ref: refman/predicates/abolish_protocol_1 errors836693
Ref: 550836693
Node: Examples<57>837146
Ref: refman/predicates/abolish_protocol_1 examples837252
Ref: 551837252
Node: Objects categories and protocols relations837538
Ref: refman/predicates/entity_relation_predicates doc837734
Ref: 552837734
Ref: refman/predicates/entity_relation_predicates entity-relation-predicates837734
Ref: 285837734
Ref: refman/predicates/entity_relation_predicates objects-categories-and-protocols-relations837734
Ref: 553837734
Node: extends_object/2-3838102
Ref: refman/predicates/extends_object_2_3 doc838248
Ref: 554838248
Ref: refman/predicates/extends_object_2_3 extends-object-2-3838248
Ref: 555838248
Ref: refman/predicates/extends_object_2_3 predicates-extends-object-2-3838248
Ref: bf838248
Node: Description<57>838463
Ref: refman/predicates/extends_object_2_3 description838592
Ref: 556838592
Node: Modes and number of proofs<20>838912
Ref: refman/predicates/extends_object_2_3 modes-and-number-of-proofs839060
Ref: 557839060
Node: Errors<21>839290
Ref: refman/predicates/extends_object_2_3 errors839435
Ref: 558839435
Node: Examples<58>839915
Ref: refman/predicates/extends_object_2_3 examples840021
Ref: 559840021
Node: extends_protocol/2-3840422
Ref: refman/predicates/extends_protocol_2_3 doc840597
Ref: 55a840597
Ref: refman/predicates/extends_protocol_2_3 extends-protocol-2-3840597
Ref: 55b840597
Ref: refman/predicates/extends_protocol_2_3 predicates-extends-protocol-2-3840597
Ref: f0840597
Node: Description<58>840816
Ref: refman/predicates/extends_protocol_2_3 description840947
Ref: 55c840947
Node: Modes and number of proofs<21>841287
Ref: refman/predicates/extends_protocol_2_3 modes-and-number-of-proofs841437
Ref: 55d841437
Node: Errors<22>841679
Ref: refman/predicates/extends_protocol_2_3 errors841826
Ref: 55e841826
Node: Examples<59>842328
Ref: refman/predicates/extends_protocol_2_3 examples842436
Ref: 55f842436
Node: extends_category/2-3842849
Ref: refman/predicates/extends_category_2_3 doc843029
Ref: 560843029
Ref: refman/predicates/extends_category_2_3 extends-category-2-3843029
Ref: 561843029
Ref: refman/predicates/extends_category_2_3 predicates-extends-category-2-3843029
Ref: 129843029
Node: Description<59>843250
Ref: refman/predicates/extends_category_2_3 description843381
Ref: 562843381
Node: Modes and number of proofs<22>843724
Ref: refman/predicates/extends_category_2_3 modes-and-number-of-proofs843874
Ref: 563843874
Node: Errors<23>844118
Ref: refman/predicates/extends_category_2_3 errors844265
Ref: 564844265
Node: Examples<60>844769
Ref: refman/predicates/extends_category_2_3 examples844877
Ref: 565844877
Node: implements_protocol/2-3845297
Ref: refman/predicates/implements_protocol_2_3 doc845481
Ref: 566845481
Ref: refman/predicates/implements_protocol_2_3 implements-protocol-2-3845481
Ref: 567845481
Ref: refman/predicates/implements_protocol_2_3 predicates-implements-protocol-2-3845481
Ref: c1845481
Node: Description<60>845708
Ref: refman/predicates/implements_protocol_2_3 description845842
Ref: 568845842
Node: Modes and number of proofs<23>846428
Ref: refman/predicates/implements_protocol_2_3 modes-and-number-of-proofs846581
Ref: 569846581
Node: Errors<24>847004
Ref: refman/predicates/implements_protocol_2_3 errors847154
Ref: 56a847154
Node: Examples<61>847771
Ref: refman/predicates/implements_protocol_2_3 examples847882
Ref: 56b847882
Node: conforms_to_protocol/2-3848619
Ref: refman/predicates/conforms_to_protocol_2_3 doc848803
Ref: 56c848803
Ref: refman/predicates/conforms_to_protocol_2_3 conforms-to-protocol-2-3848803
Ref: 56d848803
Ref: refman/predicates/conforms_to_protocol_2_3 predicates-conforms-to-protocol-2-3848803
Ref: c2848803
Node: Description<61>849032
Ref: refman/predicates/conforms_to_protocol_2_3 description849167
Ref: 56e849167
Node: Modes and number of proofs<24>849704
Ref: refman/predicates/conforms_to_protocol_2_3 modes-and-number-of-proofs849858
Ref: 56f849858
Node: Errors<25>850285
Ref: refman/predicates/conforms_to_protocol_2_3 errors850436
Ref: 570850436
Node: Examples<62>851053
Ref: refman/predicates/conforms_to_protocol_2_3 examples851165
Ref: 571851165
Node: complements_object/2851935
Ref: refman/predicates/complements_object_2 doc852116
Ref: 572852116
Ref: refman/predicates/complements_object_2 complements-object-2852116
Ref: 573852116
Ref: refman/predicates/complements_object_2 predicates-complements-object-2852116
Ref: c3852116
Node: Description<62>852337
Ref: refman/predicates/complements_object_2 description852468
Ref: 574852468
Node: Modes and number of proofs<25>852670
Ref: refman/predicates/complements_object_2 modes-and-number-of-proofs852820
Ref: 575852820
Node: Errors<26>852975
Ref: refman/predicates/complements_object_2 errors853122
Ref: 576853122
Node: Examples<63>853415
Ref: refman/predicates/complements_object_2 examples853523
Ref: 577853523
Node: imports_category/2-3853786
Ref: refman/predicates/imports_category_2_3 doc853965
Ref: 578853965
Ref: refman/predicates/imports_category_2_3 imports-category-2-3853965
Ref: 579853965
Ref: refman/predicates/imports_category_2_3 predicates-imports-category-2-3853965
Ref: c0853965
Node: Description<63>854186
Ref: refman/predicates/imports_category_2_3 description854317
Ref: 57a854317
Node: Modes and number of proofs<26>854631
Ref: refman/predicates/imports_category_2_3 modes-and-number-of-proofs854781
Ref: 57b854781
Node: Errors<27>855021
Ref: refman/predicates/imports_category_2_3 errors855168
Ref: 57c855168
Node: Examples<64>855652
Ref: refman/predicates/imports_category_2_3 examples855760
Ref: 57d855760
Node: instantiates_class/2-3856153
Ref: refman/predicates/instantiates_class_2_3 doc856333
Ref: 57e856333
Ref: refman/predicates/instantiates_class_2_3 instantiates-class-2-3856333
Ref: 57f856333
Ref: refman/predicates/instantiates_class_2_3 predicates-instantiates-class-2-3856333
Ref: bd856333
Node: Description<64>856558
Ref: refman/predicates/instantiates_class_2_3 description856691
Ref: 580856691
Node: Modes and number of proofs<27>857022
Ref: refman/predicates/instantiates_class_2_3 modes-and-number-of-proofs857174
Ref: 581857174
Node: Errors<28>857414
Ref: refman/predicates/instantiates_class_2_3 errors857563
Ref: 582857563
Node: Examples<65>858041
Ref: refman/predicates/instantiates_class_2_3 examples858151
Ref: 583858151
Node: specializes_class/2-3858592
Ref: refman/predicates/specializes_class_2_3 doc858743
Ref: 584858743
Ref: refman/predicates/specializes_class_2_3 predicates-specializes-class-2-3858743
Ref: be858743
Ref: refman/predicates/specializes_class_2_3 specializes-class-2-3858743
Ref: 585858743
Node: Description<65>858966
Ref: refman/predicates/specializes_class_2_3 description859098
Ref: 586859098
Node: Modes and number of proofs<28>859430
Ref: refman/predicates/specializes_class_2_3 modes-and-number-of-proofs859581
Ref: 587859581
Node: Errors<29>859819
Ref: refman/predicates/specializes_class_2_3 errors859967
Ref: 588859967
Node: Examples<66>860449
Ref: refman/predicates/specializes_class_2_3 examples860558
Ref: 589860558
Node: Event handling<2>860962
Ref: refman/predicates/event_handling_predicates doc861130
Ref: 58a861130
Ref: refman/predicates/event_handling_predicates event-handling861130
Ref: 58b861130
Ref: refman/predicates/event_handling_predicates event-handling-predicates861130
Ref: 71861130
Node: abolish_events/5861266
Ref: refman/predicates/abolish_events_5 doc861380
Ref: 58c861380
Ref: refman/predicates/abolish_events_5 abolish-events-5861380
Ref: 58d861380
Ref: refman/predicates/abolish_events_5 predicates-abolish-events-5861380
Ref: 21b861380
Node: Description<66>861591
Ref: refman/predicates/abolish_events_5 description861718
Ref: 58e861718
Node: Modes and number of proofs<29>862036
Ref: refman/predicates/abolish_events_5 modes-and-number-of-proofs862182
Ref: 58f862182
Node: Errors<30>862315
Ref: refman/predicates/abolish_events_5 errors862458
Ref: 590862458
Node: Examples<67>863085
Ref: refman/predicates/abolish_events_5 examples863189
Ref: 591863189
Node: current_event/5863529
Ref: refman/predicates/current_event_5 doc863667
Ref: 592863667
Ref: refman/predicates/current_event_5 current-event-5863667
Ref: 593863667
Ref: refman/predicates/current_event_5 predicates-current-event-5863667
Ref: 21e863667
Node: Description<67>863876
Ref: refman/predicates/current_event_5 description864002
Ref: 594864002
Node: Modes and number of proofs<30>864238
Ref: refman/predicates/current_event_5 modes-and-number-of-proofs864383
Ref: 595864383
Node: Errors<31>864538
Ref: refman/predicates/current_event_5 errors864680
Ref: 596864680
Node: Examples<68>865307
Ref: refman/predicates/current_event_5 examples865410
Ref: 597865410
Node: define_events/5865719
Ref: refman/predicates/define_events_5 doc865832
Ref: 598865832
Ref: refman/predicates/define_events_5 define-events-5865832
Ref: 599865832
Ref: refman/predicates/define_events_5 predicates-define-events-5865832
Ref: 218865832
Node: Description<68>866043
Ref: refman/predicates/define_events_5 description866169
Ref: 59a866169
Node: Modes and number of proofs<31>866586
Ref: refman/predicates/define_events_5 modes-and-number-of-proofs866731
Ref: 59b866731
Node: Errors<32>866878
Ref: refman/predicates/define_events_5 errors867020
Ref: 59c867020
Node: Examples<69>867965
Ref: refman/predicates/define_events_5 examples868068
Ref: 59d868068
Node: Multi-threading868380
Ref: refman/predicates/multi_threading_predicates doc868529
Ref: 59e868529
Ref: refman/predicates/multi_threading_predicates multi-threading868529
Ref: 59f868529
Ref: refman/predicates/multi_threading_predicates multi-threading-predicates868529
Ref: 5a0868529
Node: threaded/1868795
Ref: refman/predicates/threaded_1 doc868903
Ref: 5a1868903
Ref: refman/predicates/threaded_1 predicates-threaded-1868903
Ref: 22b868903
Ref: refman/predicates/threaded_1 threaded-1868903
Ref: 5a2868903
Node: Description<69>869130
Ref: refman/predicates/threaded_1 description869244
Ref: 5a3869244
Node: Meta-predicate template871010
Ref: refman/predicates/threaded_1 meta-predicate-template871163
Ref: 5a4871163
Node: Modes and number of proofs<32>871246
Ref: refman/predicates/threaded_1 modes-and-number-of-proofs871394
Ref: 5a5871394
Node: Errors<33>871505
Ref: refman/predicates/threaded_1 errors871642
Ref: 5a6871642
Node: Examples<70>872048
Ref: refman/predicates/threaded_1 examples872146
Ref: 5a7872146
Node: threaded_call/1-2872546
Ref: refman/predicates/threaded_call_1_2 doc872680
Ref: 5a8872680
Ref: refman/predicates/threaded_call_1_2 predicates-threaded-call-1-2872680
Ref: 230872680
Ref: refman/predicates/threaded_call_1_2 threaded-call-1-2872680
Ref: 5a9872680
Node: Description<70>872948
Ref: refman/predicates/threaded_call_1_2 description873072
Ref: 5aa873072
Node: Meta-predicate template<2>874031
Ref: refman/predicates/threaded_call_1_2 meta-predicate-template874194
Ref: 5ab874194
Node: Modes and number of proofs<33>874307
Ref: refman/predicates/threaded_call_1_2 modes-and-number-of-proofs874465
Ref: 5ac874465
Node: Errors<34>874621
Ref: refman/predicates/threaded_call_1_2 errors874765
Ref: 5ad874765
Node: Examples<71>875045
Ref: refman/predicates/threaded_call_1_2 examples875150
Ref: 5ae875150
Node: threaded_once/1-2875731
Ref: refman/predicates/threaded_once_1_2 doc875872
Ref: 5af875872
Ref: refman/predicates/threaded_once_1_2 predicates-threaded-once-1-2875872
Ref: 232875872
Ref: refman/predicates/threaded_once_1_2 threaded-once-1-2875872
Ref: 5b0875872
Node: Description<71>876142
Ref: refman/predicates/threaded_once_1_2 description876266
Ref: 5b1876266
Node: Meta-predicate template<3>877155
Ref: refman/predicates/threaded_once_1_2 meta-predicate-template877318
Ref: 5b2877318
Node: Modes and number of proofs<34>877433
Ref: refman/predicates/threaded_once_1_2 modes-and-number-of-proofs877591
Ref: 5b3877591
Node: Errors<35>877747
Ref: refman/predicates/threaded_once_1_2 errors877891
Ref: 5b4877891
Node: Examples<72>878153
Ref: refman/predicates/threaded_once_1_2 examples878258
Ref: 5b5878258
Node: threaded_ignore/1878839
Ref: refman/predicates/threaded_ignore_1 doc878980
Ref: 5b6878980
Ref: refman/predicates/threaded_ignore_1 predicates-threaded-ignore-1878980
Ref: 237878980
Ref: refman/predicates/threaded_ignore_1 threaded-ignore-1878980
Ref: 5b7878980
Node: Description<72>879250
Ref: refman/predicates/threaded_ignore_1 description879374
Ref: 5b8879374
Node: Meta-predicate template<4>880041
Ref: refman/predicates/threaded_ignore_1 meta-predicate-template880204
Ref: 5b9880204
Node: Modes and number of proofs<35>880296
Ref: refman/predicates/threaded_ignore_1 modes-and-number-of-proofs880454
Ref: 5ba880454
Node: Errors<36>880566
Ref: refman/predicates/threaded_ignore_1 errors880710
Ref: 5bb880710
Node: Examples<73>880913
Ref: refman/predicates/threaded_ignore_1 examples881018
Ref: 5bc881018
Node: threaded_exit/1-2881575
Ref: refman/predicates/threaded_exit_1_2 doc881716
Ref: 5bd881716
Ref: refman/predicates/threaded_exit_1_2 predicates-threaded-exit-1-2881716
Ref: 231881716
Ref: refman/predicates/threaded_exit_1_2 threaded-exit-1-2881716
Ref: 5be881716
Node: Description<73>881931
Ref: refman/predicates/threaded_exit_1_2 description882059
Ref: 5bf882059
Node: Modes and number of proofs<36>883393
Ref: refman/predicates/threaded_exit_1_2 modes-and-number-of-proofs883540
Ref: 5c0883540
Node: Errors<37>883713
Ref: refman/predicates/threaded_exit_1_2 errors883857
Ref: 5c1883857
Node: Examples<74>884260
Ref: refman/predicates/threaded_exit_1_2 examples884365
Ref: 5c2884365
Node: threaded_peek/1-2884896
Ref: refman/predicates/threaded_peek_1_2 doc885037
Ref: 5c3885037
Ref: refman/predicates/threaded_peek_1_2 predicates-threaded-peek-1-2885037
Ref: 233885037
Ref: refman/predicates/threaded_peek_1_2 threaded-peek-1-2885037
Ref: 5c4885037
Node: Description<74>885252
Ref: refman/predicates/threaded_peek_1_2 description885380
Ref: 5c5885380
Node: Modes and number of proofs<37>886627
Ref: refman/predicates/threaded_peek_1_2 modes-and-number-of-proofs886774
Ref: 5c6886774
Node: Errors<38>886945
Ref: refman/predicates/threaded_peek_1_2 errors887089
Ref: 5c7887089
Node: Examples<75>887492
Ref: refman/predicates/threaded_peek_1_2 examples887597
Ref: 5c8887597
Node: threaded_cancel/1888131
Ref: refman/predicates/threaded_cancel_1 doc888270
Ref: 5c9888270
Ref: refman/predicates/threaded_cancel_1 predicates-threaded-cancel-1888270
Ref: 234888270
Ref: refman/predicates/threaded_cancel_1 threaded-cancel-1888270
Ref: 5ca888270
Node: Description<75>888485
Ref: refman/predicates/threaded_cancel_1 description888613
Ref: 5cb888613
Node: Modes and number of proofs<38>889324
Ref: refman/predicates/threaded_cancel_1 modes-and-number-of-proofs889471
Ref: 5cc889471
Node: Errors<39>889581
Ref: refman/predicates/threaded_cancel_1 errors889725
Ref: 5cd889725
Node: Examples<76>889825
Ref: refman/predicates/threaded_cancel_1 examples889930
Ref: 5ce889930
Node: threaded_wait/1890160
Ref: refman/predicates/threaded_wait_1 doc890299
Ref: 5cf890299
Ref: refman/predicates/threaded_wait_1 predicates-threaded-wait-1890299
Ref: 23b890299
Ref: refman/predicates/threaded_wait_1 threaded-wait-1890299
Ref: 5d0890299
Node: Description<76>890510
Ref: refman/predicates/threaded_wait_1 description890636
Ref: 5d1890636
Node: Modes and number of proofs<39>891432
Ref: refman/predicates/threaded_wait_1 modes-and-number-of-proofs891577
Ref: 5d2891577
Node: Errors<40>891721
Ref: refman/predicates/threaded_wait_1 errors891863
Ref: 5d3891863
Node: Examples<77>891904
Ref: refman/predicates/threaded_wait_1 examples892007
Ref: 5d4892007
Node: threaded_notify/1892227
Ref: refman/predicates/threaded_notify_1 doc892340
Ref: 5d5892340
Ref: refman/predicates/threaded_notify_1 predicates-threaded-notify-1892340
Ref: 23c892340
Ref: refman/predicates/threaded_notify_1 threaded-notify-1892340
Ref: 5d6892340
Node: Description<77>892555
Ref: refman/predicates/threaded_notify_1 description892683
Ref: 5d7892683
Node: Modes and number of proofs<40>893479
Ref: refman/predicates/threaded_notify_1 modes-and-number-of-proofs893626
Ref: 5d8893626
Node: Errors<41>893774
Ref: refman/predicates/threaded_notify_1 errors893918
Ref: 5d9893918
Node: Examples<78>893959
Ref: refman/predicates/threaded_notify_1 examples894064
Ref: 5da894064
Node: Multi-threading engines894242
Ref: refman/predicates/engine_predicates doc894408
Ref: 5db894408
Ref: refman/predicates/engine_predicates engine-predicates894408
Ref: 5dc894408
Ref: refman/predicates/engine_predicates multi-threading-engines894408
Ref: 5dd894408
Node: threaded_engine_create/3894754
Ref: refman/predicates/threaded_engine_create_3 doc894892
Ref: 5de894892
Ref: refman/predicates/threaded_engine_create_3 predicates-threaded-engine-create-3894892
Ref: 23f894892
Ref: refman/predicates/threaded_engine_create_3 threaded-engine-create-3894892
Ref: 5df894892
Node: Description<78>895174
Ref: refman/predicates/threaded_engine_create_3 description895305
Ref: 5e0895305
Node: Meta-predicate template<5>896008
Ref: refman/predicates/threaded_engine_create_3 meta-predicate-template896178
Ref: 5e1896178
Node: Modes and number of proofs<41>896281
Ref: refman/predicates/threaded_engine_create_3 modes-and-number-of-proofs896446
Ref: 5e2896446
Node: Errors<42>896641
Ref: refman/predicates/threaded_engine_create_3 errors896792
Ref: 5e3896792
Node: Examples<79>897103
Ref: refman/predicates/threaded_engine_create_3 examples897215
Ref: 5e4897215
Node: threaded_engine_destroy/1897596
Ref: refman/predicates/threaded_engine_destroy_1 doc897760
Ref: 5e7897760
Ref: refman/predicates/threaded_engine_destroy_1 predicates-threaded-engine-destroy-1897760
Ref: 242897760
Ref: refman/predicates/threaded_engine_destroy_1 threaded-engine-destroy-1897760
Ref: 5e8897760
Node: Description<79>897989
Ref: refman/predicates/threaded_engine_destroy_1 description898125
Ref: 5e9898125
Node: Modes and number of proofs<42>898474
Ref: refman/predicates/threaded_engine_destroy_1 modes-and-number-of-proofs898629
Ref: 5ea898629
Node: Errors<43>898745
Ref: refman/predicates/threaded_engine_destroy_1 errors898897
Ref: 5eb898897
Node: Examples<80>899124
Ref: refman/predicates/threaded_engine_destroy_1 examples899237
Ref: 5ec899237
Node: threaded_engine/1899639
Ref: refman/predicates/threaded_engine_1 doc899801
Ref: 5ed899801
Ref: refman/predicates/threaded_engine_1 predicates-threaded-engine-1899801
Ref: 5e6899801
Ref: refman/predicates/threaded_engine_1 threaded-engine-1899801
Ref: 5ee899801
Node: Description<80>900016
Ref: refman/predicates/threaded_engine_1 description900144
Ref: 5ef900144
Node: Modes and number of proofs<43>900593
Ref: refman/predicates/threaded_engine_1 modes-and-number-of-proofs900740
Ref: 5f0900740
Node: Errors<44>900859
Ref: refman/predicates/threaded_engine_1 errors901003
Ref: 5f1901003
Node: Examples<81>901044
Ref: refman/predicates/threaded_engine_1 examples901149
Ref: 5f2901149
Node: threaded_engine_self/1901576
Ref: refman/predicates/threaded_engine_self_1 doc901735
Ref: 5f3901735
Ref: refman/predicates/threaded_engine_self_1 predicates-threaded-engine-self-1901735
Ref: 5e5901735
Ref: refman/predicates/threaded_engine_self_1 threaded-engine-self-1901735
Ref: 5f4901735
Node: Description<81>901960
Ref: refman/predicates/threaded_engine_self_1 description902093
Ref: 5f5902093
Node: Modes and number of proofs<44>902561
Ref: refman/predicates/threaded_engine_self_1 modes-and-number-of-proofs902713
Ref: 5f6902713
Node: Errors<45>902836
Ref: refman/predicates/threaded_engine_self_1 errors902985
Ref: 5f7902985
Node: Examples<82>903026
Ref: refman/predicates/threaded_engine_self_1 examples903136
Ref: 5f8903136
Node: threaded_engine_next/2903526
Ref: refman/predicates/threaded_engine_next_2 doc903698
Ref: 5f9903698
Ref: refman/predicates/threaded_engine_next_2 predicates-threaded-engine-next-2903698
Ref: 240903698
Ref: refman/predicates/threaded_engine_next_2 threaded-engine-next-2903698
Ref: 5fa903698
Node: Description<82>903923
Ref: refman/predicates/threaded_engine_next_2 description904056
Ref: 5fb904056
Node: Modes and number of proofs<45>904722
Ref: refman/predicates/threaded_engine_next_2 modes-and-number-of-proofs904874
Ref: 5fc904874
Node: Errors<46>905004
Ref: refman/predicates/threaded_engine_next_2 errors905153
Ref: 5fd905153
Node: Examples<83>905380
Ref: refman/predicates/threaded_engine_next_2 examples905490
Ref: 5fe905490
Node: threaded_engine_next_reified/2905789
Ref: refman/predicates/threaded_engine_next_reified_2 doc905962
Ref: 5ff905962
Ref: refman/predicates/threaded_engine_next_reified_2 predicates-threaded-engine-next-reified-2905962
Ref: 241905962
Ref: refman/predicates/threaded_engine_next_reified_2 threaded-engine-next-reified-2905962
Ref: 600905962
Node: Description<83>906203
Ref: refman/predicates/threaded_engine_next_reified_2 description906344
Ref: 601906344
Node: Modes and number of proofs<46>906937
Ref: refman/predicates/threaded_engine_next_reified_2 modes-and-number-of-proofs907097
Ref: 602907097
Node: Errors<47>907229
Ref: refman/predicates/threaded_engine_next_reified_2 errors907386
Ref: 603907386
Node: Examples<84>907613
Ref: refman/predicates/threaded_engine_next_reified_2 examples907731
Ref: 604907731
Node: threaded_engine_yield/1908038
Ref: refman/predicates/threaded_engine_yield_1 doc908211
Ref: 605908211
Ref: refman/predicates/threaded_engine_yield_1 predicates-threaded-engine-yield-1908211
Ref: 245908211
Ref: refman/predicates/threaded_engine_yield_1 threaded-engine-yield-1908211
Ref: 606908211
Node: Description<84>908438
Ref: refman/predicates/threaded_engine_yield_1 description908572
Ref: 607908572
Node: Modes and number of proofs<47>909491
Ref: refman/predicates/threaded_engine_yield_1 modes-and-number-of-proofs909644
Ref: 608909644
Node: Errors<48>909766
Ref: refman/predicates/threaded_engine_yield_1 errors909916
Ref: 609909916
Node: Examples<85>909957
Ref: refman/predicates/threaded_engine_yield_1 examples910068
Ref: 60a910068
Node: threaded_engine_post/2910360
Ref: refman/predicates/threaded_engine_post_2 doc910526
Ref: 60b910526
Ref: refman/predicates/threaded_engine_post_2 predicates-threaded-engine-post-2910526
Ref: 244910526
Ref: refman/predicates/threaded_engine_post_2 threaded-engine-post-2910526
Ref: 60c910526
Node: Description<85>910751
Ref: refman/predicates/threaded_engine_post_2 description910884
Ref: 60d910884
Node: Modes and number of proofs<48>911247
Ref: refman/predicates/threaded_engine_post_2 modes-and-number-of-proofs911399
Ref: 60e911399
Node: Errors<49>911521
Ref: refman/predicates/threaded_engine_post_2 errors911670
Ref: 60f911670
Node: Examples<86>911897
Ref: refman/predicates/threaded_engine_post_2 examples912007
Ref: 610912007
Node: threaded_engine_fetch/1912231
Ref: refman/predicates/threaded_engine_fetch_1 doc912365
Ref: 611912365
Ref: refman/predicates/threaded_engine_fetch_1 predicates-threaded-engine-fetch-1912365
Ref: 243912365
Ref: refman/predicates/threaded_engine_fetch_1 threaded-engine-fetch-1912365
Ref: 612912365
Node: Description<86>912592
Ref: refman/predicates/threaded_engine_fetch_1 description912726
Ref: 613912726
Node: Modes and number of proofs<49>913165
Ref: refman/predicates/threaded_engine_fetch_1 modes-and-number-of-proofs913318
Ref: 614913318
Node: Errors<50>913440
Ref: refman/predicates/threaded_engine_fetch_1 errors913590
Ref: 615913590
Node: Examples<87>913631
Ref: refman/predicates/threaded_engine_fetch_1 examples913742
Ref: 616913742
Node: Compiling and loading source files913926
Ref: refman/predicates/compiling_predicates doc914082
Ref: 617914082
Ref: refman/predicates/compiling_predicates compiling-and-loading-source-files914082
Ref: 618914082
Ref: refman/predicates/compiling_predicates compiling-predicates914082
Ref: 45914082
Node: logtalk_compile/1914404
Ref: refman/predicates/logtalk_compile_1 doc914538
Ref: 619914538
Ref: refman/predicates/logtalk_compile_1 logtalk-compile-1914538
Ref: 61a914538
Ref: refman/predicates/logtalk_compile_1 predicates-logtalk-compile-1914538
Ref: 29e914538
Node: Description<87>914751
Ref: refman/predicates/logtalk_compile_1 description914879
Ref: 61b914879
Node: Modes and number of proofs<50>916401
Ref: refman/predicates/logtalk_compile_1 modes-and-number-of-proofs916548
Ref: 61d916548
Node: Errors<51>916734
Ref: refman/predicates/logtalk_compile_1 errors916878
Ref: 61e916878
Node: Examples<88>917551
Ref: refman/predicates/logtalk_compile_1 examples917656
Ref: 61f917656
Node: logtalk_compile/2918275
Ref: refman/predicates/logtalk_compile_2 doc918432
Ref: 620918432
Ref: refman/predicates/logtalk_compile_2 logtalk-compile-2918432
Ref: 621918432
Ref: refman/predicates/logtalk_compile_2 predicates-logtalk-compile-2918432
Ref: 2b2918432
Node: Description<88>918645
Ref: refman/predicates/logtalk_compile_2 description918773
Ref: 622918773
Node: Modes and number of proofs<51>920773
Ref: refman/predicates/logtalk_compile_2 modes-and-number-of-proofs920920
Ref: 623920920
Node: Errors<52>921150
Ref: refman/predicates/logtalk_compile_2 errors921294
Ref: 624921294
Node: Examples<89>922612
Ref: refman/predicates/logtalk_compile_2 examples922717
Ref: 625922717
Node: logtalk_load/1923483
Ref: refman/predicates/logtalk_load_1 doc923637
Ref: 626923637
Ref: refman/predicates/logtalk_load_1 logtalk-load-1923637
Ref: 627923637
Ref: refman/predicates/logtalk_load_1 predicates-logtalk-load-1923637
Ref: 46923637
Node: Description<89>923846
Ref: refman/predicates/logtalk_load_1 description923971
Ref: 628923971
Node: Modes and number of proofs<52>925601
Ref: refman/predicates/logtalk_load_1 modes-and-number-of-proofs925745
Ref: 629925745
Node: Errors<53>925927
Ref: refman/predicates/logtalk_load_1 errors926068
Ref: 62a926068
Node: Examples<90>926744
Ref: refman/predicates/logtalk_load_1 examples926846
Ref: 62b926846
Node: logtalk_load/2927468
Ref: refman/predicates/logtalk_load_2 doc927619
Ref: 62c927619
Ref: refman/predicates/logtalk_load_2 logtalk-load-2927619
Ref: 62d927619
Ref: refman/predicates/logtalk_load_2 predicates-logtalk-load-2927619
Ref: 4e927619
Node: Description<90>927828
Ref: refman/predicates/logtalk_load_2 description927953
Ref: 62e927953
Node: Modes and number of proofs<53>929958
Ref: refman/predicates/logtalk_load_2 modes-and-number-of-proofs930102
Ref: 62f930102
Node: Errors<54>930328
Ref: refman/predicates/logtalk_load_2 errors930469
Ref: 630930469
Node: Examples<91>931778
Ref: refman/predicates/logtalk_load_2 examples931880
Ref: 631931880
Node: logtalk_make/0932625
Ref: refman/predicates/logtalk_make_0 doc932776
Ref: 632932776
Ref: refman/predicates/logtalk_make_0 logtalk-make-0932776
Ref: 633932776
Ref: refman/predicates/logtalk_make_0 predicates-logtalk-make-0932776
Ref: 29f932776
Node: Description<91>932985
Ref: refman/predicates/logtalk_make_0 description933110
Ref: 634933110
Node: Modes and number of proofs<54>934491
Ref: refman/predicates/logtalk_make_0 modes-and-number-of-proofs934635
Ref: 636934635
Node: Errors<55>934733
Ref: refman/predicates/logtalk_make_0 errors934874
Ref: 637934874
Node: Examples<92>934915
Ref: refman/predicates/logtalk_make_0 examples935017
Ref: 638935017
Node: logtalk_make/1935353
Ref: refman/predicates/logtalk_make_1 doc935518
Ref: 639935518
Ref: refman/predicates/logtalk_make_1 logtalk-make-1935518
Ref: 63a935518
Ref: refman/predicates/logtalk_make_1 predicates-logtalk-make-1935518
Ref: 2a0935518
Node: Description<92>935727
Ref: refman/predicates/logtalk_make_1 description935852
Ref: 63b935852
Ref: Description<92>-Footnote-1940330
Node: Modes and number of proofs<55>940383
Ref: refman/predicates/logtalk_make_1 modes-and-number-of-proofs940527
Ref: 63d940527
Node: Errors<56>940640
Ref: refman/predicates/logtalk_make_1 errors940781
Ref: 63e940781
Node: Examples<93>940822
Ref: refman/predicates/logtalk_make_1 examples940924
Ref: 63f940924
Node: logtalk_make_target_action/1941483
Ref: refman/predicates/logtalk_make_target_action_1 doc941656
Ref: 640941656
Ref: refman/predicates/logtalk_make_target_action_1 logtalk-make-target-action-1941656
Ref: 641941656
Ref: refman/predicates/logtalk_make_target_action_1 predicates-logtalk-make-target-action-1941656
Ref: 635941656
Node: Description<93>941893
Ref: refman/predicates/logtalk_make_target_action_1 description942032
Ref: 642942032
Node: Modes and number of proofs<56>942405
Ref: refman/predicates/logtalk_make_target_action_1 modes-and-number-of-proofs942563
Ref: 643942563
Node: Errors<57>942691
Ref: refman/predicates/logtalk_make_target_action_1 errors942846
Ref: 644942846
Node: Examples<94>942887
Ref: refman/predicates/logtalk_make_target_action_1 examples943003
Ref: 645943003
Node: logtalk_library_path/2943374
Ref: refman/predicates/logtalk_library_path_2 doc943555
Ref: 646943555
Ref: refman/predicates/logtalk_library_path_2 logtalk-library-path-2943555
Ref: 647943555
Ref: refman/predicates/logtalk_library_path_2 predicates-logtalk-library-path-2943555
Ref: 2a7943555
Node: Description<94>943780
Ref: refman/predicates/logtalk_library_path_2 description943913
Ref: 648943913
Ref: Description<94>-Footnote-1946771
Node: Modes and number of proofs<57>946840
Ref: refman/predicates/logtalk_library_path_2 modes-and-number-of-proofs946992
Ref: 64a946992
Node: Errors<58>947180
Ref: refman/predicates/logtalk_library_path_2 errors947329
Ref: 64b947329
Node: Examples<95>947370
Ref: refman/predicates/logtalk_library_path_2 examples947480
Ref: 64c947480
Node: logtalk_load_context/2948615
Ref: refman/predicates/logtalk_load_context_2 doc948759
Ref: 64d948759
Ref: refman/predicates/logtalk_load_context_2 logtalk-load-context-2948759
Ref: 64e948759
Ref: refman/predicates/logtalk_load_context_2 predicates-logtalk-load-context-2948759
Ref: 317948759
Node: Description<95>948984
Ref: refman/predicates/logtalk_load_context_2 description949117
Ref: 64f949117
Node: Modes and number of proofs<58>952758
Ref: refman/predicates/logtalk_load_context_2 modes-and-number-of-proofs952910
Ref: 650952910
Node: Errors<59>953045
Ref: refman/predicates/logtalk_load_context_2 errors953194
Ref: 651953194
Node: Examples<96>953443
Ref: refman/predicates/logtalk_load_context_2 examples953553
Ref: 652953553
Node: Flags954267
Ref: refman/predicates/flag_predicates doc954406
Ref: 653954406
Ref: refman/predicates/flag_predicates flag-predicates954406
Ref: 654954406
Ref: refman/predicates/flag_predicates flags954406
Ref: 655954406
Node: current_logtalk_flag/2954563
Ref: refman/predicates/current_logtalk_flag_2 doc954677
Ref: 656954677
Ref: refman/predicates/current_logtalk_flag_2 current-logtalk-flag-2954677
Ref: 657954677
Ref: refman/predicates/current_logtalk_flag_2 predicates-current-logtalk-flag-2954677
Ref: 2b3954677
Node: Description<96>954902
Ref: refman/predicates/current_logtalk_flag_2 description955035
Ref: 658955035
Node: Modes and number of proofs<59>955304
Ref: refman/predicates/current_logtalk_flag_2 modes-and-number-of-proofs955456
Ref: 659955456
Node: Errors<60>955585
Ref: refman/predicates/current_logtalk_flag_2 errors955734
Ref: 65a955734
Node: Examples<97>955948
Ref: refman/predicates/current_logtalk_flag_2 examples956058
Ref: 65b956058
Node: set_logtalk_flag/2<2>956308
Ref: refman/predicates/set_logtalk_flag_2 doc956452
Ref: 65c956452
Ref: refman/predicates/set_logtalk_flag_2 predicates-set-logtalk-flag-2956452
Ref: 51956452
Ref: refman/predicates/set_logtalk_flag_2 set-logtalk-flag-2956452
Ref: 65d956452
Node: Description<97>956669
Ref: refman/predicates/set_logtalk_flag_2 description956801
Ref: 65e956801
Node: Modes and number of proofs<60>957283
Ref: refman/predicates/set_logtalk_flag_2 modes-and-number-of-proofs957434
Ref: 65f957434
Node: Errors<61>957552
Ref: refman/predicates/set_logtalk_flag_2 errors957700
Ref: 660957700
Node: Examples<98>958252
Ref: refman/predicates/set_logtalk_flag_2 examples958361
Ref: 661958361
Node: create_logtalk_flag/3958653
Ref: refman/predicates/create_logtalk_flag_3 doc958766
Ref: 662958766
Ref: refman/predicates/create_logtalk_flag_3 create-logtalk-flag-3958766
Ref: 663958766
Ref: refman/predicates/create_logtalk_flag_3 predicates-create-logtalk-flag-3958766
Ref: 2e6958766
Node: Description<98>958991
Ref: refman/predicates/create_logtalk_flag_3 description959123
Ref: 664959123
Node: Modes and number of proofs<61>960323
Ref: refman/predicates/create_logtalk_flag_3 modes-and-number-of-proofs960474
Ref: 665960474
Node: Errors<62>960612
Ref: refman/predicates/create_logtalk_flag_3 errors960760
Ref: 666960760
Node: Examples<99>961659
Ref: refman/predicates/create_logtalk_flag_3 examples961768
Ref: 667961768
Node: Linter962021
Ref: refman/predicates/linter_predicates doc962117
Ref: 668962117
Ref: refman/predicates/linter_predicates linter962117
Ref: 669962117
Ref: refman/predicates/linter_predicates linter-predicates962117
Ref: 66a962117
Node: logtalk_linter_hook/7962204
Ref: refman/predicates/logtalk_linter_hook_7 doc962288
Ref: 66b962288
Ref: refman/predicates/logtalk_linter_hook_7 logtalk-linter-hook-7962288
Ref: 66c962288
Ref: refman/predicates/logtalk_linter_hook_7 predicates-logtalk-linter-hook-7962288
Ref: 66d962288
Node: Description<99>962512
Ref: refman/predicates/logtalk_linter_hook_7 description962644
Ref: 66e962644
Node: Modes and number of proofs<62>963255
Ref: refman/predicates/logtalk_linter_hook_7 modes-and-number-of-proofs963406
Ref: 66f963406
Node: Errors<63>963599
Ref: refman/predicates/logtalk_linter_hook_7 errors963748
Ref: 670963748
Node: Examples<100>963789
Ref: refman/predicates/logtalk_linter_hook_7 examples963899
Ref: 671963899
Node: Built-in methods<2>964329
Ref: refman/methods/index doc964449
Ref: 672964449
Ref: refman/methods/index built-in-methods964449
Ref: 673964449
Node: Logic and control964903
Ref: refman/methods/logic_and_control_methods doc965022
Ref: 674965022
Ref: refman/methods/logic_and_control_methods logic-and-control965022
Ref: 675965022
Ref: refman/methods/logic_and_control_methods logic-and-control-methods965022
Ref: 676965022
Node: !/0965155
Ref: refman/methods/cut_0 doc965247
Ref: 677965247
Ref: refman/methods/cut_0 id1965247
Ref: 678965247
Ref: refman/methods/cut_0 methods-cut-0965247
Ref: 196965247
Node: Description<100>965434
Ref: refman/methods/cut_0 description965549
Ref: 679965549
Node: Modes and number of proofs<63>965807
Ref: refman/methods/cut_0 modes-and-number-of-proofs965941
Ref: 67a965941
Node: Errors<64>966026
Ref: refman/methods/cut_0 errors966157
Ref: 67b966157
Node: Examples<101>966196
Ref: refman/methods/cut_0 examples966288
Ref: 67c966288
Node: true/0966449
Ref: refman/methods/true_0 doc966556
Ref: 67d966556
Ref: refman/methods/true_0 methods-true-0966556
Ref: 197966556
Ref: refman/methods/true_0 true-0966556
Ref: 67e966556
Node: Description<101>966749
Ref: refman/methods/true_0 description966867
Ref: 67f966867
Node: Modes and number of proofs<64>967079
Ref: refman/methods/true_0 modes-and-number-of-proofs967216
Ref: 680967216
Node: Errors<65>967304
Ref: refman/methods/true_0 errors967438
Ref: 681967438
Node: Examples<102>967477
Ref: refman/methods/true_0 examples967572
Ref: 682967572
Node: fail/0967732
Ref: refman/methods/fail_0 doc967843
Ref: 683967843
Ref: refman/methods/fail_0 fail-0967843
Ref: 684967843
Ref: refman/methods/fail_0 methods-fail-0967843
Ref: 198967843
Node: Description<102>968038
Ref: refman/methods/fail_0 description968156
Ref: 685968156
Node: Modes and number of proofs<65>968367
Ref: refman/methods/fail_0 modes-and-number-of-proofs968504
Ref: 686968504
Node: Errors<66>968594
Ref: refman/methods/fail_0 errors968728
Ref: 687968728
Node: Examples<103>968769
Ref: refman/methods/fail_0 examples968864
Ref: 688968864
Node: false/0969024
Ref: refman/methods/false_0 doc969137
Ref: 689969137
Ref: refman/methods/false_0 false-0969137
Ref: 68a969137
Ref: refman/methods/false_0 methods-false-0969137
Ref: 199969137
Node: Description<103>969334
Ref: refman/methods/false_0 description969453
Ref: 68b969453
Node: Modes and number of proofs<66>969665
Ref: refman/methods/false_0 modes-and-number-of-proofs969803
Ref: 68c969803
Node: Errors<67>969894
Ref: refman/methods/false_0 errors970029
Ref: 68d970029
Node: Examples<104>970070
Ref: refman/methods/false_0 examples970166
Ref: 68e970166
Node: repeat/0970325
Ref: refman/methods/repeat_0 doc970423
Ref: 68f970423
Ref: refman/methods/repeat_0 methods-repeat-0970423
Ref: 19a970423
Ref: refman/methods/repeat_0 repeat-0970423
Ref: 690970423
Node: Description<104>970622
Ref: refman/methods/repeat_0 description970742
Ref: 691970742
Node: Modes and number of proofs<67>971047
Ref: refman/methods/repeat_0 modes-and-number-of-proofs971186
Ref: 692971186
Node: Errors<68>971286
Ref: refman/methods/repeat_0 errors971422
Ref: 693971422
Node: Examples<105>971463
Ref: refman/methods/repeat_0 examples971560
Ref: 694971560
Node: Execution context971699
Ref: refman/methods/context_methods doc971840
Ref: 695971840
Ref: refman/methods/context_methods context-methods971840
Ref: 35f971840
Ref: refman/methods/context_methods execution-context971840
Ref: 696971840
Node: context/1971983
Ref: refman/methods/context_1 doc972086
Ref: 697972086
Ref: refman/methods/context_1 context-1972086
Ref: 698972086
Ref: refman/methods/context_1 methods-context-1972086
Ref: 19e972086
Node: Description<105>972285
Ref: refman/methods/context_1 description972406
Ref: 699972406
Ref: Description<105>-Footnote-1973360
Node: Modes and number of proofs<68>973427
Ref: refman/methods/context_1 modes-and-number-of-proofs973567
Ref: 69a973567
Node: Errors<69>973670
Ref: refman/methods/context_1 errors973807
Ref: 69b973807
Node: Examples<106>973846
Ref: refman/methods/context_1 examples973944
Ref: 69c973944
Node: parameter/2974314
Ref: refman/methods/parameter_2 doc974432
Ref: 69d974432
Ref: refman/methods/parameter_2 methods-parameter-2974432
Ref: a2974432
Ref: refman/methods/parameter_2 parameter-2974432
Ref: 69e974432
Node: Description<106>974635
Ref: refman/methods/parameter_2 description974758
Ref: 69f974758
Node: Modes and number of proofs<69>975802
Ref: refman/methods/parameter_2 modes-and-number-of-proofs975944
Ref: 6a1975944
Node: Errors<70>976062
Ref: refman/methods/parameter_2 errors976201
Ref: 6a2976201
Node: Examples<107>976651
Ref: refman/methods/parameter_2 examples976751
Ref: 6a3976751
Node: self/1977474
Ref: refman/methods/self_1 doc977591
Ref: 6a4977591
Ref: refman/methods/self_1 methods-self-1977591
Ref: 67977591
Ref: refman/methods/self_1 self-1977591
Ref: 6a5977591
Node: Description<107>977786
Ref: refman/methods/self_1 description977904
Ref: 6a6977904
Node: Modes and number of proofs<70>978323
Ref: refman/methods/self_1 modes-and-number-of-proofs978460
Ref: 6a7978460
Node: Errors<71>978578
Ref: refman/methods/self_1 errors978712
Ref: 6a8978712
Node: Examples<108>978753
Ref: refman/methods/self_1 examples978848
Ref: 6a9978848
Node: sender/1979213
Ref: refman/methods/sender_1 doc979325
Ref: 6aa979325
Ref: refman/methods/sender_1 methods-sender-1979325
Ref: 19d979325
Ref: refman/methods/sender_1 sender-1979325
Ref: 6ab979325
Node: Description<108>979524
Ref: refman/methods/sender_1 description979644
Ref: 6ac979644
Node: Modes and number of proofs<71>980065
Ref: refman/methods/sender_1 modes-and-number-of-proofs980204
Ref: 6ad980204
Node: Errors<72>980324
Ref: refman/methods/sender_1 errors980460
Ref: 6ae980460
Node: Examples<109>980501
Ref: refman/methods/sender_1 examples980598
Ref: 6af980598
Node: this/1980982
Ref: refman/methods/this_1 doc981079
Ref: 6b0981079
Ref: refman/methods/this_1 methods-this-1981079
Ref: 68981079
Ref: refman/methods/this_1 this-1981079
Ref: 6b1981079
Node: Description<109>981274
Ref: refman/methods/this_1 description981392
Ref: 6b2981392
Node: Modes and number of proofs<72>982186
Ref: refman/methods/this_1 modes-and-number-of-proofs982323
Ref: 6b3982323
Node: Errors<73>982441
Ref: refman/methods/this_1 errors982575
Ref: 6b4982575
Node: Examples<110>982616
Ref: refman/methods/this_1 examples982711
Ref: 6b5982711
Node: Reflection<2>983064
Ref: refman/methods/reflection_methods doc983196
Ref: 6b6983196
Ref: refman/methods/reflection_methods reflection983196
Ref: 6b7983196
Ref: refman/methods/reflection_methods reflection-methods983196
Ref: 70983196
Node: current_op/3983326
Ref: refman/methods/current_op_3 doc983436
Ref: 6b8983436
Ref: refman/methods/current_op_3 current-op-3983436
Ref: 6b9983436
Ref: refman/methods/current_op_3 methods-current-op-3983436
Ref: 15e983436
Node: Description<110>983641
Ref: refman/methods/current_op_3 description983765
Ref: 6ba983765
Node: Modes and number of proofs<73>983998
Ref: refman/methods/current_op_3 modes-and-number-of-proofs984141
Ref: 6bb984141
Node: Errors<74>984292
Ref: refman/methods/current_op_3 errors984432
Ref: 6bc984432
Node: Examples<111>985021
Ref: refman/methods/current_op_3 examples985122
Ref: 6bd985122
Node: current_predicate/1985753
Ref: refman/methods/current_predicate_1 doc985892
Ref: 6be985892
Ref: refman/methods/current_predicate_1 current-predicate-1985892
Ref: 6bf985892
Ref: refman/methods/current_predicate_1 methods-current-predicate-1985892
Ref: 141985892
Node: Description<111>986111
Ref: refman/methods/current_predicate_1 description986242
Ref: 6c0986242
Node: Modes and number of proofs<74>986786
Ref: refman/methods/current_predicate_1 modes-and-number-of-proofs986936
Ref: 6c1986936
Node: Errors<75>987068
Ref: refman/methods/current_predicate_1 errors987215
Ref: 6c2987215
Node: Examples<112>987810
Ref: refman/methods/current_predicate_1 examples987918
Ref: 6c3987918
Node: predicate_property/2989000
Ref: refman/methods/predicate_property_2 doc989118
Ref: 6c4989118
Ref: refman/methods/predicate_property_2 methods-predicate-property-2989118
Ref: 142989118
Ref: refman/methods/predicate_property_2 predicate-property-2989118
Ref: 6c5989118
Node: Description<112>989341
Ref: refman/methods/predicate_property_2 description989473
Ref: 6c6989473
Node: Modes and number of proofs<75>990278
Ref: refman/methods/predicate_property_2 modes-and-number-of-proofs990429
Ref: 6c7990429
Node: Errors<76>990574
Ref: refman/methods/predicate_property_2 errors990722
Ref: 6c8990722
Node: Examples<113>991073
Ref: refman/methods/predicate_property_2 examples991182
Ref: 6c9991182
Node: Database992407
Ref: refman/methods/database_methods doc992532
Ref: 6ca992532
Ref: refman/methods/database_methods database992532
Ref: 6cb992532
Ref: refman/methods/database_methods database-methods992532
Ref: 6cc992532
Node: abolish/1992678
Ref: refman/methods/abolish_1 doc992770
Ref: 6cd992770
Ref: refman/methods/abolish_1 abolish-1992770
Ref: 6ce992770
Ref: refman/methods/abolish_1 methods-abolish-1992770
Ref: 1b1992770
Node: Description<113>992969
Ref: refman/methods/abolish_1 description993090
Ref: 6cf993090
Node: Modes and number of proofs<76>993690
Ref: refman/methods/abolish_1 modes-and-number-of-proofs993830
Ref: 6d0993830
Node: Errors<77>993943
Ref: refman/methods/abolish_1 errors994080
Ref: 6d1994080
Node: Examples<114>995267
Ref: refman/methods/abolish_1 examples995365
Ref: 6d2995365
Node: asserta/1995980
Ref: refman/methods/asserta_1 doc996090
Ref: 6d3996090
Ref: refman/methods/asserta_1 asserta-1996090
Ref: 6d4996090
Ref: refman/methods/asserta_1 methods-asserta-1996090
Ref: 1b2996090
Node: Description<114>996289
Ref: refman/methods/asserta_1 description996410
Ref: 6d5996410
Node: Modes and number of proofs<77>997803
Ref: refman/methods/asserta_1 modes-and-number-of-proofs997943
Ref: 6d6997943
Node: Errors<78>998043
Ref: refman/methods/asserta_1 errors998180
Ref: 6d7998180
Node: Examples<115>999254
Ref: refman/methods/asserta_1 examples999352
Ref: 6d8999352
Node: assertz/11001053
Ref: refman/methods/assertz_1 doc1001162
Ref: 6d91001162
Ref: refman/methods/assertz_1 assertz-11001162
Ref: 6da1001162
Ref: refman/methods/assertz_1 methods-assertz-11001162
Ref: 1b31001162
Node: Description<115>1001363
Ref: refman/methods/assertz_1 description1001484
Ref: 6db1001484
Node: Modes and number of proofs<78>1002870
Ref: refman/methods/assertz_1 modes-and-number-of-proofs1003010
Ref: 6dc1003010
Node: Errors<79>1003112
Ref: refman/methods/assertz_1 errors1003249
Ref: 6dd1003249
Node: Examples<116>1004322
Ref: refman/methods/assertz_1 examples1004420
Ref: 6de1004420
Node: clause/21006118
Ref: refman/methods/clause_2 doc1006227
Ref: 6df1006227
Ref: refman/methods/clause_2 clause-21006227
Ref: 6e01006227
Ref: refman/methods/clause_2 methods-clause-21006227
Ref: 1b41006227
Node: Description<116>1006426
Ref: refman/methods/clause_2 description1006546
Ref: 6e11006546
Node: Modes and number of proofs<79>1007152
Ref: refman/methods/clause_2 modes-and-number-of-proofs1007291
Ref: 6e21007291
Node: Errors<80>1007410
Ref: refman/methods/clause_2 errors1007546
Ref: 6e31007546
Node: Examples<117>1008463
Ref: refman/methods/clause_2 examples1008560
Ref: 6e41008560
Node: retract/11009244
Ref: refman/methods/retract_1 doc1009356
Ref: 6e51009356
Ref: refman/methods/retract_1 methods-retract-11009356
Ref: 1b51009356
Ref: refman/methods/retract_1 retract-11009356
Ref: 6e61009356
Node: Description<117>1009557
Ref: refman/methods/retract_1 description1009678
Ref: 6e71009678
Node: Modes and number of proofs<80>1010349
Ref: refman/methods/retract_1 modes-and-number-of-proofs1010489
Ref: 6e81010489
Node: Errors<81>1010600
Ref: refman/methods/retract_1 errors1010737
Ref: 6e91010737
Node: Examples<118>1011586
Ref: refman/methods/retract_1 examples1011684
Ref: 6ea1011684
Node: retractall/11012326
Ref: refman/methods/retractall_1 doc1012421
Ref: 6eb1012421
Ref: refman/methods/retractall_1 methods-retractall-11012421
Ref: 1b61012421
Ref: refman/methods/retractall_1 retractall-11012421
Ref: 6ec1012421
Node: Description<118>1012628
Ref: refman/methods/retractall_1 description1012752
Ref: 6ed1012752
Node: Modes and number of proofs<81>1013358
Ref: refman/methods/retractall_1 modes-and-number-of-proofs1013501
Ref: 6ee1013501
Node: Errors<82>1013608
Ref: refman/methods/retractall_1 errors1013748
Ref: 6ef1013748
Node: Examples<119>1014597
Ref: refman/methods/retractall_1 examples1014698
Ref: 6f01014698
Node: Meta-calls1015366
Ref: refman/methods/meta_call_methods doc1015495
Ref: 6f11015495
Ref: refman/methods/meta_call_methods meta-call-methods1015495
Ref: 6f21015495
Ref: refman/methods/meta_call_methods meta-calls1015495
Ref: 6f31015495
Node: call/1-N1015613
Ref: refman/methods/call_N doc1015705
Ref: 6f41015705
Ref: refman/methods/call_N call-1-n1015705
Ref: 6f51015705
Ref: refman/methods/call_N methods-call-n1015705
Ref: 1811015705
Node: Description<119>1015957
Ref: refman/methods/call_N description1016073
Ref: 6f61016073
Node: Meta-predicate template<6>1016780
Ref: refman/methods/call_N meta-predicate-template1016935
Ref: 6f71016935
Node: Modes and number of proofs<82>1017058
Ref: refman/methods/call_N modes-and-number-of-proofs1017207
Ref: 6f81017207
Node: Errors<83>1017417
Ref: refman/methods/call_N errors1017553
Ref: 6f91017553
Node: Examples<120>1017932
Ref: refman/methods/call_N examples1018029
Ref: 6fa1018029
Node: ignore/11018685
Ref: refman/methods/ignore_1 doc1018792
Ref: 6fb1018792
Ref: refman/methods/ignore_1 ignore-11018792
Ref: 6fc1018792
Ref: refman/methods/ignore_1 methods-ignore-11018792
Ref: 1801018792
Node: Description<120>1019044
Ref: refman/methods/ignore_1 description1019160
Ref: 6fd1019160
Node: Meta-predicate template<7>1019482
Ref: refman/methods/ignore_1 meta-predicate-template1019637
Ref: 6fe1019637
Node: Modes and number of proofs<83>1019718
Ref: refman/methods/ignore_1 modes-and-number-of-proofs1019867
Ref: 6ff1019867
Node: Errors<84>1019970
Ref: refman/methods/ignore_1 errors1020106
Ref: 7001020106
Node: Examples<121>1020309
Ref: refman/methods/ignore_1 examples1020406
Ref: 7011020406
Node: once/11020834
Ref: refman/methods/once_1 doc1020938
Ref: 7021020938
Ref: refman/methods/once_1 methods-once-11020938
Ref: 1bb1020938
Ref: refman/methods/once_1 once-11020938
Ref: 7031020938
Node: Description<121>1021188
Ref: refman/methods/once_1 description1021302
Ref: 7041021302
Node: Meta-predicate template<8>1021603
Ref: refman/methods/once_1 meta-predicate-template1021756
Ref: 7051021756
Node: Modes and number of proofs<84>1021837
Ref: refman/methods/once_1 modes-and-number-of-proofs1021984
Ref: 7061021984
Node: Errors<85>1022093
Ref: refman/methods/once_1 errors1022227
Ref: 7071022227
Node: Examples<122>1022430
Ref: refman/methods/once_1 examples1022525
Ref: 7081022525
Node: \+ /11022994
Ref: refman/methods/not_1 doc1023081
Ref: 7091023081
Ref: refman/methods/not_1 id11023081
Ref: 70a1023081
Ref: refman/methods/not_1 methods-not-11023081
Ref: 1bc1023081
Node: Description<122>1023331
Ref: refman/methods/not_1 description1023444
Ref: 70b1023444
Node: Meta-predicate template<9>1024580
Ref: refman/methods/not_1 meta-predicate-template1024732
Ref: 70c1024732
Node: Modes and number of proofs<85>1024810
Ref: refman/methods/not_1 modes-and-number-of-proofs1024956
Ref: 70d1024956
Node: Errors<86>1025062
Ref: refman/methods/not_1 errors1025195
Ref: 70e1025195
Node: Examples<123>1025398
Ref: refman/methods/not_1 examples1025492
Ref: 70f1025492
Node: Error handling<2>1025903
Ref: refman/methods/error_handling_methods doc1026037
Ref: 7101026037
Ref: refman/methods/error_handling_methods error-handling1026037
Ref: 7111026037
Ref: refman/methods/error_handling_methods error-handling-methods1026037
Ref: 24c1026037
Node: catch/31026401
Ref: refman/methods/catch_3 doc1026498
Ref: 7121026498
Ref: refman/methods/catch_3 catch-31026498
Ref: 7131026498
Ref: refman/methods/catch_3 methods-catch-31026498
Ref: 1a11026498
Node: Description<123>1026693
Ref: refman/methods/catch_3 description1026812
Ref: 7141026812
Node: Modes and number of proofs<86>1027209
Ref: refman/methods/catch_3 modes-and-number-of-proofs1027347
Ref: 7151027347
Node: Errors<87>1027474
Ref: refman/methods/catch_3 errors1027609
Ref: 7161027609
Node: Examples<124>1027648
Ref: refman/methods/catch_3 examples1027744
Ref: 7171027744
Node: throw/11028232
Ref: refman/methods/throw_1 doc1028359
Ref: 7191028359
Ref: refman/methods/throw_1 methods-throw-11028359
Ref: 1a21028359
Ref: refman/methods/throw_1 throw-11028359
Ref: 71a1028359
Node: Description<124>1028554
Ref: refman/methods/throw_1 description1028673
Ref: 71b1028673
Node: Modes and number of proofs<87>1028898
Ref: refman/methods/throw_1 modes-and-number-of-proofs1029036
Ref: 71c1029036
Node: Errors<88>1029136
Ref: refman/methods/throw_1 errors1029271
Ref: 71d1029271
Node: Examples<125>1029501
Ref: refman/methods/throw_1 examples1029597
Ref: 71e1029597
Node: instantiation_error/01030087
Ref: refman/methods/instantiation_error_0 doc1030230
Ref: 71f1030230
Ref: refman/methods/instantiation_error_0 instantiation-error-01030230
Ref: 7201030230
Ref: refman/methods/instantiation_error_0 methods-instantiation-error-01030230
Ref: 1a31030230
Node: Description<125>1030455
Ref: refman/methods/instantiation_error_0 description1030588
Ref: 7211030588
Node: Modes and number of proofs<88>1031201
Ref: refman/methods/instantiation_error_0 modes-and-number-of-proofs1031353
Ref: 7221031353
Node: Errors<89>1031460
Ref: refman/methods/instantiation_error_0 errors1031609
Ref: 7231031609
Node: Examples<126>1031697
Ref: refman/methods/instantiation_error_0 examples1031807
Ref: 7241031807
Node: uninstantiation_error/11032331
Ref: refman/methods/uninstantiation_error_1 doc1032479
Ref: 7251032479
Ref: refman/methods/uninstantiation_error_1 methods-uninstantiation-error-11032479
Ref: 1a41032479
Ref: refman/methods/uninstantiation_error_1 uninstantiation-error-11032479
Ref: 7261032479
Node: Description<126>1032708
Ref: refman/methods/uninstantiation_error_1 description1032843
Ref: 7271032843
Node: Modes and number of proofs<89>1033453
Ref: refman/methods/uninstantiation_error_1 modes-and-number-of-proofs1033607
Ref: 7281033607
Node: Errors<90>1033725
Ref: refman/methods/uninstantiation_error_1 errors1033876
Ref: 7291033876
Node: Examples<127>1033975
Ref: refman/methods/uninstantiation_error_1 examples1034087
Ref: 72a1034087
Node: type_error/21034622
Ref: refman/methods/type_error_2 doc1034763
Ref: 72b1034763
Ref: refman/methods/type_error_2 methods-type-error-21034763
Ref: 1a51034763
Ref: refman/methods/type_error_2 type-error-21034763
Ref: 72c1034763
Node: Description<127>1034970
Ref: refman/methods/type_error_2 description1035094
Ref: 72d1035094
Node: Modes and number of proofs<90>1035902
Ref: refman/methods/type_error_2 modes-and-number-of-proofs1036045
Ref: 72e1036045
Node: Errors<91>1036159
Ref: refman/methods/type_error_2 errors1036299
Ref: 72f1036299
Node: Examples<128>1036393
Ref: refman/methods/type_error_2 examples1036494
Ref: 7301036494
Node: domain_error/21037031
Ref: refman/methods/domain_error_2 doc1037168
Ref: 7311037168
Ref: refman/methods/domain_error_2 domain-error-21037168
Ref: 7321037168
Ref: refman/methods/domain_error_2 methods-domain-error-21037168
Ref: 1a61037168
Node: Description<128>1037379
Ref: refman/methods/domain_error_2 description1037505
Ref: 7331037505
Node: Modes and number of proofs<91>1039390
Ref: refman/methods/domain_error_2 modes-and-number-of-proofs1039535
Ref: 7341039535
Node: Errors<92>1039651
Ref: refman/methods/domain_error_2 errors1039793
Ref: 7351039793
Node: Examples<129>1039891
Ref: refman/methods/domain_error_2 examples1039994
Ref: 7361039994
Node: consistency_error/31040553
Ref: refman/methods/consistency_error_3 doc1040695
Ref: 7371040695
Ref: refman/methods/consistency_error_3 consistency-error-31040695
Ref: 7381040695
Ref: refman/methods/consistency_error_3 methods-consistency-error-31040695
Ref: 7181040695
Node: Description<129>1040916
Ref: refman/methods/consistency_error_3 description1041047
Ref: 7391041047
Node: Modes and number of proofs<92>1041940
Ref: refman/methods/consistency_error_3 modes-and-number-of-proofs1042090
Ref: 73a1042090
Node: Errors<93>1042220
Ref: refman/methods/consistency_error_3 errors1042367
Ref: 73b1042367
Node: Examples<130>1042488
Ref: refman/methods/consistency_error_3 examples1042596
Ref: 73c1042596
Node: existence_error/21043541
Ref: refman/methods/existence_error_2 doc1043687
Ref: 73d1043687
Ref: refman/methods/existence_error_2 existence-error-21043687
Ref: 73e1043687
Ref: refman/methods/existence_error_2 methods-existence-error-21043687
Ref: 1a71043687
Node: Description<130>1043904
Ref: refman/methods/existence_error_2 description1044033
Ref: 73f1044033
Node: Modes and number of proofs<93>1045040
Ref: refman/methods/existence_error_2 modes-and-number-of-proofs1045188
Ref: 7401045188
Node: Errors<94>1045309
Ref: refman/methods/existence_error_2 errors1045454
Ref: 7411045454
Node: Examples<131>1045554
Ref: refman/methods/existence_error_2 examples1045660
Ref: 7421045660
Node: permission_error/31046215
Ref: refman/methods/permission_error_3 doc1046364
Ref: 7431046364
Ref: refman/methods/permission_error_3 methods-permission-error-31046364
Ref: 1a81046364
Ref: refman/methods/permission_error_3 permission-error-31046364
Ref: 7441046364
Node: Description<131>1046583
Ref: refman/methods/permission_error_3 description1046713
Ref: 7451046713
Node: Modes and number of proofs<94>1048250
Ref: refman/methods/permission_error_3 modes-and-number-of-proofs1048399
Ref: 7461048399
Node: Errors<95>1048530
Ref: refman/methods/permission_error_3 errors1048676
Ref: 7471048676
Node: Examples<132>1048797
Ref: refman/methods/permission_error_3 examples1048904
Ref: 7481048904
Node: representation_error/11049453
Ref: refman/methods/representation_error_1 doc1049603
Ref: 7491049603
Ref: refman/methods/representation_error_1 methods-representation-error-11049603
Ref: 1a91049603
Ref: refman/methods/representation_error_1 representation-error-11049603
Ref: 74a1049603
Node: Description<132>1049830
Ref: refman/methods/representation_error_1 description1049964
Ref: 74b1049964
Node: Modes and number of proofs<95>1050852
Ref: refman/methods/representation_error_1 modes-and-number-of-proofs1051005
Ref: 74c1051005
Node: Errors<96>1051120
Ref: refman/methods/representation_error_1 errors1051270
Ref: 74d1051270
Node: Examples<133>1051365
Ref: refman/methods/representation_error_1 examples1051476
Ref: 74e1051476
Node: evaluation_error/11052014
Ref: refman/methods/evaluation_error_1 doc1052162
Ref: 74f1052162
Ref: refman/methods/evaluation_error_1 evaluation-error-11052162
Ref: 7501052162
Ref: refman/methods/evaluation_error_1 methods-evaluation-error-11052162
Ref: 1aa1052162
Node: Description<133>1052381
Ref: refman/methods/evaluation_error_1 description1052511
Ref: 7511052511
Node: Modes and number of proofs<96>1053182
Ref: refman/methods/evaluation_error_1 modes-and-number-of-proofs1053331
Ref: 7521053331
Node: Errors<97>1053444
Ref: refman/methods/evaluation_error_1 errors1053590
Ref: 7531053590
Node: Examples<134>1053686
Ref: refman/methods/evaluation_error_1 examples1053793
Ref: 7541053793
Node: resource_error/11054332
Ref: refman/methods/resource_error_1 doc1054472
Ref: 7551054472
Ref: refman/methods/resource_error_1 methods-resource-error-11054472
Ref: 1ab1054472
Ref: refman/methods/resource_error_1 resource-error-11054472
Ref: 7561054472
Node: Description<134>1054687
Ref: refman/methods/resource_error_1 description1054815
Ref: 7571054815
Node: Modes and number of proofs<97>1055523
Ref: refman/methods/resource_error_1 modes-and-number-of-proofs1055670
Ref: 7581055670
Node: Errors<98>1055781
Ref: refman/methods/resource_error_1 errors1055925
Ref: 7591055925
Node: Examples<135>1056018
Ref: refman/methods/resource_error_1 examples1056123
Ref: 75a1056123
Node: syntax_error/11056620
Ref: refman/methods/syntax_error_1 doc1056756
Ref: 75b1056756
Ref: refman/methods/syntax_error_1 methods-syntax-error-11056756
Ref: 1ac1056756
Ref: refman/methods/syntax_error_1 syntax-error-11056756
Ref: 75c1056756
Node: Description<135>1056967
Ref: refman/methods/syntax_error_1 description1057093
Ref: 75d1057093
Node: Modes and number of proofs<98>1057607
Ref: refman/methods/syntax_error_1 modes-and-number-of-proofs1057752
Ref: 75e1057752
Node: Errors<99>1057861
Ref: refman/methods/syntax_error_1 errors1058003
Ref: 75f1058003
Node: Examples<136>1058097
Ref: refman/methods/syntax_error_1 examples1058200
Ref: 7601058200
Node: system_error/01058652
Ref: refman/methods/system_error_0 doc1058763
Ref: 7611058763
Ref: refman/methods/system_error_0 methods-system-error-01058763
Ref: 1ad1058763
Ref: refman/methods/system_error_0 system-error-01058763
Ref: 7621058763
Node: Description<136>1058975
Ref: refman/methods/system_error_0 description1059101
Ref: 7631059101
Node: Modes and number of proofs<99>1059626
Ref: refman/methods/system_error_0 modes-and-number-of-proofs1059772
Ref: 7641059772
Node: Errors<100>1059872
Ref: refman/methods/system_error_0 errors1060015
Ref: 7651060015
Node: Examples<137>1060096
Ref: refman/methods/system_error_0 examples1060200
Ref: 7661060200
Node: All solutions1060664
Ref: refman/methods/solution_methods doc1060805
Ref: 7671060805
Ref: refman/methods/solution_methods all-solutions1060805
Ref: 7681060805
Ref: refman/methods/solution_methods solutions-methods1060805
Ref: 7691060805
Node: bagof/31060940
Ref: refman/methods/bagof_3 doc1061035
Ref: 76a1061035
Ref: refman/methods/bagof_3 bagof-31061035
Ref: 76b1061035
Ref: refman/methods/bagof_3 methods-bagof-31061035
Ref: 1bf1061035
Node: Description<137>1061288
Ref: refman/methods/bagof_3 description1061404
Ref: 76c1061404
Node: Meta-predicate template<10>1062302
Ref: refman/methods/bagof_3 meta-predicate-template1062458
Ref: 76d1062458
Node: Modes and number of proofs<100>1062544
Ref: refman/methods/bagof_3 modes-and-number-of-proofs1062695
Ref: 76e1062695
Node: Errors<101>1062818
Ref: refman/methods/bagof_3 errors1062955
Ref: 76f1062955
Node: Examples<138>1063265
Ref: refman/methods/bagof_3 examples1063362
Ref: 7701063362
Node: findall/31063913
Ref: refman/methods/findall_3 doc1064026
Ref: 7711064026
Ref: refman/methods/findall_3 findall-31064026
Ref: 7721064026
Ref: refman/methods/findall_3 methods-findall-31064026
Ref: 1c01064026
Node: Description<138>1064283
Ref: refman/methods/findall_3 description1064401
Ref: 7731064401
Node: Meta-predicate template<11>1064784
Ref: refman/methods/findall_3 meta-predicate-template1064942
Ref: 7741064942
Node: Modes and number of proofs<101>1065030
Ref: refman/methods/findall_3 modes-and-number-of-proofs1065183
Ref: 7751065183
Node: Errors<102>1065309
Ref: refman/methods/findall_3 errors1065448
Ref: 7761065448
Node: Examples<139>1065760
Ref: refman/methods/findall_3 examples1065859
Ref: 7771065859
Node: findall/41066401
Ref: refman/methods/findall_4 doc1066515
Ref: 7781066515
Ref: refman/methods/findall_4 findall-41066515
Ref: 7791066515
Ref: refman/methods/findall_4 methods-findall-41066515
Ref: 1c11066515
Node: Description<139>1066774
Ref: refman/methods/findall_4 description1066892
Ref: 77a1066892
Node: Meta-predicate template<12>1067258
Ref: refman/methods/findall_4 meta-predicate-template1067416
Ref: 77b1067416
Node: Modes and number of proofs<102>1067509
Ref: refman/methods/findall_4 modes-and-number-of-proofs1067662
Ref: 77c1067662
Node: Errors<103>1067795
Ref: refman/methods/findall_4 errors1067934
Ref: 77d1067934
Node: Examples<140>1068246
Ref: refman/methods/findall_4 examples1068345
Ref: 77e1068345
Node: forall/21068905
Ref: refman/methods/forall_2 doc1069017
Ref: 77f1069017
Ref: refman/methods/forall_2 forall-21069017
Ref: 7801069017
Ref: refman/methods/forall_2 methods-forall-21069017
Ref: 1c31069017
Node: Description<140>1069274
Ref: refman/methods/forall_2 description1069391
Ref: 7811069391
Node: Meta-predicate template<13>1070028
Ref: refman/methods/forall_2 meta-predicate-template1070185
Ref: 7821070185
Node: Modes and number of proofs<103>1070271
Ref: refman/methods/forall_2 modes-and-number-of-proofs1070423
Ref: 7831070423
Node: Errors<104>1070545
Ref: refman/methods/forall_2 errors1070683
Ref: 7841070683
Node: Examples<141>1071024
Ref: refman/methods/forall_2 examples1071122
Ref: 7851071122
Node: setof/31071624
Ref: refman/methods/setof_3 doc1071718
Ref: 7861071718
Ref: refman/methods/setof_3 methods-setof-31071718
Ref: 1c21071718
Ref: refman/methods/setof_3 setof-31071718
Ref: 7871071718
Node: Description<141>1071973
Ref: refman/methods/setof_3 description1072089
Ref: 7881072089
Node: Meta-predicate template<14>1072963
Ref: refman/methods/setof_3 meta-predicate-template1073119
Ref: 7891073119
Node: Modes and number of proofs<104>1073207
Ref: refman/methods/setof_3 modes-and-number-of-proofs1073358
Ref: 78a1073358
Node: Errors<105>1073483
Ref: refman/methods/setof_3 errors1073620
Ref: 78b1073620
Node: Examples<142>1073932
Ref: refman/methods/setof_3 examples1074029
Ref: 78c1074029
Node: Event handling<3>1074563
Ref: refman/methods/event_methods doc1074705
Ref: 78d1074705
Ref: refman/methods/event_methods event-handling1074705
Ref: 78e1074705
Ref: refman/methods/event_methods event-methods1074705
Ref: 78f1074705
Node: before/31074802
Ref: refman/methods/before_3 doc1074900
Ref: 7901074900
Ref: refman/methods/before_3 before-31074900
Ref: 7911074900
Ref: refman/methods/before_3 methods-before-31074900
Ref: 1011074900
Node: Description<142>1075099
Ref: refman/methods/before_3 description1075220
Ref: 7921075220
Ref: Description<142>-Footnote-11075840
Node: Modes and number of proofs<105>1075893
Ref: refman/methods/before_3 modes-and-number-of-proofs1076034
Ref: 7931076034
Node: Errors<106>1076184
Ref: refman/methods/before_3 errors1076322
Ref: 7941076322
Node: Examples<143>1076361
Ref: refman/methods/before_3 examples1076459
Ref: 7951076459
Node: after/31076916
Ref: refman/methods/after_3 doc1077014
Ref: 7961077014
Ref: refman/methods/after_3 after-31077014
Ref: 7971077014
Ref: refman/methods/after_3 methods-after-31077014
Ref: 1021077014
Node: Description<143>1077211
Ref: refman/methods/after_3 description1077331
Ref: 7981077331
Ref: Description<143>-Footnote-11077949
Node: Modes and number of proofs<106>1078002
Ref: refman/methods/after_3 modes-and-number-of-proofs1078142
Ref: 7991078142
Node: Errors<107>1078291
Ref: refman/methods/after_3 errors1078428
Ref: 79a1078428
Node: Examples<144>1078467
Ref: refman/methods/after_3 examples1078564
Ref: 79b1078564
Node: Message forwarding1079010
Ref: refman/methods/forwarding_methods doc1079171
Ref: 79c1079171
Ref: refman/methods/forwarding_methods forwarding-methods1079171
Ref: 79d1079171
Ref: refman/methods/forwarding_methods message-forwarding1079171
Ref: 79e1079171
Node: forward/11079265
Ref: refman/methods/forward_1 doc1079349
Ref: 79f1079349
Ref: refman/methods/forward_1 forward-11079349
Ref: 7a01079349
Ref: refman/methods/forward_1 methods-forward-11079349
Ref: 1051079349
Node: Description<144>1079550
Ref: refman/methods/forward_1 description1079672
Ref: 7a11079672
Ref: Description<144>-Footnote-11080201
Node: Modes and number of proofs<107>1080254
Ref: refman/methods/forward_1 modes-and-number-of-proofs1080396
Ref: 7a21080396
Node: Errors<108>1080507
Ref: refman/methods/forward_1 errors1080646
Ref: 7a31080646
Node: Examples<145>1080685
Ref: refman/methods/forward_1 examples1080784
Ref: 7a41080784
Node: Definite clause grammar rules<2>1081048
Ref: refman/methods/dcg_methods doc1081218
Ref: 7a51081218
Ref: refman/methods/dcg_methods dcg-methods1081218
Ref: 7a61081218
Ref: refman/methods/dcg_methods definite-clause-grammar-rules1081218
Ref: 7a71081218
Node: call//1-N1081387
Ref: refman/methods/call_1 doc1081500
Ref: 7a81081500
Ref: refman/methods/call_1 call-1-n1081500
Ref: 7a91081500
Ref: refman/methods/call_1 methods-call-11081500
Ref: 1c91081500
Node: Description<145>1081734
Ref: refman/methods/call_1 description1081851
Ref: 7aa1081851
Node: Meta-non-terminal template1083019
Ref: refman/methods/call_1 meta-non-terminal-template1083176
Ref: 7ab1083176
Node: Modes and number of proofs<108>1083307
Ref: refman/methods/call_1 modes-and-number-of-proofs1083459
Ref: 7ac1083459
Node: Errors<109>1083671
Ref: refman/methods/call_1 errors1083810
Ref: 7ad1083810
Node: Examples<146>1084022
Ref: refman/methods/call_1 examples1084121
Ref: 7ae1084121
Node: eos//01084961
Ref: refman/methods/eos_0 doc1085092
Ref: 7af1085092
Ref: refman/methods/eos_0 eos-01085092
Ref: 7b01085092
Ref: refman/methods/eos_0 methods-eos-01085092
Ref: 1ca1085092
Node: Description<146>1085289
Ref: refman/methods/eos_0 description1085408
Ref: 7b11085408
Node: Modes and number of proofs<109>1085597
Ref: refman/methods/eos_0 modes-and-number-of-proofs1085736
Ref: 7b21085736
Node: Errors<110>1085833
Ref: refman/methods/eos_0 errors1085969
Ref: 7b31085969
Node: Examples<147>1086012
Ref: refman/methods/eos_0 examples1086108
Ref: 7b41086108
Node: phrase//11086300
Ref: refman/methods/phrase_1 doc1086430
Ref: 7b51086430
Ref: refman/methods/phrase_1 methods-phrase-11086430
Ref: 1c81086430
Ref: refman/methods/phrase_1 phrase-11086430
Ref: 7b61086430
Node: Description<147>1086696
Ref: refman/methods/phrase_1 description1086816
Ref: 7b71086816
Node: Meta-non-terminal template<2>1087138
Ref: refman/methods/phrase_1 meta-non-terminal-template1087298
Ref: 7b91087298
Node: Modes and number of proofs<110>1087389
Ref: refman/methods/phrase_1 modes-and-number-of-proofs1087544
Ref: 7ba1087544
Node: Errors<111>1087658
Ref: refman/methods/phrase_1 errors1087797
Ref: 7bb1087797
Node: Examples<148>1088035
Ref: refman/methods/phrase_1 examples1088134
Ref: 7bc1088134
Node: phrase/21088289
Ref: refman/methods/phrase_2 doc1088421
Ref: 7bd1088421
Ref: refman/methods/phrase_2 methods-phrase-21088421
Ref: 18e1088421
Ref: refman/methods/phrase_2 phrase-21088421
Ref: 7be1088421
Node: Description<148>1088680
Ref: refman/methods/phrase_2 description1088797
Ref: 7bf1088797
Node: Meta-predicate template<15>1089761
Ref: refman/methods/phrase_2 meta-predicate-template1089918
Ref: 7c01089918
Node: Modes and number of proofs<111>1090006
Ref: refman/methods/phrase_2 modes-and-number-of-proofs1090158
Ref: 7c11090158
Node: Errors<112>1090279
Ref: refman/methods/phrase_2 errors1090417
Ref: 7c21090417
Node: Examples<149>1090655
Ref: refman/methods/phrase_2 examples1090753
Ref: 7c31090753
Node: phrase/31091266
Ref: refman/methods/phrase_3 doc1091380
Ref: 7c41091380
Ref: refman/methods/phrase_3 methods-phrase-31091380
Ref: 18f1091380
Ref: refman/methods/phrase_3 phrase-31091380
Ref: 7c51091380
Node: Description<149>1091639
Ref: refman/methods/phrase_3 description1091756
Ref: 7c61091756
Node: Meta-predicate template<16>1092773
Ref: refman/methods/phrase_3 meta-predicate-template1092930
Ref: 7c71092930
Node: Modes and number of proofs<112>1093021
Ref: refman/methods/phrase_3 modes-and-number-of-proofs1093173
Ref: 7c81093173
Node: Errors<113>1093301
Ref: refman/methods/phrase_3 errors1093439
Ref: 7c91093439
Node: Examples<150>1093677
Ref: refman/methods/phrase_3 examples1093775
Ref: 7ca1093775
Node: Term and goal expansion<2>1094286
Ref: refman/methods/expansion_methods doc1094455
Ref: 7cb1094455
Ref: refman/methods/expansion_methods expansion-methods1094455
Ref: 7cc1094455
Ref: refman/methods/expansion_methods term-and-goal-expansion1094455
Ref: 7cd1094455
Node: expand_term/21094625
Ref: refman/methods/expand_term_2 doc1094746
Ref: 7ce1094746
Ref: refman/methods/expand_term_2 expand-term-21094746
Ref: 7cf1094746
Ref: refman/methods/expand_term_2 methods-expand-term-21094746
Ref: 1b71094746
Node: Description<150>1094957
Ref: refman/methods/expand_term_2 description1095083
Ref: 7d01095083
Node: Modes and number of proofs<113>1096521
Ref: refman/methods/expand_term_2 modes-and-number-of-proofs1096667
Ref: 7d11096667
Node: Errors<114>1096778
Ref: refman/methods/expand_term_2 errors1096921
Ref: 7d21096921
Node: Examples<151>1096962
Ref: refman/methods/expand_term_2 examples1097065
Ref: 7d31097065
Node: term_expansion/21097231
Ref: refman/methods/term_expansion_2 doc1097374
Ref: 7d41097374
Ref: refman/methods/term_expansion_2 methods-term-expansion-21097374
Ref: fc1097374
Ref: refman/methods/term_expansion_2 term-expansion-21097374
Ref: 7d51097374
Node: Description<151>1097591
Ref: refman/methods/term_expansion_2 description1097720
Ref: 7d61097720
Ref: Description<151>-Footnote-11099141
Node: Modes and number of proofs<114>1099192
Ref: refman/methods/term_expansion_2 modes-and-number-of-proofs1099341
Ref: 7d71099341
Node: Errors<115>1099525
Ref: refman/methods/term_expansion_2 errors1099671
Ref: 7d81099671
Node: Examples<152>1099712
Ref: refman/methods/term_expansion_2 examples1099818
Ref: 7d91099818
Node: expand_goal/21100163
Ref: refman/methods/expand_goal_2 doc1100309
Ref: 7da1100309
Ref: refman/methods/expand_goal_2 expand-goal-21100309
Ref: 7db1100309
Ref: refman/methods/expand_goal_2 methods-expand-goal-21100309
Ref: 3121100309
Node: Description<152>1100522
Ref: refman/methods/expand_goal_2 description1100648
Ref: 7dc1100648
Node: Modes and number of proofs<115>1101540
Ref: refman/methods/expand_goal_2 modes-and-number-of-proofs1101686
Ref: 7dd1101686
Node: Errors<116>1101799
Ref: refman/methods/expand_goal_2 errors1101942
Ref: 7de1101942
Node: Examples<153>1101985
Ref: refman/methods/expand_goal_2 examples1102088
Ref: 7df1102088
Node: goal_expansion/21102256
Ref: refman/methods/goal_expansion_2 doc1102377
Ref: 7e01102377
Ref: refman/methods/goal_expansion_2 goal-expansion-21102377
Ref: 7e11102377
Ref: refman/methods/goal_expansion_2 methods-goal-expansion-21102377
Ref: fd1102377
Node: Description<153>1102596
Ref: refman/methods/goal_expansion_2 description1102725
Ref: 7e21102725
Ref: Description<153>-Footnote-11104191
Node: Modes and number of proofs<116>1104242
Ref: refman/methods/goal_expansion_2 modes-and-number-of-proofs1104391
Ref: 7e31104391
Node: Errors<117>1104523
Ref: refman/methods/goal_expansion_2 errors1104669
Ref: 7e41104669
Node: Examples<154>1104712
Ref: refman/methods/goal_expansion_2 examples1104818
Ref: 7e51104818
Node: Coinduction hooks1105122
Ref: refman/methods/coinduction_methods doc1105275
Ref: 7e61105275
Ref: refman/methods/coinduction_methods coinduction-hooks1105275
Ref: 7e71105275
Ref: refman/methods/coinduction_methods coinduction-methods1105275
Ref: 7e81105275
Node: coinductive_success_hook/1-21105388
Ref: refman/methods/coinductive_success_hook_1_2 doc1105490
Ref: 7e91105490
Ref: refman/methods/coinductive_success_hook_1_2 coinductive-success-hook-1-21105490
Ref: 7ea1105490
Ref: refman/methods/coinductive_success_hook_1_2 methods-coinductive-success-hook-1-21105490
Ref: 4b21105490
Node: Description<154>1105731
Ref: refman/methods/coinductive_success_hook_1_2 description1105872
Ref: 7eb1105872
Node: Modes and number of proofs<117>1106753
Ref: refman/methods/coinductive_success_hook_1_2 modes-and-number-of-proofs1106914
Ref: 7ec1106914
Node: Errors<118>1107109
Ref: refman/methods/coinductive_success_hook_1_2 errors1107267
Ref: 7ed1107267
Node: Examples<155>1107308
Ref: refman/methods/coinductive_success_hook_1_2 examples1107426
Ref: 7ee1107426
Node: Message printing1108003
Ref: refman/methods/printing_methods doc1108145
Ref: 7ef1108145
Ref: refman/methods/printing_methods message-printing1108145
Ref: 7f01108145
Ref: refman/methods/printing_methods printing-methods1108145
Ref: 7f11108145
Node: print_message/31108391
Ref: refman/methods/print_message_3 doc1108505
Ref: 7f21108505
Ref: refman/methods/print_message_3 methods-print-message-31108505
Ref: 2fe1108505
Ref: refman/methods/print_message_3 print-message-31108505
Ref: 7f31108505
Node: Description<155>1108720
Ref: refman/methods/print_message_3 description1108848
Ref: 7f41108848
Ref: Description<155>-Footnote-11110182
Node: Modes and number of proofs<118>1110229
Ref: refman/methods/print_message_3 modes-and-number-of-proofs1110377
Ref: 7f51110377
Node: Errors<119>1110503
Ref: refman/methods/print_message_3 errors1110648
Ref: 7f61110648
Node: Examples<156>1110689
Ref: refman/methods/print_message_3 examples1110794
Ref: 7f71110794
Node: message_tokens//21111214
Ref: refman/methods/message_tokens_2 doc1111351
Ref: 7fb1111351
Ref: refman/methods/message_tokens_2 message-tokens-21111351
Ref: 7fc1111351
Ref: refman/methods/message_tokens_2 methods-message-tokens-21111351
Ref: 3001111351
Node: Description<156>1111570
Ref: refman/methods/message_tokens_2 description1111700
Ref: 7fd1111700
Ref: Description<156>-Footnote-11112186
Node: Modes and number of proofs<119>1112233
Ref: refman/methods/message_tokens_2 modes-and-number-of-proofs1112383
Ref: 7fe1112383
Node: Errors<120>1112510
Ref: refman/methods/message_tokens_2 errors1112657
Ref: 7ff1112657
Node: Examples<157>1112698
Ref: refman/methods/message_tokens_2 examples1112805
Ref: 8001112805
Node: message_hook/41113351
Ref: refman/methods/message_hook_4 doc1113496
Ref: 8011113496
Ref: refman/methods/message_hook_4 message-hook-41113496
Ref: 8021113496
Ref: refman/methods/message_hook_4 methods-message-hook-41113496
Ref: 3061113496
Node: Description<157>1113711
Ref: refman/methods/message_hook_4 description1113838
Ref: 8031113838
Ref: Description<157>-Footnote-11114327
Node: Modes and number of proofs<120>1114374
Ref: refman/methods/message_hook_4 modes-and-number-of-proofs1114521
Ref: 8041114521
Node: Errors<121>1114671
Ref: refman/methods/message_hook_4 errors1114815
Ref: 8051114815
Node: Examples<158>1114858
Ref: refman/methods/message_hook_4 examples1114962
Ref: 8061114962
Node: message_prefix_stream/41115640
Ref: refman/methods/message_prefix_stream_4 doc1115789
Ref: 8071115789
Ref: refman/methods/message_prefix_stream_4 message-prefix-stream-41115789
Ref: 8081115789
Ref: refman/methods/message_prefix_stream_4 methods-message-prefix-stream-41115789
Ref: 3041115789
Node: Description<158>1116022
Ref: refman/methods/message_prefix_stream_4 description1116158
Ref: 8091116158
Ref: Description<158>-Footnote-11116761
Ref: Description<158>-Footnote-21116808
Node: Modes and number of proofs<121>1116855
Ref: refman/methods/message_prefix_stream_4 modes-and-number-of-proofs1117011
Ref: 80a1117011
Node: Errors<122>1117172
Ref: refman/methods/message_prefix_stream_4 errors1117325
Ref: 80b1117325
Node: Examples<159>1117368
Ref: refman/methods/message_prefix_stream_4 examples1117481
Ref: 80c1117481
Node: message_prefix_file/61118020
Ref: refman/methods/message_prefix_file_6 doc1118177
Ref: 80d1118177
Ref: refman/methods/message_prefix_file_6 message-prefix-file-61118177
Ref: 80e1118177
Ref: refman/methods/message_prefix_file_6 methods-message-prefix-file-61118177
Ref: 3071118177
Node: Description<159>1118406
Ref: refman/methods/message_prefix_file_6 description1118540
Ref: 80f1118540
Ref: Description<159>-Footnote-11119294
Ref: Description<159>-Footnote-21119341
Node: Modes and number of proofs<122>1119388
Ref: refman/methods/message_prefix_file_6 modes-and-number-of-proofs1119542
Ref: 8101119542
Node: Errors<123>1119714
Ref: refman/methods/message_prefix_file_6 errors1119865
Ref: 8111119865
Node: Examples<160>1119908
Ref: refman/methods/message_prefix_file_6 examples1120019
Ref: 8121120019
Node: print_message_tokens/31120564
Ref: refman/methods/print_message_tokens_3 doc1120719
Ref: 8131120719
Ref: refman/methods/print_message_tokens_3 methods-print-message-tokens-31120719
Ref: 7f81120719
Ref: refman/methods/print_message_tokens_3 print-message-tokens-31120719
Ref: 8141120719
Node: Description<160>1120950
Ref: refman/methods/print_message_tokens_3 description1121085
Ref: 8151121085
Ref: Description<160>-Footnote-11121845
Node: Modes and number of proofs<123>1121892
Ref: refman/methods/print_message_tokens_3 modes-and-number-of-proofs1122047
Ref: 8161122047
Node: Errors<124>1122203
Ref: refman/methods/print_message_tokens_3 errors1122355
Ref: 8171122355
Node: Examples<161>1122398
Ref: refman/methods/print_message_tokens_3 examples1122510
Ref: 8181122510
Node: print_message_token/41122948
Ref: refman/methods/print_message_token_4 doc1123073
Ref: 8191123073
Ref: refman/methods/print_message_token_4 methods-print-message-token-41123073
Ref: 7f91123073
Ref: refman/methods/print_message_token_4 print-message-token-41123073
Ref: 81a1123073
Node: Description<161>1123302
Ref: refman/methods/print_message_token_4 description1123436
Ref: 81b1123436
Ref: Description<161>-Footnote-11123902
Node: Modes and number of proofs<124>1123949
Ref: refman/methods/print_message_token_4 modes-and-number-of-proofs1124103
Ref: 81c1124103
Node: Errors<125>1124267
Ref: refman/methods/print_message_token_4 errors1124418
Ref: 81d1124418
Node: Examples<162>1124461
Ref: refman/methods/print_message_token_4 examples1124572
Ref: 81e1124572
Node: Question asking1125081
Ref: refman/methods/asking_methods doc1125197
Ref: 81f1125197
Ref: refman/methods/asking_methods asking-methods1125197
Ref: 8201125197
Ref: refman/methods/asking_methods question-asking1125197
Ref: 8211125197
Node: ask_question/51125341
Ref: refman/methods/ask_question_5 doc1125451
Ref: 8221125451
Ref: refman/methods/ask_question_5 ask-question-51125451
Ref: 8231125451
Ref: refman/methods/ask_question_5 methods-ask-question-51125451
Ref: 30b1125451
Node: Description<162>1125720
Ref: refman/methods/ask_question_5 description1125847
Ref: 8241125847
Node: Modes and number of proofs<125>1126936
Ref: refman/methods/ask_question_5 modes-and-number-of-proofs1127099
Ref: 8251127099
Node: Meta-predicate template<17>1127242
Ref: refman/methods/ask_question_5 meta-predicate-template1127400
Ref: 8261127400
Node: Errors<126>1127501
Ref: refman/methods/ask_question_5 errors1127641
Ref: 8271127641
Node: Examples<163>1127682
Ref: refman/methods/ask_question_5 examples1127786
Ref: 8281127786
Node: question_hook/61128208
Ref: refman/methods/question_hook_6 doc1128351
Ref: 8291128351
Ref: refman/methods/question_hook_6 methods-question-hook-61128351
Ref: 30d1128351
Ref: refman/methods/question_hook_6 question-hook-61128351
Ref: 82a1128351
Node: Description<163>1128622
Ref: refman/methods/question_hook_6 description1128750
Ref: 82b1128750
Ref: Description<163>-Footnote-11129260
Node: Modes and number of proofs<126>1129307
Ref: refman/methods/question_hook_6 modes-and-number-of-proofs1129471
Ref: 82c1129471
Node: Meta-predicate template<18>1129638
Ref: refman/methods/question_hook_6 meta-predicate-template1129797
Ref: 82d1129797
Node: Errors<127>1129904
Ref: refman/methods/question_hook_6 errors1130045
Ref: 82e1130045
Node: Examples<164>1130088
Ref: refman/methods/question_hook_6 examples1130193
Ref: 82f1130193
Node: question_prompt_stream/41130745
Ref: refman/methods/question_prompt_stream_4 doc1130865
Ref: 8301130865
Ref: refman/methods/question_prompt_stream_4 methods-question-prompt-stream-41130865
Ref: 7fa1130865
Ref: refman/methods/question_prompt_stream_4 question-prompt-stream-41130865
Ref: 8311130865
Node: Description<164>1131100
Ref: refman/methods/question_prompt_stream_4 description1131237
Ref: 8321131237
Ref: Description<164>-Footnote-11131627
Node: Modes and number of proofs<127>1131674
Ref: refman/methods/question_prompt_stream_4 modes-and-number-of-proofs1131831
Ref: 8331131831
Node: Errors<128>1131993
Ref: refman/methods/question_prompt_stream_4 errors1132147
Ref: 8341132147
Node: Examples<165>1132190
Ref: refman/methods/question_prompt_stream_4 examples1132304
Ref: 8351132304
Node: Tutorial1132796
Ref: tutorial/index doc1132901
Ref: 8361132901
Ref: tutorial/index tutorial1132901
Ref: 8371132901
Node: List predicates1133043
Ref: tutorial/lists doc1133157
Ref: 8381133157
Ref: tutorial/lists list-predicates1133157
Ref: 8391133157
Node: Defining a list object1133397
Ref: tutorial/lists defining-a-list-object1133524
Ref: 83a1133524
Ref: tutorial/lists object1133524
Ref: 83b1133524
Node: Defining a list protocol1136067
Ref: tutorial/lists defining-a-list-protocol1136210
Ref: 83c1136210
Ref: tutorial/lists protocol1136210
Ref: 83d1136210
Node: Summary1138408
Ref: tutorial/lists summary1138520
Ref: 83e1138520
Node: Dynamic object attributes1138972
Ref: tutorial/attributes doc1139126
Ref: 83f1139126
Ref: tutorial/attributes dynamic-object-attributes1139126
Ref: 8401139126
Node: Defining a category1139488
Ref: tutorial/attributes category1139620
Ref: 8411139620
Ref: tutorial/attributes defining-a-category1139620
Ref: 8421139620
Node: Importing the category1143284
Ref: tutorial/attributes importing1143435
Ref: 8431143435
Ref: tutorial/attributes importing-the-category1143435
Ref: 8441143435
Node: Summary<2>1143997
Ref: tutorial/attributes summary1144120
Ref: 8451144120
Node: A reflective class-based system1144753
Ref: tutorial/reflection doc1144910
Ref: 8461144910
Ref: tutorial/reflection a-reflective-class-based-system1144910
Ref: 8471144910
Node: Defining the base classes1146025
Ref: tutorial/reflection classes1146157
Ref: 8481146157
Ref: tutorial/reflection defining-the-base-classes1146157
Ref: 8491146157
Node: Summary<3>1147540
Ref: tutorial/reflection summary1147672
Ref: 84a1147672
Node: Profiling programs1148270
Ref: tutorial/profiling doc1148393
Ref: 84b1148393
Ref: tutorial/profiling profiling-programs1148393
Ref: 84c1148393
Node: Messages as events1148715
Ref: tutorial/profiling messages-as-events1148838
Ref: 84d1148838
Ref: tutorial/profiling profiling-events1148838
Ref: 84e1148838
Node: Profilers as monitors1149970
Ref: tutorial/profiling profilers-as-monitors1150112
Ref: 84f1150112
Ref: tutorial/profiling profiling-monitors1150112
Ref: 8501150112
Node: Summary<4>1153095
Ref: tutorial/profiling summary1153210
Ref: 8511153210
Node: FAQ1154078
Ref: faq/index doc1154182
Ref: 8521154182
Ref: faq/index faq1154182
Ref: 8531154182
Node: General1154390
Ref: faq/general doc1154479
Ref: 8541154479
Ref: faq/general faq-general1154479
Ref: 8551154479
Ref: faq/general general1154479
Ref: 8561154479
Node: Why are all versions of Logtalk numbered 2 x or 3 x?1155071
Ref: faq/general faq-general-versions1155243
Ref: 8571155243
Ref: faq/general why-are-all-versions-of-logtalk-numbered-2-x-or-3-x1155243
Ref: 85b1155243
Node: Why do I need a Prolog compiler to use Logtalk?1155909
Ref: faq/general faq-general-prolog1156144
Ref: 8581156144
Ref: faq/general why-do-i-need-a-prolog-compiler-to-use-logtalk1156144
Ref: 85c1156144
Node: Is the Logtalk implementation based on Prolog modules?1156777
Ref: faq/general faq-general-modules1157011
Ref: 8591157011
Ref: faq/general is-the-logtalk-implementation-based-on-prolog-modules1157011
Ref: 85d1157011
Node: Does the Logtalk implementation use term-expansion?1157665
Ref: faq/general does-the-logtalk-implementation-use-term-expansion1157843
Ref: 85e1157843
Ref: faq/general faq-general-expansion1157843
Ref: 85a1157843
Node: Compatibility1158066
Ref: faq/compatibility doc1158176
Ref: 85f1158176
Ref: faq/compatibility compatibility1158176
Ref: 8601158176
Ref: faq/compatibility faq-compatibility1158176
Ref: 8611158176
Node: What are the backend Prolog compiler requirements to run Logtalk?1158657
Ref: faq/compatibility faq-compatibility-requirements1158850
Ref: 8621158850
Ref: faq/compatibility what-are-the-backend-prolog-compiler-requirements-to-run-logtalk1158850
Ref: 8651158850
Ref: What are the backend Prolog compiler requirements to run Logtalk?-Footnote-11159087
Node: Can I use constraint-based packages with Logtalk?1159141
Ref: faq/compatibility can-i-use-constraint-based-packages-with-logtalk1159405
Ref: 8661159405
Ref: faq/compatibility faq-compatibility-constraints1159405
Ref: 8631159405
Node: Can I use Logtalk objects and Prolog modules at the same time?1160046
Ref: faq/compatibility can-i-use-logtalk-objects-and-prolog-modules-at-the-same-time1160236
Ref: 8671160236
Ref: faq/compatibility faq-compatibility-modules1160236
Ref: 8641160236
Node: Installation1160824
Ref: faq/installation doc1160938
Ref: 8681160938
Ref: faq/installation faq-installation1160938
Ref: 8691160938
Ref: faq/installation installation1160938
Ref: 86a1160938
Node: The integration scripts/shortcuts are not working!1161288
Ref: faq/installation faq-installation-scripts1161492
Ref: 86b1161492
Ref: faq/installation the-integration-scripts-shortcuts-are-not-working1161492
Ref: 86d1161492
Node: I get errors when starting up Logtalk after upgrading to the latest version!1162442
Ref: faq/installation faq-installation-startup-errors1162646
Ref: 86c1162646
Ref: faq/installation i-get-errors-when-starting-up-logtalk-after-upgrading-to-the-latest-version1162646
Ref: 86e1162646
Node: Portability1163215
Ref: faq/portability doc1163327
Ref: 86f1163327
Ref: faq/portability faq-portability1163327
Ref: 8701163327
Ref: faq/portability portability1163327
Ref: 8711163327
Node: Are my Logtalk applications portable across Prolog compilers?1163674
Ref: faq/portability are-my-logtalk-applications-portable-across-prolog-compilers1163874
Ref: 8741163874
Ref: faq/portability faq-portability-prolog1163874
Ref: 8721163874
Node: Are my Logtalk applications portable across operating systems?1164664
Ref: faq/portability are-my-logtalk-applications-portable-across-operating-systems1164864
Ref: 8751164864
Ref: faq/portability faq-portability-os1164864
Ref: 8731164864
Node: Programming1165422
Ref: faq/programming doc1165537
Ref: 8761165537
Ref: faq/programming faq-programming1165537
Ref: 8771165537
Ref: faq/programming programming1165537
Ref: 8781165537
Node: Should I use prototypes or classes in my application?1166486
Ref: faq/programming faq-programming-either-prototypes-classes1166678
Ref: 8791166678
Ref: faq/programming should-i-use-prototypes-or-classes-in-my-application1166678
Ref: 87f1166678
Node: Can I use both classes and prototypes in the same application?1167181
Ref: faq/programming can-i-use-both-classes-and-prototypes-in-the-same-application1167437
Ref: 8801167437
Ref: faq/programming faq-programming-both-prototypes-classes1167437
Ref: 87a1167437
Node: Can I mix classes and prototypes in the same hierarchy?1167673
Ref: faq/programming can-i-mix-classes-and-prototypes-in-the-same-hierarchy1167944
Ref: 8811167944
Ref: faq/programming faq-programming-hierarchy1167944
Ref: 87b1167944
Node: Can I use a protocol or a category with both prototypes and classes?1168194
Ref: faq/programming can-i-use-a-protocol-or-a-category-with-both-prototypes-and-classes1168473
Ref: 8821168473
Ref: faq/programming faq-programming-protocols-categories1168473
Ref: 87c1168473
Node: What support is provided in Logtalk for defining and using components?1168811
Ref: faq/programming faq-programming-components1169098
Ref: 87d1169098
Ref: faq/programming what-support-is-provided-in-logtalk-for-defining-and-using-components1169098
Ref: 8831169098
Node: What support is provided in Logtalk for reflective programming?1169742
Ref: faq/programming faq-programming-reflection1169952
Ref: 87e1169952
Ref: faq/programming what-support-is-provided-in-logtalk-for-reflective-programming1169952
Ref: 8841169952
Node: Troubleshooting1170388
Ref: faq/troubleshooting doc1170501
Ref: 8851170501
Ref: faq/troubleshooting faq-troubleshooting1170501
Ref: 8861170501
Ref: faq/troubleshooting troubleshooting1170501
Ref: 8871170501
Node: Using compiler options on calls to the Logtalk compiling and loading predicates does not work!1171438
Ref: faq/troubleshooting faq-troubleshooting-options1171714
Ref: 8881171714
Ref: faq/troubleshooting using-compiler-options-on-calls-to-the-logtalk-compiling-and-loading-predicates-does-not-work1171714
Ref: 88b1171714
Node: Gecko-based browsers e g Firefox show non-rendered HTML entities when browsing XML documenting files!1172406
Ref: faq/troubleshooting faq-troubleshooting-gecko1172838
Ref: 8891172838
Ref: faq/troubleshooting gecko-based-browsers-e-g-firefox-show-non-rendered-html-entities-when-browsing-xml-documenting-files1172838
Ref: 88c1172838
Node: Compiling a source file results in errors or warnings but the Logtalk compiler reports a successful compilation with zero errors and zero warnings!1173639
Ref: faq/troubleshooting compiling-a-source-file-results-in-errors-or-warnings-but-the-logtalk-compiler-reports-a-successful-compilation-with-zero-errors-and-zero-warnings1173968
Ref: 88d1173968
Ref: faq/troubleshooting faq-troubleshooting-warnings1173968
Ref: 88a1173968
Node: Usability1174998
Ref: faq/usability doc1175110
Ref: 88e1175110
Ref: faq/usability faq-usability1175110
Ref: 88f1175110
Ref: faq/usability usability1175110
Ref: 8901175110
Node: Is there a shortcut for compiling and loading source files?1175589
Ref: faq/usability faq-usability-shortcuts1175796
Ref: 8911175796
Ref: faq/usability is-there-a-shortcut-for-compiling-and-loading-source-files1175796
Ref: 8941175796
Node: Is there an equivalent directive to the ensure_loaded/1 Prolog directive?1176200
Ref: faq/usability faq-usability-ensure-loaded1176463
Ref: 8921176463
Ref: faq/usability is-there-an-equivalent-directive-to-the-ensure-loaded-1-prolog-directive1176463
Ref: 8951176463
Node: Are there shortcuts for the make functionality?1176824
Ref: faq/usability are-there-shortcuts-for-the-make-functionality1177019
Ref: 8961177019
Ref: faq/usability faq-usability-make1177019
Ref: 8931177019
Node: Deployment1177711
Ref: faq/deployment doc1177822
Ref: 8971177822
Ref: faq/deployment deployment1177822
Ref: 8981177822
Ref: faq/deployment faq-deployment1177822
Ref: 8991177822
Node: Can I create standalone applications with Logtalk?1177987
Ref: faq/deployment can-i-create-standalone-applications-with-logtalk1178104
Ref: 89b1178104
Ref: faq/deployment faq-deployment-create1178104
Ref: 89a1178104
Ref: Can I create standalone applications with Logtalk?-Footnote-11178710
Node: Performance<3>1178753
Ref: faq/performance doc1178864
Ref: 89c1178864
Ref: faq/performance id11178864
Ref: 89d1178864
Ref: faq/performance performance1178864
Ref: 89e1178864
Node: Is Logtalk implemented as a meta-interpreter?1179702
Ref: faq/performance is-logtalk-implemented-as-a-meta-interpreter1179913
Ref: 8a31179913
Ref: faq/performance performance-meta-interpreter1179913
Ref: 89f1179913
Node: What kind of code Logtalk generates when compiling objects? Dynamic code? Static code?1180263
Ref: faq/performance performance-code-generated1180573
Ref: 8a01180573
Ref: faq/performance what-kind-of-code-logtalk-generates-when-compiling-objects-dynamic-code-static-code1180573
Ref: 8a41180573
Node: How about message-sending performance? Does Logtalk use static binding or dynamic binding?1181136
Ref: faq/performance how-about-message-sending-performance-does-logtalk-use-static-binding-or-dynamic-binding1181478
Ref: 8a51181478
Ref: faq/performance performance-binding1181478
Ref: 8a11181478
Node: Which Prolog-dependent factors are most crucial for good Logtalk performance?1182533
Ref: faq/performance which-prolog-dependent-factors-are-most-crucial-for-good-logtalk-performance1182868
Ref: 8a61182868
Node: How does Logtalk performance compare with plain Prolog and with Prolog modules?1183633
Ref: faq/performance how-does-logtalk-performance-compare-with-plain-prolog-and-with-prolog-modules1183869
Ref: 8a71183869
Ref: faq/performance performance-prolog1183869
Ref: 8a21183869
Ref: How does Logtalk performance compare with plain Prolog and with Prolog modules?-Footnote-11184674
Node: Licensing1184719
Ref: faq/licensing doc1184827
Ref: 8a81184827
Ref: faq/licensing faq-licensing1184827
Ref: 8a91184827
Ref: faq/licensing licensing1184827
Ref: 8aa1184827
Node: What’s the Logtalk distribution license?1185281
Ref: faq/licensing faq-licensing-license1185445
Ref: 8ab1185445
Ref: faq/licensing what-s-the-logtalk-distribution-license1185445
Ref: 8ae1185445
Ref: What’s the Logtalk distribution license?-Footnote-11185624
Node: Can Logtalk be used in commercial applications?1185698
Ref: faq/licensing can-logtalk-be-used-in-commercial-applications1185950
Ref: 8af1185950
Ref: faq/licensing faq-licensing-commercial1185950
Ref: 8ac1185950
Ref: Can Logtalk be used in commercial applications?-Footnote-11186204
Node: What’s the final license for a combination of Logtalk with a Prolog compiler?1186263
Ref: faq/licensing faq-licensing-combining1186464
Ref: 8ad1186464
Ref: faq/licensing what-s-the-final-license-for-a-combination-of-logtalk-with-a-prolog-compiler1186464
Ref: 8b01186464
Ref: What’s the final license for a combination of Logtalk with a Prolog compiler?-Footnote-11186737
Node: Support1186780
Ref: faq/support doc1186865
Ref: 8b11186865
Ref: faq/support faq-support1186865
Ref: 8b21186865
Ref: faq/support support1186865
Ref: 8b31186865
Node: Are there professional consulting training and supporting services?1187135
Ref: faq/support are-there-professional-consulting-training-and-supporting-services1187266
Ref: 8b51187266
Ref: faq/support faq-support-professional1187266
Ref: 8b41187266
Ref: Are there professional consulting training and supporting services?-Footnote-11187569
Node: Developer Tools1187597
Ref: devtools/index doc1187702
Ref: 2801187702
Ref: devtools/index developer-tools1187702
Ref: 8b61187702
Node: Overview1188206
Ref: devtools/overview doc1188299
Ref: 8b71188299
Ref: devtools/overview overview1188299
Ref: 8b81188299
Node: Loading the developer tools1189209
Ref: devtools/overview loading-the-developer-tools1189329
Ref: 8b91189329
Node: Tools documentation1190598
Ref: devtools/overview tools-documentation1190745
Ref: 8ba1190745
Node: Tools common flags1191038
Ref: devtools/overview tools-common-flags1191176
Ref: 8bb1191176
Node: Tools requirements1191620
Ref: devtools/overview tools-requirements1191730
Ref: 8bc1191730
Node: Tool dependencies for full functionality1192631
Ref: devtools/overview tool-dependencies-for-full-functionality1192796
Ref: 8bd1192796
Node: Python dependencies all operating-systems1193361
Ref: devtools/overview python-dependencies-all-operating-systems1193551
Ref: 8be1193551
Node: macOS - MacPorts1193946
Ref: devtools/overview macos-macports1194112
Ref: 8bf1194112
Node: macOS - Homebrew1194463
Ref: devtools/overview macos-homebrew1194594
Ref: 8c01194594
Node: Ubuntu1194912
Ref: devtools/overview ubuntu1195033
Ref: 8c11195033
Node: RedHat1195351
Ref: devtools/overview redhat1195476
Ref: 8c21195476
Node: Windows - Chocolatey1195709
Ref: devtools/overview windows-chocolatey1195838
Ref: 8c31195838
Node: Installers1196133
Ref: devtools/overview installers1196284
Ref: 8c41196284
Node: Windows - PowerShell add-ons1196655
Ref: devtools/overview windows-powershell-add-ons1196777
Ref: 8c51196777
Node: asdf1196893
Ref: devtools/asdf doc1197005
Ref: 8c61197005
Ref: devtools/asdf asdf1197005
Ref: 8c71197005
Ref: devtools/asdf library-asdf1197005
Ref: 8c81197005
Ref: asdf-Footnote-11197426
Node: assertions1197454
Ref: devtools/assertions doc1197570
Ref: 8c91197570
Ref: devtools/assertions assertions1197570
Ref: 8ca1197570
Ref: devtools/assertions library-assertions1197570
Ref: 8cb1197570
Node: API documentation1198292
Ref: devtools/assertions api-documentation1198392
Ref: 8cc1198392
Node: Loading1198535
Ref: devtools/assertions loading1198651
Ref: 8cd1198651
Node: Testing1198767
Ref: devtools/assertions testing1198903
Ref: 8ce1198903
Node: Adding assertions to your source code1199029
Ref: devtools/assertions adding-assertions-to-your-source-code1199226
Ref: 8cf1199226
Node: Automatically adding file and line context information to assertions1199884
Ref: devtools/assertions automatically-adding-file-and-line-context-information-to-assertions1200118
Ref: 8d01200118
Node: Suppressing assertion calls from source code1200914
Ref: devtools/assertions suppressing-assertion-calls-from-source-code1201149
Ref: 8d11201149
Node: Redirecting assertion failure messages1201645
Ref: devtools/assertions redirecting-assertion-failure-messages1201853
Ref: 8d21201853
Node: Converting assertion failures into errors1202459
Ref: devtools/assertions converting-assertion-failures-into-errors1202614
Ref: 8d31202614
Node: code_metrics1203559
Ref: devtools/code_metrics doc1203688
Ref: 8d41203688
Ref: devtools/code_metrics code-metrics1203688
Ref: 8d51203688
Ref: devtools/code_metrics library-code-metrics1203688
Ref: 8d61203688
Node: API documentation<2>1204947
Ref: devtools/code_metrics api-documentation1205055
Ref: 8d71205055
Node: Loading<2>1205200
Ref: devtools/code_metrics loading1205327
Ref: 8d81205327
Node: Testing<2>1205445
Ref: devtools/code_metrics testing1205569
Ref: 8d91205569
Node: Available metrics1205697
Ref: devtools/code_metrics available-metrics1205827
Ref: 8da1205827
Node: Coupling metrics1206932
Ref: devtools/code_metrics coupling-metrics1207075
Ref: 8db1207075
Node: Lack of cohesion metric1210146
Ref: devtools/code_metrics lack-of-cohesion-metric1210282
Ref: 8dc1210282
Node: WMC metric1211757
Ref: devtools/code_metrics wmc-metric1211887
Ref: 8dd1211887
Node: RFC metric1212988
Ref: devtools/code_metrics rfc-metric1213122
Ref: 8de1213122
Node: Cognitive complexity metric1214644
Ref: devtools/code_metrics cognitive-complexity-metric1214780
Ref: 8df1214780
Node: Lines metric1215893
Ref: devtools/code_metrics lines-metric1216047
Ref: 8e01216047
Node: Maintainability index metric1216784
Ref: devtools/code_metrics maintainability-index-metric1216926
Ref: 8e11216926
Node: Halstead metric1217688
Ref: devtools/code_metrics halstead-metric1217828
Ref: 8e21217828
Node: UPN metric1219597
Ref: devtools/code_metrics upn-metric1219737
Ref: 8e31219737
Node: Cyclomatic complexity metric1220494
Ref: devtools/code_metrics cyclomatic-complexity-metric1220624
Ref: 8e41220624
Node: Usage1222030
Ref: devtools/code_metrics usage1222178
Ref: 8e51222178
Node: Excluding code from analysis1222548
Ref: devtools/code_metrics excluding-code-from-analysis1222688
Ref: 8e61222688
Node: Defining new metrics1223528
Ref: devtools/code_metrics defining-new-metrics1223680
Ref: 8e71223680
Node: Third-party tools1223989
Ref: devtools/code_metrics third-party-tools1224147
Ref: 8e81224147
Node: Applying metrics to Prolog modules1224553
Ref: devtools/code_metrics applying-metrics-to-prolog-modules1224728
Ref: 8e91224728
Node: Applying metrics to plain Prolog code1225191
Ref: devtools/code_metrics applying-metrics-to-plain-prolog-code1225340
Ref: 8ea1225340
Node: dead_code_scanner1226256
Ref: devtools/dead_code_scanner doc1226389
Ref: 8eb1226389
Ref: devtools/dead_code_scanner dead-code-scanner1226389
Ref: 8ec1226389
Ref: devtools/dead_code_scanner library-dead-code-scanner1226389
Ref: 8ed1226389
Node: API documentation<3>1228389
Ref: devtools/dead_code_scanner api-documentation1228502
Ref: 8ee1228502
Node: Loading<3>1228733
Ref: devtools/dead_code_scanner loading1228865
Ref: 8ef1228865
Node: Testing<3>1228988
Ref: devtools/dead_code_scanner testing1229108
Ref: 8f01229108
Node: Usage<2>1229241
Ref: devtools/dead_code_scanner usage1229382
Ref: 8f11229382
Node: Excluding code from analysis<2>1231587
Ref: devtools/dead_code_scanner excluding-code-from-analysis1231744
Ref: 8f21231744
Node: Machine-readable summaries1233233
Ref: devtools/dead_code_scanner machine-readable-summaries1233417
Ref: 8f31233417
Node: Machine-readable preflight warnings1234291
Ref: devtools/dead_code_scanner machine-readable-preflight-warnings1234474
Ref: 8f41234474
Node: Finding classes and confidence1235097
Ref: devtools/dead_code_scanner finding-classes-and-confidence1235267
Ref: 8f51235267
Node: SARIF reports1237292
Ref: devtools/dead_code_scanner sarif-reports1237457
Ref: 8f61237457
Node: Integration with the make tool1239384
Ref: devtools/dead_code_scanner integration-with-the-make-tool1239526
Ref: 8f71239526
Node: Caveats1239815
Ref: devtools/dead_code_scanner caveats1239967
Ref: 8f81239967
Node: Scanning Prolog modules1240413
Ref: devtools/dead_code_scanner scanning-prolog-modules1240562
Ref: 8f91240562
Node: Scanning plain Prolog files1240993
Ref: devtools/dead_code_scanner scanning-plain-prolog-files1241147
Ref: 8fa1241147
Node: Known issues1242069
Ref: devtools/dead_code_scanner known-issues1242191
Ref: 8fb1242191
Node: debug_messages1242549
Ref: devtools/debug_messages doc1242678
Ref: 3521242678
Ref: devtools/debug_messages debug-messages1242678
Ref: 8fc1242678
Ref: devtools/debug_messages library-debug-messages1242678
Ref: 8fd1242678
Node: API documentation<4>1243166
Ref: devtools/debug_messages api-documentation1243276
Ref: 8fe1243276
Node: Loading<4>1243602
Ref: devtools/debug_messages loading1243731
Ref: 8ff1243731
Node: Testing<4>1243851
Ref: devtools/debug_messages testing1243968
Ref: 9001243968
Node: Usage<3>1244098
Ref: devtools/debug_messages usage1244196
Ref: 9011244196
Node: debugger1245739
Ref: devtools/debugger doc1245859
Ref: 2fc1245859
Ref: devtools/debugger debugger1245859
Ref: 9021245859
Ref: devtools/debugger library-debugger1245859
Ref: 9031245859
Node: API documentation<5>1246380
Ref: devtools/debugger api-documentation1246484
Ref: 9041246484
Node: Loading<5>1246625
Ref: devtools/debugger loading1246748
Ref: 9051246748
Node: Testing<5>1247020
Ref: devtools/debugger testing1247131
Ref: 9061247131
Node: Usage<4>1247255
Ref: devtools/debugger usage1247382
Ref: 9071247382
Node: Alternative debugger tools1248585
Ref: devtools/debugger alternative-debugger-tools1248717
Ref: 9081248717
Node: Known issues<2>1249562
Ref: devtools/debugger known-issues1249677
Ref: 9091249677
Node: diagrams1250678
Ref: devtools/diagrams doc1250790
Ref: 2ed1250790
Ref: devtools/diagrams diagrams1250790
Ref: 90a1250790
Ref: devtools/diagrams library-diagrams1250790
Ref: 90b1250790
Node: Requirements1252913
Ref: devtools/diagrams requirements1253019
Ref: 90c1253019
Node: macOS - MacPorts<2>1253503
Ref: devtools/diagrams macos-macports1253619
Ref: 90d1253619
Node: macOS - Homebrew<2>1253708
Ref: devtools/diagrams macos-homebrew1253856
Ref: 90e1253856
Node: Windows - Chocolatey<2>1253940
Ref: devtools/diagrams windows-chocolatey1254082
Ref: 90f1254082
Node: Installers<2>1254175
Ref: devtools/diagrams installers1254289
Ref: 9101254289
Node: API documentation<6>1254419
Ref: devtools/diagrams api-documentation1254544
Ref: 9111254544
Node: Loading<6>1254766
Ref: devtools/diagrams loading1254889
Ref: 9121254889
Node: Testing<6>1255003
Ref: devtools/diagrams testing1255124
Ref: 9131255124
Node: Supported diagrams1255248
Ref: devtools/diagrams supported-diagrams1255373
Ref: 9141255373
Node: Graph elements1257969
Ref: devtools/diagrams graph-elements1258109
Ref: 9151258109
Node: Supported graph languages1261323
Ref: devtools/diagrams supported-graph-languages1261458
Ref: 9161261458
Node: Customization1266123
Ref: devtools/diagrams customization1266260
Ref: 9171266260
Node: Linking diagrams1278852
Ref: devtools/diagrams linking-diagrams1279012
Ref: 9181279012
Node: Creating diagrams for Prolog module applications1283911
Ref: devtools/diagrams creating-diagrams-for-prolog-module-applications1284098
Ref: 9191284098
Node: Creating diagrams for plain Prolog files1284732
Ref: devtools/diagrams creating-diagrams-for-plain-prolog-files1284914
Ref: 91a1284914
Node: Other notes1285740
Ref: devtools/diagrams other-notes1285865
Ref: 91b1285865
Node: doclet1288480
Ref: devtools/doclet doc1288588
Ref: 32d1288588
Ref: devtools/doclet doclet1288588
Ref: 91c1288588
Ref: devtools/doclet library-doclet1288588
Ref: 91d1288588
Node: API documentation<7>1289734
Ref: devtools/doclet api-documentation1289836
Ref: 91e1289836
Node: Loading<7>1290056
Ref: devtools/doclet loading1290193
Ref: 91f1290193
Node: Automating running doclets1290305
Ref: devtools/doclet automating-running-doclets1290455
Ref: 9201290455
Node: Integration with the make tool<2>1290799
Ref: devtools/doclet integration-with-the-make-tool1290930
Ref: 9211290930
Node: help1291212
Ref: devtools/help doc1291325
Ref: 9221291325
Ref: devtools/help help1291325
Ref: 9231291325
Ref: devtools/help library-help1291325
Ref: 9241291325
Node: Requirements<2>1291793
Ref: devtools/help requirements1291894
Ref: 9251291894
Node: Customization<2>1293725
Ref: devtools/help customization1293855
Ref: 9261293855
Node: API documentation<8>1295708
Ref: devtools/help api-documentation1295833
Ref: 9271295833
Node: Loading<8>1295972
Ref: devtools/help loading1296091
Ref: 9281296091
Node: Testing<7>1296161
Ref: devtools/help testing1296287
Ref: 9291296287
Node: Supported operating-systems1296409
Ref: devtools/help supported-operating-systems1296533
Ref: 92a1296533
Node: Usage<5>1296744
Ref: devtools/help usage1296873
Ref: 92b1296873
Node: Known issues<3>1298312
Ref: devtools/help known-issues1298405
Ref: 92c1298405
Node: issue_creator1299359
Ref: devtools/issue_creator doc1299472
Ref: 92d1299472
Ref: devtools/issue_creator issue-creator1299472
Ref: 92e1299472
Ref: devtools/issue_creator library-issue-creator1299472
Ref: 92f1299472
Node: Requirements<3>1299785
Ref: devtools/issue_creator requirements1299889
Ref: 9301299889
Node: Loading<9>1300147
Ref: devtools/issue_creator loading1300268
Ref: 9311300268
Node: Usage<6>1300511
Ref: devtools/issue_creator usage1300632
Ref: 9321300632
Node: Known issues<4>1303491
Ref: devtools/issue_creator known-issues1303593
Ref: 9331303593
Node: lgtdoc1303993
Ref: devtools/lgtdoc doc1304109
Ref: 3221304109
Ref: devtools/lgtdoc lgtdoc1304109
Ref: 9341304109
Ref: devtools/lgtdoc library-lgtdoc1304109
Ref: 9351304109
Node: Requirements<4>1305142
Ref: devtools/lgtdoc requirements1305249
Ref: 9361305249
Node: API documentation<9>1306698
Ref: devtools/lgtdoc api-documentation1306825
Ref: 9371306825
Node: Loading<10>1306966
Ref: devtools/lgtdoc loading1307088
Ref: 9381307088
Node: Testing<8>1307202
Ref: devtools/lgtdoc testing1307327
Ref: 9391307327
Node: Documenting source code1307451
Ref: devtools/lgtdoc documenting-source-code1307589
Ref: 93a1307589
Node: Generating documentation1308572
Ref: devtools/lgtdoc generating-documentation1308727
Ref: 93b1308727
Ref: Generating documentation-Footnote-11310590
Node: Documentation linter checks1310640
Ref: devtools/lgtdoc documentation-linter-checks1310763
Ref: 93c1310763
Node: lgtunit1312350
Ref: devtools/lgtunit doc1312459
Ref: 1461312459
Ref: devtools/lgtunit lgtunit1312459
Ref: 93d1312459
Ref: devtools/lgtunit library-lgtunit1312459
Ref: 93e1312459
Node: Main files1314371
Ref: devtools/lgtunit main-files1314475
Ref: 93f1314475
Node: API documentation<10>1315038
Ref: devtools/lgtunit api-documentation1315162
Ref: 9401315162
Node: Loading<11>1315304
Ref: devtools/lgtunit loading1315428
Ref: 9411315428
Node: Testing<9>1315543
Ref: devtools/lgtunit testing1315671
Ref: 9421315671
Node: Writing and running tests1315796
Ref: devtools/lgtunit writing-and-running-tests1315937
Ref: 9431315937
Node: Automating running tests1321936
Ref: devtools/lgtunit automating-running-tests1322090
Ref: 9451322090
Node: Parametric test objects1325238
Ref: devtools/lgtunit parametric-test-objects1325380
Ref: 9461325380
Node: Test dialects1326503
Ref: devtools/lgtunit test-dialects1326647
Ref: 9441326647
Node: User-defined test dialects1332823
Ref: devtools/lgtunit user-defined-test-dialects1332954
Ref: 9471332954
Node: QuickCheck1334396
Ref: devtools/lgtunit quickcheck1334528
Ref: 9481334528
Node: Skipping tests1347298
Ref: devtools/lgtunit skipping-tests1347419
Ref: 9491347419
Node: Selecting tests1348689
Ref: devtools/lgtunit selecting-tests1348826
Ref: 94a1348826
Node: Checking test goal results1349844
Ref: devtools/lgtunit checking-test-goal-results1349991
Ref: 94b1349991
Node: Testing local predicates1353073
Ref: devtools/lgtunit testing-local-predicates1353241
Ref: 94c1353241
Node: Testing non-deterministic predicates1353852
Ref: devtools/lgtunit testing-non-deterministic-predicates1354012
Ref: 94d1354012
Node: Testing generators1355086
Ref: devtools/lgtunit testing-generators1355253
Ref: 94e1355253
Node: Testing input/output predicates1356187
Ref: devtools/lgtunit testing-input-output-predicates1356354
Ref: 94f1356354
Node: Suppressing tested predicates output1359946
Ref: devtools/lgtunit suppressing-tested-predicates-output1360120
Ref: 9501360120
Node: Tests with timeout limits1362287
Ref: devtools/lgtunit tests-with-timeout-limits1362453
Ref: 9511362453
Node: Setup and cleanup goals1363387
Ref: devtools/lgtunit setup-and-cleanup-goals1363533
Ref: 9521363533
Node: Test annotations1364521
Ref: devtools/lgtunit test-annotations1364679
Ref: 9531364679
Node: Test execution times and memory usage1365872
Ref: devtools/lgtunit test-execution-times-and-memory-usage1366035
Ref: 9541366035
Node: Working with test data files1367788
Ref: devtools/lgtunit working-with-test-data-files1367946
Ref: 9551367946
Node: Flaky tests1369559
Ref: devtools/lgtunit flaky-tests1369687
Ref: 9561369687
Node: Mocking1370528
Ref: devtools/lgtunit mocking1370655
Ref: 9571370655
Node: Debugging messages in tests1373702
Ref: devtools/lgtunit debugging-messages-in-tests1373840
Ref: 9581373840
Node: Debugging failed tests1374816
Ref: devtools/lgtunit debugging-failed-tests1374960
Ref: 9591374960
Node: Code coverage1377236
Ref: devtools/lgtunit code-coverage1377371
Ref: 95a1377371
Node: Utility predicates1381439
Ref: devtools/lgtunit utility-predicates1381574
Ref: 95b1381574
Node: Exporting test results1385668
Ref: devtools/lgtunit exporting-test-results1385815
Ref: 95c1385815
Node: xUnit XML format1385972
Ref: devtools/lgtunit xunit-xml-format1386093
Ref: 95d1386093
Node: TAP output format1387819
Ref: devtools/lgtunit tap-output-format1387965
Ref: 95e1387965
Node: CTRF JSON format1389301
Ref: devtools/lgtunit ctrf-json-format1389446
Ref: 95f1389446
Node: Subunit formats1390355
Ref: devtools/lgtunit subunit-formats1390474
Ref: 9601390474
Node: Generating Allure reports1391637
Ref: devtools/lgtunit generating-allure-reports1391797
Ref: 9611391797
Ref: Generating Allure reports-Footnote-11396494
Node: Exporting code coverage results1396533
Ref: devtools/lgtunit exporting-code-coverage-results1396723
Ref: 9621396723
Node: Simple XML format1397473
Ref: devtools/lgtunit simple-xml-format1397607
Ref: 9631397607
Node: Cobertura XML format1400099
Ref: devtools/lgtunit cobertura-xml-format1400253
Ref: 9641400253
Node: LCOV format1400656
Ref: devtools/lgtunit lcov-format1400784
Ref: 9651400784
Node: Automatically creating bug reports at issue trackers1401146
Ref: devtools/lgtunit automatically-creating-bug-reports-at-issue-trackers1401341
Ref: 9661401341
Node: Minimizing test results output1401587
Ref: devtools/lgtunit minimizing-test-results-output1401769
Ref: 9671401769
Node: Help with warnings1402075
Ref: devtools/lgtunit help-with-warnings1402220
Ref: 9681402220
Node: Known issues<5>1402372
Ref: devtools/lgtunit known-issues1402478
Ref: 9691402478
Node: linter1403208
Ref: devtools/linter doc1403326
Ref: 2af1403326
Ref: devtools/linter library-linter1403326
Ref: 96a1403326
Ref: devtools/linter linter1403326
Ref: 96b1403326
Ref: linter-Footnote-11404737
Ref: linter-Footnote-21404796
Ref: linter-Footnote-31404849
Ref: linter-Footnote-41404902
Node: Main linter checks1404950
Ref: devtools/linter main-linter-checks1405063
Ref: 96c1405063
Node: Help on linter warnings1408620
Ref: devtools/linter help-on-linter-warnings1408762
Ref: 96d1408762
Ref: Help on linter warnings-Footnote-11409060
Node: Extending the linter1409117
Ref: devtools/linter extending-the-linter1409263
Ref: 96e1409263
Ref: Extending the linter-Footnote-11409692
Node: Linting Prolog modules1409748
Ref: devtools/linter linting-prolog-modules1409897
Ref: 96f1409897
Node: Linting plain Prolog files1410326
Ref: devtools/linter linting-plain-prolog-files1410446
Ref: 9701410446
Node: linter_reporter1411323
Ref: devtools/linter_reporter doc1411438
Ref: 9711411438
Ref: devtools/linter_reporter library-linter-reporter1411438
Ref: 9721411438
Ref: devtools/linter_reporter linter-reporter1411438
Ref: 9731411438
Node: API documentation<11>1411823
Ref: devtools/linter_reporter api-documentation1411936
Ref: 9741411936
Node: Loading<12>1412086
Ref: devtools/linter_reporter loading1412219
Ref: 9751412219
Node: Testing<10>1413331
Ref: devtools/linter_reporter testing1413451
Ref: 9761413451
Node: Usage<7>1413821
Ref: devtools/linter_reporter usage1413937
Ref: 9771413937
Node: Options1414395
Ref: devtools/linter_reporter options1414491
Ref: 9781414491
Node: make1414785
Ref: devtools/make doc1414910
Ref: 9791414910
Ref: devtools/make library-make1414910
Ref: 97a1414910
Ref: devtools/make make1414910
Ref: 97b1414910
Node: API documentation<12>1415238
Ref: devtools/make api-documentation1415350
Ref: 97c1415350
Node: Help with warnings<2>1415903
Ref: devtools/make help-with-warnings1416039
Ref: 97d1416039
Node: Known issues<6>1416186
Ref: devtools/make known-issues1416292
Ref: 97e1416292
Node: mutation_testing1416825
Ref: devtools/mutation_testing doc1416940
Ref: 97f1416940
Ref: devtools/mutation_testing library-mutation-testing1416940
Ref: 9801416940
Ref: devtools/mutation_testing mutation-testing1416940
Ref: 9811416940
Node: API documentation<13>1417382
Ref: devtools/mutation_testing api-documentation1417496
Ref: 9821417496
Node: Loading<13>1417647
Ref: devtools/mutation_testing loading1417781
Ref: 9831417781
Node: Testing<11>1417905
Ref: devtools/mutation_testing testing1418026
Ref: 9841418026
Node: Features1418160
Ref: devtools/mutation_testing features1418286
Ref: 9851418286
Node: Default mutators1418857
Ref: devtools/mutation_testing default-mutators1418980
Ref: 9861418980
Node: Usage<8>1420503
Ref: devtools/mutation_testing usage1420629
Ref: 9871420629
Node: Limitations1423034
Ref: devtools/mutation_testing limitations1423154
Ref: 9881423154
Node: Options<2>1423824
Ref: devtools/mutation_testing options1423954
Ref: 9891423954
Node: Sampling semantics1426781
Ref: devtools/mutation_testing sampling-semantics1426921
Ref: 98a1426921
Node: Sampling modes1428337
Ref: devtools/mutation_testing sampling-modes1428461
Ref: 98b1428461
Node: Sampling usage in practice1429156
Ref: devtools/mutation_testing sampling-usage-in-practice1429280
Ref: 98c1429280
Node: Defining new mutators1430079
Ref: devtools/mutation_testing defining-new-mutators1430200
Ref: 98d1430200
Node: packs1431726
Ref: devtools/packs doc1431851
Ref: 6491431851
Ref: devtools/packs library-packs1431851
Ref: 98e1431851
Ref: devtools/packs packs1431851
Ref: 98f1431851
Node: Requirements<5>1433806
Ref: devtools/packs requirements1433913
Ref: 9901433913
Ref: Requirements<5>-Footnote-11436114
Node: API documentation<14>1436163
Ref: devtools/packs api-documentation1436290
Ref: 9911436290
Node: Loading<14>1436430
Ref: devtools/packs loading1436553
Ref: 9921436553
Node: Testing<12>1436666
Ref: devtools/packs testing1436776
Ref: 9931436776
Node: Usage<9>1436955
Ref: devtools/packs usage1437076
Ref: 9941437076
Node: Programmatic query API1437537
Ref: devtools/packs programmatic-query-api1437675
Ref: 9951437675
Node: Registries and packs storage1441775
Ref: devtools/packs registries-and-packs-storage1441925
Ref: 9961441925
Node: Virtual environments1443172
Ref: devtools/packs virtual-environments1443310
Ref: 9971443310
Ref: Virtual environments-Footnote-11447499
Ref: Virtual environments-Footnote-21447549
Ref: Virtual environments-Footnote-31447590
Node: Lock files1447639
Ref: devtools/packs lock-files1447771
Ref: 9981447771
Node: Registry specification1448518
Ref: devtools/packs registry-specification1448647
Ref: 9991448647
Node: Registry handling1451809
Ref: devtools/packs registry-handling1451948
Ref: 99a1451948
Ref: Registry handling-Footnote-11454695
Node: Registry development1454732
Ref: devtools/packs registry-development1454867
Ref: 99b1454867
Node: Pack specification1455789
Ref: devtools/packs pack-specification1455922
Ref: 99c1455922
Ref: Pack specification-Footnote-11458955
Node: Encrypted packs1458990
Ref: devtools/packs encrypted-packs1459115
Ref: 99d1459115
Node: Signed packs1459861
Ref: devtools/packs signed-packs1459996
Ref: 99e1459996
Node: Pack URLs and Single Sign-On1460932
Ref: devtools/packs pack-urls-and-single-sign-on1461074
Ref: 99f1461074
Node: Multiple pack versions1463271
Ref: devtools/packs multiple-pack-versions1463418
Ref: 9a01463418
Node: Pack dependencies1464619
Ref: devtools/packs pack-dependencies1464754
Ref: 9a11464754
Node: Pack portability1467900
Ref: devtools/packs pack-portability1468029
Ref: 9a21468029
Node: Pack development1468849
Ref: devtools/packs pack-development1468974
Ref: 9a31468974
Node: Pack handling1470211
Ref: devtools/packs pack-handling1470338
Ref: 9a41470338
Ref: Pack handling-Footnote-11475796
Node: Pack documentation1475828
Ref: devtools/packs pack-documentation1475967
Ref: 9a51475967
Node: Pinning registries and packs1477655
Ref: devtools/packs pinning-registries-and-packs1477794
Ref: 9a61477794
Node: Testing packs1478973
Ref: devtools/packs testing-packs1479117
Ref: 9a71479117
Node: Security considerations1479883
Ref: devtools/packs security-considerations1480013
Ref: 9a81480013
Node: Best practices1481266
Ref: devtools/packs best-practices1481406
Ref: 9a91481406
Node: Installing Prolog packs1482558
Ref: devtools/packs installing-prolog-packs1482696
Ref: 9aa1482696
Node: Help with warnings<3>1483736
Ref: devtools/packs help-with-warnings1483875
Ref: 9ab1483875
Node: Known issues<7>1484025
Ref: devtools/packs known-issues1484132
Ref: 9ac1484132
Node: ports_profiler1485497
Ref: devtools/ports_profiler doc1485614
Ref: 3581485614
Ref: devtools/ports_profiler library-ports-profiler1485614
Ref: 9ad1485614
Ref: devtools/ports_profiler ports-profiler1485614
Ref: 9ae1485614
Node: API documentation<15>1486805
Ref: devtools/ports_profiler api-documentation1486917
Ref: 9af1486917
Node: Loading<15>1487147
Ref: devtools/ports_profiler loading1487279
Ref: 9b01487279
Node: Testing<13>1487359
Ref: devtools/ports_profiler testing1487511
Ref: 9b11487511
Node: Compiling source files for port profiling1487643
Ref: devtools/ports_profiler compiling-source-files-for-port-profiling1487809
Ref: 9b21487809
Node: Generating profiling data1488561
Ref: devtools/ports_profiler generating-profiling-data1488747
Ref: 9b31488747
Node: Printing profiling data reports1489365
Ref: devtools/ports_profiler printing-profiling-data-reports1489537
Ref: 9b41489537
Node: Interpreting profiling data1492128
Ref: devtools/ports_profiler interpreting-profiling-data1492299
Ref: 9b51492299
Node: Profiling Prolog modules1493110
Ref: devtools/ports_profiler profiling-prolog-modules1493277
Ref: 9b61493277
Node: Profiling plain Prolog code1493721
Ref: devtools/ports_profiler profiling-plain-prolog-code1493876
Ref: 9b71493876
Node: Known issues<8>1495299
Ref: devtools/ports_profiler known-issues1495421
Ref: 9b81495421
Node: profiler1495567
Ref: devtools/profiler doc1495684
Ref: 9b91495684
Ref: devtools/profiler library-profiler1495684
Ref: 9ba1495684
Ref: devtools/profiler profiler1495684
Ref: 9bb1495684
Node: Loading<16>1495930
Ref: devtools/profiler loading1496026
Ref: 9bc1496026
Node: Testing<14>1496221
Ref: devtools/profiler testing1496360
Ref: 9bd1496360
Node: Supported backend Prolog compilers1496486
Ref: devtools/profiler supported-backend-prolog-compilers1496649
Ref: 9be1496649
Node: Compiling source code for profiling1498672
Ref: devtools/profiler compiling-source-code-for-profiling1498815
Ref: 9bf1498815
Node: sarif1499330
Ref: devtools/sarif doc1499437
Ref: 9c01499437
Ref: devtools/sarif library-sarif1499437
Ref: 9c11499437
Ref: devtools/sarif sarif1499437
Ref: 9c21499437
Node: API documentation<16>1499737
Ref: devtools/sarif api-documentation1499840
Ref: 9c31499840
Node: Loading<17>1499980
Ref: devtools/sarif loading1500103
Ref: 9c41500103
Node: Testing<15>1500205
Ref: devtools/sarif testing1500316
Ref: 9c51500316
Node: Usage<10>1500612
Ref: devtools/sarif usage1500703
Ref: 9c61500703
Node: sbom1501787
Ref: devtools/sbom doc1501902
Ref: 9c71501902
Ref: devtools/sbom library-sbom1501902
Ref: 9c81501902
Ref: devtools/sbom sbom1501902
Ref: 9c91501902
Node: API documentation<17>1502383
Ref: devtools/sbom api-documentation1502485
Ref: 9ca1502485
Node: Loading<18>1502624
Ref: devtools/sbom loading1502746
Ref: 9cb1502746
Node: Testing<16>1502858
Ref: devtools/sbom testing1502968
Ref: 9cc1502968
Node: Usage<11>1503077
Ref: devtools/sbom usage1503191
Ref: 9cd1503191
Node: Known issues<9>1521843
Ref: devtools/sbom known-issues1521937
Ref: 9ce1521937
Node: tool_diagnostics1522284
Ref: devtools/tool_diagnostics doc1522399
Ref: 9cf1522399
Ref: devtools/tool_diagnostics library-tool-diagnostics1522399
Ref: 9d01522399
Ref: devtools/tool_diagnostics tool-diagnostics1522399
Ref: 9d11522399
Node: API documentation<18>1523086
Ref: devtools/tool_diagnostics api-documentation1523200
Ref: 9d21523200
Node: Loading<19>1523360
Ref: devtools/tool_diagnostics loading1523500
Ref: 9d31523500
Node: Protocol overview1523649
Ref: devtools/tool_diagnostics protocol-overview1523784
Ref: 9d41523784
Node: Term conventions1524768
Ref: devtools/tool_diagnostics term-conventions1524901
Ref: 9d51524901
Node: Usage<12>1530195
Ref: devtools/tool_diagnostics usage1530302
Ref: 9d61530302
Node: tutor1531308
Ref: devtools/tutor doc1531426
Ref: 9d71531426
Ref: devtools/tutor library-tutor1531426
Ref: 9d81531426
Ref: devtools/tutor tutor1531426
Ref: 9d91531426
Node: API documentation<19>1531843
Ref: devtools/tutor api-documentation1531946
Ref: 9da1531946
Node: Loading<20>1532086
Ref: devtools/tutor loading1532207
Ref: 9db1532207
Node: Usage<13>1532320
Ref: devtools/tutor usage1532411
Ref: 9dc1532411
Node: wrapper1533901
Ref: devtools/wrapper doc1533994
Ref: 38b1533994
Ref: devtools/wrapper library-wrapper1533994
Ref: 9dd1533994
Ref: devtools/wrapper wrapper1533994
Ref: 9de1533994
Node: API documentation<20>1535101
Ref: devtools/wrapper api-documentation1535206
Ref: 9df1535206
Node: Loading<21>1535348
Ref: devtools/wrapper loading1535471
Ref: 9e01535471
Node: Workflows1535586
Ref: devtools/wrapper workflows1535704
Ref: 9e11535704
Node: Customization<3>1535965
Ref: devtools/wrapper customization1536091
Ref: 9e21536091
Node: Current limitations1538075
Ref: devtools/wrapper current-limitations1538183
Ref: 9e31538183
Ref: libraries/index library-library1539198
Ref: 9e41539198
Node: Libraries1539199
Ref: libraries/index doc1539306
Ref: 9e51539306
Ref: libraries/index libraries1539306
Ref: 9e61539306
Node: Overview<2>1543461
Ref: libraries/overview doc1543575
Ref: 9e71543575
Ref: libraries/overview overview1543575
Ref: 9e81543575
Node: Library documentation1550796
Ref: libraries/overview library-documentation1550911
Ref: 9e91550911
Node: Loading libraries1551214
Ref: libraries/overview loading-libraries1551355
Ref: 9ea1551355
Node: Testing libraries1552174
Ref: libraries/overview testing-libraries1552301
Ref: 9eb1552301
Node: Credits1552957
Ref: libraries/overview credits1553081
Ref: 9ec1553081
Node: Other notes<2>1553848
Ref: libraries/overview other-notes1553946
Ref: 9ed1553946
Node: adaptive_boosting_classifier1554108
Ref: libraries/adaptive_boosting_classifier doc1554254
Ref: 9ee1554254
Ref: libraries/adaptive_boosting_classifier adaptive-boosting-classifier1554254
Ref: 9ef1554254
Ref: libraries/adaptive_boosting_classifier library-adaptive-boosting-classifier1554254
Ref: 9f01554254
Node: API documentation<21>1555608
Ref: libraries/adaptive_boosting_classifier api-documentation1555734
Ref: 9f11555734
Node: Loading<22>1555881
Ref: libraries/adaptive_boosting_classifier loading1556027
Ref: 9f21556027
Node: Testing<17>1556190
Ref: libraries/adaptive_boosting_classifier testing1556326
Ref: 9f31556326
Node: Features<2>1556484
Ref: libraries/adaptive_boosting_classifier features1556619
Ref: 9f41556619
Node: Options<3>1557508
Ref: libraries/adaptive_boosting_classifier options1557657
Ref: 9f51557657
Node: Classifier representation1557853
Ref: libraries/adaptive_boosting_classifier classifier-representation1558001
Ref: 9f61558001
Node: References1558638
Ref: libraries/adaptive_boosting_classifier references1558785
Ref: 9f71558785
Node: Usage<14>1559259
Ref: libraries/adaptive_boosting_classifier usage1559372
Ref: 9f81559372
Node: Learning a Classifier1559542
Ref: libraries/adaptive_boosting_classifier learning-a-classifier1559656
Ref: 9f91559656
Node: Making Predictions1560015
Ref: libraries/adaptive_boosting_classifier making-predictions1560162
Ref: 9fa1560162
Node: Exporting the Classifier1560817
Ref: libraries/adaptive_boosting_classifier exporting-the-classifier1560967
Ref: 9fb1560967
Node: Using a Saved Classifier1561463
Ref: libraries/adaptive_boosting_classifier using-a-saved-classifier1561618
Ref: 9fc1561618
Node: Printing the Classifier1561961
Ref: libraries/adaptive_boosting_classifier printing-the-classifier1562083
Ref: 9fd1562083
Node: agglomerative_clusterer1562661
Ref: libraries/agglomerative_clusterer doc1562800
Ref: 9fe1562800
Ref: libraries/agglomerative_clusterer agglomerative-clusterer1562800
Ref: 9ff1562800
Ref: libraries/agglomerative_clusterer library-agglomerative-clusterer1562800
Ref: a001562800
Node: API documentation<22>1563515
Ref: libraries/agglomerative_clusterer api-documentation1563636
Ref: a011563636
Node: Loading<23>1563778
Ref: libraries/agglomerative_clusterer loading1563919
Ref: a021563919
Node: Testing<18>1564061
Ref: libraries/agglomerative_clusterer testing1564192
Ref: a031564192
Node: Features<3>1564500
Ref: libraries/agglomerative_clusterer features1564630
Ref: a041564630
Node: Options<4>1566589
Ref: libraries/agglomerative_clusterer options1566732
Ref: a051566732
Node: Clusterer representation1567330
Ref: libraries/agglomerative_clusterer clusterer-representation1567473
Ref: a061567473
Node: Diagnostics1568240
Ref: libraries/agglomerative_clusterer diagnostics1568364
Ref: a071568364
Node: amqp1568801
Ref: libraries/amqp doc1568939
Ref: a081568939
Ref: libraries/amqp amqp1568939
Ref: a091568939
Ref: libraries/amqp library-amqp1568939
Ref: a0a1568939
Node: API documentation<23>1569901
Ref: libraries/amqp api-documentation1570003
Ref: a0b1570003
Node: Loading<24>1570126
Ref: libraries/amqp loading1570248
Ref: a0c1570248
Node: Testing<19>1570371
Ref: libraries/amqp testing1570483
Ref: a0d1570483
Node: Features<4>1570772
Ref: libraries/amqp features1570882
Ref: a0e1570882
Node: Usage<15>1571732
Ref: libraries/amqp usage1571849
Ref: a0f1571849
Node: Connecting to an AMQP server1572187
Ref: libraries/amqp connecting-to-an-amqp-server1572307
Ref: a101572307
Node: Opening a channel1573406
Ref: libraries/amqp opening-a-channel1573565
Ref: a111573565
Node: Declaring exchanges and queues1573817
Ref: libraries/amqp declaring-exchanges-and-queues1573967
Ref: a121573967
Node: Publishing messages1574623
Ref: libraries/amqp publishing-messages1574774
Ref: a131574774
Node: Consuming messages1575530
Ref: libraries/amqp consuming-messages1575666
Ref: a141575666
Node: Synchronous get1576296
Ref: libraries/amqp synchronous-get1576431
Ref: a151576431
Node: Quality of Service1576581
Ref: libraries/amqp quality-of-service1576710
Ref: a161576710
Node: Transactions1576876
Ref: libraries/amqp transactions1577027
Ref: a171577027
Node: Publisher Confirms RabbitMQ extension1577437
Ref: libraries/amqp publisher-confirms-rabbitmq-extension1577589
Ref: a181577589
Node: Closing connections1577754
Ref: libraries/amqp closing-connections1577885
Ref: a191577885
Node: Connection Pooling1578058
Ref: libraries/amqp connection-pooling1578185
Ref: a1a1578185
Node: Defining a pool1578611
Ref: libraries/amqp defining-a-pool1578731
Ref: a1b1578731
Node: Initializing the pool1578855
Ref: libraries/amqp initializing-the-pool1579019
Ref: a1c1579019
Node: Acquiring and releasing connections1579822
Ref: libraries/amqp acquiring-and-releasing-connections1579994
Ref: a1d1579994
Node: Using with_connection/11580327
Ref: libraries/amqp using-with-connection-11580493
Ref: a1e1580493
Node: Pool statistics1580958
Ref: libraries/amqp pool-statistics1581106
Ref: a1f1581106
Node: Resizing the pool1581252
Ref: libraries/amqp resizing-the-pool1581396
Ref: a201581396
Node: Destroying the pool1581511
Ref: libraries/amqp destroying-the-pool1581666
Ref: a211581666
Node: Creating pools dynamically1581795
Ref: libraries/amqp creating-pools-dynamically1581924
Ref: a221581924
Node: Binary Frame Encoding1582195
Ref: libraries/amqp binary-frame-encoding1582323
Ref: a231582323
Node: Frame structure1582567
Ref: libraries/amqp frame-structure1582693
Ref: a241582693
Node: Encoding/decoding frames1583018
Ref: libraries/amqp encoding-decoding-frames1583144
Ref: a251583144
Node: Data Types1583349
Ref: libraries/amqp data-types1583489
Ref: a261583489
Node: Float/Double Encoding/Decoding1584390
Ref: libraries/amqp float-double-encoding-decoding1584523
Ref: a271584523
Node: Error Handling1585873
Ref: libraries/amqp error-handling1586017
Ref: a281586017
Node: Comparison with STOMP1586619
Ref: libraries/amqp comparison-with-stomp1586744
Ref: a291586744
Node: Future Work1587885
Ref: libraries/amqp future-work1588024
Ref: a2a1588024
Node: Known Limitations and Issues1588227
Ref: libraries/amqp known-limitations-and-issues1588367
Ref: a2b1588367
Node: AMQP 1 0 vs AMQP 0-9-11588844
Ref: libraries/amqp amqp-1-0-vs-amqp-0-9-11588964
Ref: a2c1588964
Ref: libraries/amqp amqp-10-vs-amqp-0-9-11588964
Ref: a2d1588964
Node: anomaly_detection_protocols1590534
Ref: libraries/anomaly_detection_protocols doc1590660
Ref: a2e1590660
Ref: libraries/anomaly_detection_protocols anomaly-detection-protocols1590660
Ref: a2f1590660
Ref: libraries/anomaly_detection_protocols library-anomaly-detection-protocols1590660
Ref: a301590660
Node: Export header format1592339
Ref: libraries/anomaly_detection_protocols export-header-format1592473
Ref: a311592473
Node: API documentation<24>1593166
Ref: libraries/anomaly_detection_protocols api-documentation1593320
Ref: a321593320
Node: Loading<25>1593466
Ref: libraries/anomaly_detection_protocols loading1593611
Ref: a331593611
Node: Testing<20>1593768
Ref: libraries/anomaly_detection_protocols testing1593905
Ref: a341593905
Node: Test datasets1594099
Ref: libraries/anomaly_detection_protocols test-datasets1594216
Ref: a351594216
Node: application1596887
Ref: libraries/application doc1597030
Ref: a361597030
Ref: libraries/application application1597030
Ref: a371597030
Ref: libraries/application library-application1597030
Ref: a381597030
Node: API documentation<25>1598199
Ref: libraries/application api-documentation1598308
Ref: a391598308
Node: Loading<26>1598438
Ref: libraries/application loading1598567
Ref: a3a1598567
Node: Testing<21>1598713
Ref: libraries/application testing1598830
Ref: a3b1598830
Node: Usage<16>1598971
Ref: libraries/application usage1599068
Ref: a3c1599068
Node: apriori_pattern_miner1603842
Ref: libraries/apriori_pattern_miner doc1603967
Ref: a3d1603967
Ref: libraries/apriori_pattern_miner apriori-pattern-miner1603967
Ref: a3e1603967
Ref: libraries/apriori_pattern_miner library-apriori-pattern-miner1603967
Ref: a3f1603967
Node: API documentation<26>1604864
Ref: libraries/apriori_pattern_miner api-documentation1604983
Ref: a401604983
Node: Loading<27>1605123
Ref: libraries/apriori_pattern_miner loading1605262
Ref: a411605262
Node: Testing<22>1605402
Ref: libraries/apriori_pattern_miner testing1605531
Ref: a421605531
Node: Features<5>1605682
Ref: libraries/apriori_pattern_miner features1605810
Ref: a431605810
Node: Options<5>1607198
Ref: libraries/apriori_pattern_miner options1607343
Ref: a441607343
Node: Pattern miner representation1608008
Ref: libraries/apriori_pattern_miner pattern-miner-representation1608155
Ref: a451608155
Node: References<2>1608728
Ref: libraries/apriori_pattern_miner references1608856
Ref: a461608856
Node: arbitrary1609010
Ref: libraries/arbitrary doc1609136
Ref: a471609136
Ref: libraries/arbitrary arbitrary1609136
Ref: a481609136
Ref: libraries/arbitrary library-arbitrary1609136
Ref: a491609136
Node: API documentation<27>1610039
Ref: libraries/arbitrary api-documentation1610146
Ref: a4a1610146
Node: Loading<28>1610274
Ref: libraries/arbitrary loading1610401
Ref: a4b1610401
Node: Testing<23>1610545
Ref: libraries/arbitrary testing1610668
Ref: a4c1610668
Node: Pre-defined types1610972
Ref: libraries/arbitrary pre-defined-types1611093
Ref: a4d1611093
Ref: Pre-defined types-Footnote-11611338
Node: Usage<17>1611386
Ref: libraries/arbitrary usage1611533
Ref: a4e1611533
Node: Defining new generators and shrinkers1611769
Ref: libraries/arbitrary defining-new-generators-and-shrinkers1611930
Ref: a4f1611930
Node: Scoped generators and shrinkers1617737
Ref: libraries/arbitrary scoped-generators-and-shrinkers1617929
Ref: a501617929
Node: Reproducing sequences of arbitrary terms1619351
Ref: libraries/arbitrary reproducing-sequences-of-arbitrary-terms1619537
Ref: a511619537
Node: Default size of generated terms1620664
Ref: libraries/arbitrary default-size-of-generated-terms1620835
Ref: a521620835
Node: Known issues<10>1621405
Ref: libraries/arbitrary known-issues1621527
Ref: a531621527
Node: arrangements1622209
Ref: libraries/arrangements doc1622324
Ref: a541622324
Ref: libraries/arrangements arrangements1622324
Ref: a551622324
Ref: libraries/arrangements library-arrangements1622324
Ref: a561622324
Node: API documentation<28>1623726
Ref: libraries/arrangements api-documentation1623836
Ref: a571623836
Node: Loading<29>1623967
Ref: libraries/arrangements loading1624097
Ref: a581624097
Node: Testing<24>1624244
Ref: libraries/arrangements testing1624344
Ref: a591624344
Node: assignvars1624486
Ref: libraries/assignvars doc1624596
Ref: a5a1624596
Ref: libraries/assignvars assignvars1624596
Ref: a5b1624596
Ref: libraries/assignvars library-assignvars1624596
Ref: a5c1624596
Node: API documentation<29>1625560
Ref: libraries/assignvars api-documentation1625668
Ref: a5d1625668
Node: Loading<30>1625799
Ref: libraries/assignvars loading1625927
Ref: a5e1625927
Node: Testing<25>1626074
Ref: libraries/assignvars testing1626172
Ref: a5f1626172
Node: avro1626314
Ref: libraries/avro doc1626418
Ref: a601626418
Ref: libraries/avro avro1626418
Ref: a611626418
Ref: libraries/avro library-avro1626418
Ref: a621626418
Node: API documentation<30>1626917
Ref: libraries/avro api-documentation1627019
Ref: a631627019
Node: Loading<31>1627144
Ref: libraries/avro loading1627266
Ref: a641627266
Node: Testing<26>1627407
Ref: libraries/avro testing1627529
Ref: a651627529
Node: Schema representation1627665
Ref: libraries/avro schema-representation1627795
Ref: a661627795
Node: Data representation1628021
Ref: libraries/avro data-representation1628155
Ref: a671628155
Node: Schema Examples1628413
Ref: libraries/avro schema-examples1628534
Ref: a681628534
Node: Encoding1628830
Ref: libraries/avro encoding1628940
Ref: a691628940
Node: Decoding1629602
Ref: libraries/avro decoding1629688
Ref: a6a1629688
Node: base321630251
Ref: libraries/base32 doc1630351
Ref: a6b1630351
Ref: libraries/base32 base321630351
Ref: a6c1630351
Ref: libraries/base32 library-base321630351
Ref: a6d1630351
Node: API documentation<31>1630715
Ref: libraries/base32 api-documentation1630819
Ref: a6e1630819
Node: Loading<32>1630946
Ref: libraries/base32 loading1631070
Ref: a6f1631070
Node: Testing<27>1631221
Ref: libraries/base32 testing1631335
Ref: a701631335
Node: Encoding<2>1631473
Ref: libraries/base32 encoding1631587
Ref: a711631587
Node: Decoding<2>1632244
Ref: libraries/base32 decoding1632338
Ref: a721632338
Node: base581633038
Ref: libraries/base58 doc1633140
Ref: a731633140
Ref: libraries/base58 base581633140
Ref: a741633140
Ref: libraries/base58 library-base581633140
Ref: a751633140
Node: API documentation<32>1633932
Ref: libraries/base58 api-documentation1634036
Ref: a761634036
Node: Loading<33>1634163
Ref: libraries/base58 loading1634287
Ref: a771634287
Node: Testing<28>1634438
Ref: libraries/base58 testing1634552
Ref: a781634552
Node: Encoding<3>1634690
Ref: libraries/base58 encoding1634804
Ref: a791634804
Node: Decoding<3>1635308
Ref: libraries/base58 decoding1635402
Ref: a7a1635402
Node: base641635717
Ref: libraries/base64 doc1635819
Ref: a7b1635819
Ref: libraries/base64 base641635819
Ref: a7c1635819
Ref: libraries/base64 library-base641635819
Ref: a7d1635819
Node: API documentation<33>1636199
Ref: libraries/base64 api-documentation1636303
Ref: a7e1636303
Node: Loading<34>1636430
Ref: libraries/base64 loading1636554
Ref: a7f1636554
Node: Testing<29>1636705
Ref: libraries/base64 testing1636819
Ref: a801636819
Node: Encoding<4>1636957
Ref: libraries/base64 encoding1637071
Ref: a811637071
Node: Decoding<4>1638121
Ref: libraries/base64 decoding1638215
Ref: a821638215
Node: base851639248
Ref: libraries/base85 doc1639355
Ref: a831639355
Ref: libraries/base85 base851639355
Ref: a841639355
Ref: libraries/base85 library-base851639355
Ref: a851639355
Node: API documentation<34>1639914
Ref: libraries/base85 api-documentation1640018
Ref: a861640018
Node: Loading<35>1640145
Ref: libraries/base85 loading1640269
Ref: a871640269
Node: Testing<30>1640420
Ref: libraries/base85 testing1640534
Ref: a881640534
Node: Encoding<5>1640672
Ref: libraries/base85 encoding1640786
Ref: a891640786
Node: Decoding<5>1641228
Ref: libraries/base85 decoding1641322
Ref: a8a1641322
Node: basic_types1641814
Ref: libraries/basic_types doc1641940
Ref: a8b1641940
Ref: libraries/basic_types basic-types1641940
Ref: a8c1641940
Ref: libraries/basic_types library-basic-types1641940
Ref: a8d1641940
Node: API documentation<35>1642384
Ref: libraries/basic_types api-documentation1642493
Ref: a8e1642493
Node: Loading<36>1642619
Ref: libraries/basic_types loading1642748
Ref: a8f1642748
Node: Testing<31>1642896
Ref: libraries/basic_types testing1642995
Ref: a901642995
Node: bayesian_ridge_regression1643160
Ref: libraries/bayesian_ridge_regression doc1643292
Ref: a911643292
Ref: libraries/bayesian_ridge_regression bayesian-ridge-regression1643292
Ref: a921643292
Ref: libraries/bayesian_ridge_regression library-bayesian-ridge-regression1643292
Ref: a931643292
Node: API documentation<36>1643920
Ref: libraries/bayesian_ridge_regression api-documentation1644043
Ref: a941644043
Node: Loading<37>1644189
Ref: libraries/bayesian_ridge_regression loading1644332
Ref: a951644332
Node: Testing<32>1644478
Ref: libraries/bayesian_ridge_regression testing1644611
Ref: a961644611
Node: Features<6>1644925
Ref: libraries/bayesian_ridge_regression features1645071
Ref: a971645071
Node: Regressor representation1647747
Ref: libraries/bayesian_ridge_regression regressor-representation1647900
Ref: a981647900
Node: Diagnostics syntax1648316
Ref: libraries/bayesian_ridge_regression diagnostics-syntax1648468
Ref: a991648468
Node: Options<6>1650320
Ref: libraries/bayesian_ridge_regression options1650439
Ref: a9a1650439
Node: borda_ranker1652234
Ref: libraries/borda_ranker doc1652375
Ref: a9b1652375
Ref: libraries/borda_ranker borda-ranker1652375
Ref: a9c1652375
Ref: libraries/borda_ranker library-borda-ranker1652375
Ref: a9d1652375
Node: API documentation<37>1653477
Ref: libraries/borda_ranker api-documentation1653587
Ref: a9e1653587
Node: Loading<38>1653720
Ref: libraries/borda_ranker loading1653850
Ref: a9f1653850
Node: Testing<33>1653983
Ref: libraries/borda_ranker testing1654103
Ref: aa01654103
Node: Features<7>1654391
Ref: libraries/borda_ranker features1654517
Ref: aa11654517
Node: Scoring semantics1656488
Ref: libraries/borda_ranker scoring-semantics1656612
Ref: aa21656612
Node: Usage<18>1657742
Ref: libraries/borda_ranker usage1657876
Ref: aa31657876
Node: Learning a ranker1658015
Ref: libraries/borda_ranker learning-a-ranker1658129
Ref: aa41658129
Node: Inspecting diagnostics1658850
Ref: libraries/borda_ranker inspecting-diagnostics1658996
Ref: aa51658996
Node: Ranking candidate items1659255
Ref: libraries/borda_ranker ranking-candidate-items1659404
Ref: aa61659404
Node: Exporting the ranker1659931
Ref: libraries/borda_ranker exporting-the-ranker1660049
Ref: aa71660049
Node: Diagnostics syntax<2>1660586
Ref: libraries/borda_ranker diagnostics-syntax1660713
Ref: aa81660713
Node: Options<7>1661662
Ref: libraries/borda_ranker options1661801
Ref: aa91661801
Node: Ranker representation1662308
Ref: libraries/borda_ranker ranker-representation1662439
Ref: aaa1662439
Node: References<3>1663050
Ref: libraries/borda_ranker references1663162
Ref: aab1663162
Node: bradley_terry_ranker1663326
Ref: libraries/bradley_terry_ranker doc1663456
Ref: aac1663456
Ref: libraries/bradley_terry_ranker bradley-terry-ranker1663456
Ref: aad1663456
Ref: libraries/bradley_terry_ranker library-bradley-terry-ranker1663456
Ref: aae1663456
Node: API documentation<38>1664798
Ref: libraries/bradley_terry_ranker api-documentation1664916
Ref: aaf1664916
Node: Loading<39>1665057
Ref: libraries/bradley_terry_ranker loading1665195
Ref: ab01665195
Node: Testing<34>1665336
Ref: libraries/bradley_terry_ranker testing1665464
Ref: ab11665464
Node: Features<8>1665768
Ref: libraries/bradley_terry_ranker features1665905
Ref: ab21665905
Node: Dataset requirements1667103
Ref: libraries/bradley_terry_ranker dataset-requirements1667238
Ref: ab31667238
Node: Usage<19>1668003
Ref: libraries/bradley_terry_ranker usage1668148
Ref: ab41668148
Node: Learning a ranker<2>1668281
Ref: libraries/bradley_terry_ranker learning-a-ranker1668401
Ref: ab51668401
Node: Inspecting diagnostics<2>1668751
Ref: libraries/bradley_terry_ranker inspecting-diagnostics1668871
Ref: ab61668871
Node: Diagnostics syntax<3>1669152
Ref: libraries/bradley_terry_ranker diagnostics-syntax1669287
Ref: ab71669287
Node: Ranking candidate items<2>1671560
Ref: libraries/bradley_terry_ranker ranking-candidate-items1671696
Ref: ab81671696
Node: Exporting the ranker<2>1672239
Ref: libraries/bradley_terry_ranker exporting-the-ranker1672375
Ref: ab91672375
Node: Options<8>1672941
Ref: libraries/bradley_terry_ranker options1673091
Ref: aba1673091
Node: Ranker representation<2>1673347
Ref: libraries/bradley_terry_ranker ranker-representation1673489
Ref: abb1673489
Node: References<4>1674166
Ref: libraries/bradley_terry_ranker references1674289
Ref: abc1674289
Node: c45_classifier1674628
Ref: libraries/c45_classifier doc1674764
Ref: abd1674764
Ref: libraries/c45_classifier c45-classifier1674764
Ref: abe1674764
Ref: libraries/c45_classifier library-c45-classifier1674764
Ref: abf1674764
Node: API documentation<39>1675815
Ref: libraries/c45_classifier api-documentation1675927
Ref: ac01675927
Node: Loading<40>1676062
Ref: libraries/c45_classifier loading1676194
Ref: ac11676194
Node: Testing<35>1676345
Ref: libraries/c45_classifier testing1676476
Ref: ac21676476
Node: Implemented features1676622
Ref: libraries/c45_classifier implemented-features1676769
Ref: ac31676769
Node: Learned tree representation1678175
Ref: libraries/c45_classifier learned-tree-representation1678325
Ref: ac41678325
Node: Limitations<2>1678920
Ref: libraries/c45_classifier limitations1679063
Ref: ac51679063
Node: References<5>1679205
Ref: libraries/c45_classifier references1679330
Ref: ac61679330
Node: Usage<20>1679764
Ref: libraries/c45_classifier usage1679866
Ref: ac71679866
Node: cartesian_products1681168
Ref: libraries/cartesian_products doc1681288
Ref: ac81681288
Ref: libraries/cartesian_products cartesian-products1681288
Ref: ac91681288
Ref: libraries/cartesian_products library-cartesian-products1681288
Ref: aca1681288
Node: API documentation<40>1682558
Ref: libraries/cartesian_products api-documentation1682674
Ref: acb1682674
Node: Loading<41>1682813
Ref: libraries/cartesian_products loading1682949
Ref: acc1682949
Node: Testing<36>1683104
Ref: libraries/cartesian_products testing1683210
Ref: acd1683210
Node: cbor1683360
Ref: libraries/cbor doc1683480
Ref: ace1683480
Ref: libraries/cbor cbor1683480
Ref: acf1683480
Ref: libraries/cbor library-cbor1683480
Ref: ad01683480
Node: Representation1684013
Ref: libraries/cbor representation1684108
Ref: ad11684108
Node: Encoding<6>1685965
Ref: libraries/cbor encoding1686080
Ref: ad21686080
Node: Decoding<6>1686506
Ref: libraries/cbor decoding1686628
Ref: ad31686628
Node: API documentation<41>1686850
Ref: libraries/cbor api-documentation1686972
Ref: ad41686972
Node: Loading<42>1687097
Ref: libraries/cbor loading1687219
Ref: ad51687219
Node: Testing<37>1687360
Ref: libraries/cbor testing1687452
Ref: ad61687452
Node: character_sets1687588
Ref: libraries/character_sets doc1687702
Ref: ad71687702
Ref: libraries/character_sets character-sets1687702
Ref: ad81687702
Ref: libraries/character_sets library-character-sets1687702
Ref: ad91687702
Node: API documentation<42>1689661
Ref: libraries/character_sets api-documentation1689773
Ref: ada1689773
Node: Loading<43>1689908
Ref: libraries/character_sets loading1690040
Ref: adb1690040
Node: Testing<38>1690191
Ref: libraries/character_sets testing1690311
Ref: adc1690311
Node: Usage<21>1690457
Ref: libraries/character_sets usage1690557
Ref: add1690557
Node: ccsds_frames1691062
Ref: libraries/ccsds_frames doc1691191
Ref: ade1691191
Ref: libraries/ccsds_frames ccsds-frames1691191
Ref: adf1691191
Ref: libraries/ccsds_frames library-ccsds-frames1691191
Ref: ae01691191
Node: Available entities1691789
Ref: libraries/ccsds_frames available-entities1691902
Ref: ae11691902
Node: Representation<2>1692871
Ref: libraries/ccsds_frames representation1693015
Ref: ae21693015
Node: Parsing and generating1694650
Ref: libraries/ccsds_frames parsing-and-generating1694781
Ref: ae31694781
Node: Types1696447
Ref: libraries/ccsds_frames types1696575
Ref: ae41696575
Node: Facade helpers1698096
Ref: libraries/ccsds_frames facade-helpers1698223
Ref: ae51698223
Node: API documentation<43>1699643
Ref: libraries/ccsds_frames api-documentation1699776
Ref: ae61699776
Node: Loading<44>1699909
Ref: libraries/ccsds_frames loading1700039
Ref: ae71700039
Node: Testing<39>1700188
Ref: libraries/ccsds_frames testing1700288
Ref: ae81700288
Node: ccsds_link_profiles1700432
Ref: libraries/ccsds_link_profiles doc1700568
Ref: ae91700568
Ref: libraries/ccsds_link_profiles ccsds-link-profiles1700568
Ref: aea1700568
Ref: libraries/ccsds_link_profiles library-ccsds-link-profiles1700568
Ref: aeb1700568
Node: Representation<3>1701215
Ref: libraries/ccsds_link_profiles representation1701327
Ref: aec1701327
Node: Public API1701902
Ref: libraries/ccsds_link_profiles public-api1702048
Ref: aed1702048
Node: Parsing and generating<2>1702555
Ref: libraries/ccsds_link_profiles parsing-and-generating1702698
Ref: aee1702698
Node: Packet helpers1703683
Ref: libraries/ccsds_link_profiles packet-helpers1703837
Ref: aef1703837
Node: API documentation<44>1705137
Ref: libraries/ccsds_link_profiles api-documentation1705277
Ref: af01705277
Node: Loading<45>1705417
Ref: libraries/ccsds_link_profiles loading1705554
Ref: af11705554
Node: Testing<40>1705710
Ref: libraries/ccsds_link_profiles testing1705817
Ref: af21705817
Node: ccsds_packet_services1705968
Ref: libraries/ccsds_packet_services doc1706111
Ref: af31706111
Ref: libraries/ccsds_packet_services ccsds-packet-services1706111
Ref: af41706111
Ref: libraries/ccsds_packet_services library-ccsds-packet-services1706111
Ref: af51706111
Node: Representation<4>1708341
Ref: libraries/ccsds_packet_services representation1708464
Ref: af61708464
Node: Packet-zone helpers1711485
Ref: libraries/ccsds_packet_services packet-zone-helpers1711649
Ref: af71711649
Node: Telemetry transfer frame helpers1712165
Ref: libraries/ccsds_packet_services telemetry-transfer-frame-helpers1712345
Ref: af81712345
Node: Advanced orbiting systems helpers1713140
Ref: libraries/ccsds_packet_services advanced-orbiting-systems-helpers1713330
Ref: af91713330
Node: Cross-frame packet reassembly1714542
Ref: libraries/ccsds_packet_services cross-frame-packet-reassembly1714705
Ref: afa1714705
Node: Scope1718688
Ref: libraries/ccsds_packet_services scope1718839
Ref: afb1718839
Node: API documentation<45>1719274
Ref: libraries/ccsds_packet_services api-documentation1719407
Ref: afc1719407
Node: Loading<46>1719549
Ref: libraries/ccsds_packet_services loading1719688
Ref: afd1719688
Node: Testing<41>1719846
Ref: libraries/ccsds_packet_services testing1719955
Ref: afe1719955
Node: ccsds_packetization1720108
Ref: libraries/ccsds_packetization doc1720245
Ref: aff1720245
Ref: libraries/ccsds_packetization ccsds-packetization1720245
Ref: b001720245
Ref: libraries/ccsds_packetization library-ccsds-packetization1720245
Ref: b011720245
Node: Representation<5>1721098
Ref: libraries/ccsds_packetization representation1721213
Ref: b021721213
Node: Packetization1722152
Ref: libraries/ccsds_packetization packetization1722282
Ref: b031722282
Node: Events1723822
Ref: libraries/ccsds_packetization events1723947
Ref: b041723947
Node: Idle packets1724466
Ref: libraries/ccsds_packetization idle-packets1724599
Ref: b051724599
Node: API documentation<46>1724770
Ref: libraries/ccsds_packetization api-documentation1724908
Ref: b061724908
Node: Loading<47>1725048
Ref: libraries/ccsds_packetization loading1725185
Ref: b071725185
Node: Testing<42>1725341
Ref: libraries/ccsds_packetization testing1725448
Ref: b081725448
Node: ccsds_packets1725599
Ref: libraries/ccsds_packets doc1725732
Ref: b091725732
Ref: libraries/ccsds_packets ccsds-packets1725732
Ref: b0a1725732
Ref: libraries/ccsds_packets library-ccsds-packets1725732
Ref: b0b1725732
Node: Packet Structure1726471
Ref: libraries/ccsds_packets packet-structure1726583
Ref: b0c1726583
Node: Representation<6>1727241
Ref: libraries/ccsds_packets representation1727369
Ref: b0d1727369
Node: Parsing1728266
Ref: libraries/ccsds_packets parsing1728388
Ref: b0e1728388
Node: Generating1729479
Ref: libraries/ccsds_packets generating1729603
Ref: b0f1729603
Node: Accessor Predicates1730352
Ref: libraries/ccsds_packets accessor-predicates1730499
Ref: b101730499
Node: Types and arbitrary generators1731554
Ref: libraries/ccsds_packets types-and-arbitrary-generators1731712
Ref: b111731712
Node: API documentation<47>1732633
Ref: libraries/ccsds_packets api-documentation1732783
Ref: b121732783
Node: Loading<48>1732917
Ref: libraries/ccsds_packets loading1733048
Ref: b131733048
Node: Testing<43>1733198
Ref: libraries/ccsds_packets testing1733299
Ref: b141733299
Node: ccsds_tc_services1733608
Ref: libraries/ccsds_tc_services doc1733738
Ref: b151733738
Ref: libraries/ccsds_tc_services ccsds-tc-services1733738
Ref: b161733738
Ref: libraries/ccsds_tc_services library-ccsds-tc-services1733738
Ref: b171733738
Node: Representation<7>1735168
Ref: libraries/ccsds_tc_services representation1735276
Ref: b181735276
Node: Scope<2>1738934
Ref: libraries/ccsds_tc_services scope1739064
Ref: b191739064
Node: Examples<166>1739541
Ref: libraries/ccsds_tc_services examples1739675
Ref: b1a1739675
Node: API documentation<48>1742053
Ref: libraries/ccsds_tc_services api-documentation1742190
Ref: b1b1742190
Node: Loading<49>1742328
Ref: libraries/ccsds_tc_services loading1742463
Ref: b1c1742463
Node: Testing<44>1742617
Ref: libraries/ccsds_tc_services testing1742722
Ref: b1d1742722
Node: ccsds_time_codes1742871
Ref: libraries/ccsds_time_codes doc1743005
Ref: b1e1743005
Ref: libraries/ccsds_time_codes ccsds-time-codes1743005
Ref: b1f1743005
Ref: libraries/ccsds_time_codes library-ccsds-time-codes1743005
Ref: b201743005
Node: Available entities<2>1743748
Ref: libraries/ccsds_time_codes available-entities1743868
Ref: b211743868
Node: Representation<8>1744673
Ref: libraries/ccsds_time_codes representation1744827
Ref: b221744827
Node: Parsing and generating<3>1746151
Ref: libraries/ccsds_time_codes parsing-and-generating1746304
Ref: b231746304
Node: Unix time conversion1747947
Ref: libraries/ccsds_time_codes unix-time-conversion1748116
Ref: b241748116
Node: Types and arbitrary generators<2>1749257
Ref: libraries/ccsds_time_codes types-and-arbitrary-generators1749422
Ref: b251749422
Node: API documentation<49>1750547
Ref: libraries/ccsds_time_codes api-documentation1750703
Ref: b261750703
Node: Loading<50>1750840
Ref: libraries/ccsds_time_codes loading1750974
Ref: b271750974
Node: Testing<45>1751127
Ref: libraries/ccsds_time_codes testing1751231
Ref: b281751231
Node: ccsds_time_fields1751379
Ref: libraries/ccsds_time_fields doc1751520
Ref: b291751520
Ref: libraries/ccsds_time_fields ccsds-time-fields1751520
Ref: b2a1751520
Ref: libraries/ccsds_time_fields library-ccsds-time-fields1751520
Ref: b2b1751520
Node: Representation<9>1752425
Ref: libraries/ccsds_time_fields representation1752550
Ref: b2c1752550
Node: Parsing and generating<4>1753348
Ref: libraries/ccsds_time_fields parsing-and-generating1753500
Ref: b2d1753500
Node: Descriptor helpers1754655
Ref: libraries/ccsds_time_fields descriptor-helpers1754811
Ref: b2e1754811
Node: API documentation<50>1755178
Ref: libraries/ccsds_time_fields api-documentation1755320
Ref: b2f1755320
Node: Loading<51>1755458
Ref: libraries/ccsds_time_fields loading1755593
Ref: b301755593
Node: Testing<46>1755747
Ref: libraries/ccsds_time_fields testing1755852
Ref: b311755852
Node: classification_protocols1756001
Ref: libraries/classification_protocols doc1756148
Ref: b321756148
Ref: libraries/classification_protocols classification-protocols1756148
Ref: b331756148
Ref: libraries/classification_protocols library-classification-protocols1756148
Ref: b341756148
Node: Shared category1757167
Ref: libraries/classification_protocols shared-category1757286
Ref: b351757286
Node: Diagnostics<2>1757691
Ref: libraries/classification_protocols diagnostics1757842
Ref: b361757842
Node: Export header format<2>1758472
Ref: libraries/classification_protocols export-header-format1758629
Ref: b371758629
Node: API documentation<51>1759495
Ref: libraries/classification_protocols api-documentation1759649
Ref: b381759649
Node: Loading<52>1759794
Ref: libraries/classification_protocols loading1759936
Ref: b391759936
Node: Testing<47>1760092
Ref: libraries/classification_protocols testing1760229
Ref: b3a1760229
Node: Test datasets<2>1760413
Ref: libraries/classification_protocols test-datasets1760530
Ref: b3b1760530
Node: clo_span_pattern_miner1762738
Ref: libraries/clo_span_pattern_miner doc1762888
Ref: b3c1762888
Ref: libraries/clo_span_pattern_miner clo-span-pattern-miner1762888
Ref: b3d1762888
Ref: libraries/clo_span_pattern_miner library-clo-span-pattern-miner1762888
Ref: b3e1762888
Node: API documentation<52>1763958
Ref: libraries/clo_span_pattern_miner api-documentation1764078
Ref: b3f1764078
Node: Loading<53>1764221
Ref: libraries/clo_span_pattern_miner loading1764361
Ref: b401764361
Node: Testing<48>1764504
Ref: libraries/clo_span_pattern_miner testing1764634
Ref: b411764634
Node: Features<9>1764788
Ref: libraries/clo_span_pattern_miner features1764917
Ref: b421764917
Node: Options<9>1765779
Ref: libraries/clo_span_pattern_miner options1765928
Ref: b431765928
Node: Pattern miner representation<2>1766619
Ref: libraries/clo_span_pattern_miner pattern-miner-representation1766770
Ref: b441766770
Node: References<6>1767368
Ref: libraries/clo_span_pattern_miner references1767500
Ref: b451767500
Node: clustering_protocols1767658
Ref: libraries/clustering_protocols doc1767797
Ref: b461767797
Ref: libraries/clustering_protocols clustering-protocols1767797
Ref: b471767797
Ref: libraries/clustering_protocols library-clustering-protocols1767797
Ref: b481767797
Node: API documentation<53>1768733
Ref: libraries/clustering_protocols api-documentation1768851
Ref: b491768851
Node: Loading<54>1768992
Ref: libraries/clustering_protocols loading1769130
Ref: b4a1769130
Node: Testing<49>1769287
Ref: libraries/clustering_protocols testing1769420
Ref: b4b1769420
Node: Test datasets<3>1769599
Ref: libraries/clustering_protocols test-datasets1769712
Ref: b4c1769712
Node: colley_ranker1773659
Ref: libraries/colley_ranker doc1773788
Ref: b4d1773788
Ref: libraries/colley_ranker colley-ranker1773788
Ref: b4e1773788
Ref: libraries/colley_ranker library-colley-ranker1773788
Ref: b4f1773788
Node: API documentation<54>1774784
Ref: libraries/colley_ranker api-documentation1774895
Ref: b501774895
Node: Loading<55>1775029
Ref: libraries/colley_ranker loading1775160
Ref: b511775160
Node: Testing<50>1775294
Ref: libraries/colley_ranker testing1775416
Ref: b521775416
Node: Features<10>1775561
Ref: libraries/colley_ranker features1775692
Ref: b531775692
Node: Scoring semantics<2>1776815
Ref: libraries/colley_ranker scoring-semantics1776944
Ref: b541776944
Node: Usage<22>1777747
Ref: libraries/colley_ranker usage1777885
Ref: b551777885
Node: Learning a ranker<3>1778122
Ref: libraries/colley_ranker learning-a-ranker1778242
Ref: b561778242
Node: Inspecting diagnostics<3>1778640
Ref: libraries/colley_ranker inspecting-diagnostics1778795
Ref: b571778795
Node: Ranking candidate items<3>1779056
Ref: libraries/colley_ranker ranking-candidate-items1779214
Ref: b581779214
Node: Exporting the ranker<3>1779743
Ref: libraries/colley_ranker exporting-the-ranker1779867
Ref: b591779867
Node: Diagnostics syntax<4>1780409
Ref: libraries/colley_ranker diagnostics-syntax1780551
Ref: b5a1780551
Node: Ranker representation<3>1780801
Ref: libraries/colley_ranker ranker-representation1780947
Ref: b5b1780947
Node: References<7>1781331
Ref: libraries/colley_ranker references1781447
Ref: b5c1781447
Node: combinations1781603
Ref: libraries/combinations doc1781732
Ref: b5d1781732
Ref: libraries/combinations combinations1781732
Ref: b5e1781732
Ref: libraries/combinations library-combinations1781732
Ref: b5f1781732
Node: API documentation<55>1783164
Ref: libraries/combinations api-documentation1783274
Ref: b601783274
Node: Loading<56>1783407
Ref: libraries/combinations loading1783537
Ref: b611783537
Node: Testing<51>1783686
Ref: libraries/combinations testing1783786
Ref: b621783786
Node: command_line_options1783930
Ref: libraries/command_line_options doc1784050
Ref: b631784050
Ref: libraries/command_line_options command-line-options1784050
Ref: b641784050
Ref: libraries/command_line_options library-command-line-options1784050
Ref: b651784050
Node: API documentation<56>1785261
Ref: libraries/command_line_options api-documentation1785379
Ref: b661785379
Node: Loading<57>1785520
Ref: libraries/command_line_options loading1785658
Ref: b671785658
Node: Testing<52>1785823
Ref: libraries/command_line_options testing1785951
Ref: b681785951
Node: Terminology1786103
Ref: libraries/command_line_options terminology1786243
Ref: b691786243
Node: Defining option objects1787247
Ref: libraries/command_line_options defining-option-objects1787405
Ref: b6a1787405
Node: Validating option definitions1788498
Ref: libraries/command_line_options validating-option-definitions1788667
Ref: b6b1788667
Node: Example option objects1789740
Ref: libraries/command_line_options example-option-objects1789916
Ref: b6c1789916
Node: Parsing command-line arguments1791432
Ref: libraries/command_line_options parsing-command-line-arguments1791599
Ref: b6d1791599
Node: Generating help text1792124
Ref: libraries/command_line_options generating-help-text1792281
Ref: b6e1792281
Node: Help options1792670
Ref: libraries/command_line_options help-options1792810
Ref: b6f1792810
Node: Parse options1793352
Ref: libraries/command_line_options parse-options1793486
Ref: b701793486
Node: Notes and tips1794122
Ref: libraries/command_line_options notes-and-tips1794235
Ref: b711794235
Node: core1794784
Ref: libraries/core doc1794907
Ref: b721794907
Ref: libraries/core core1794907
Ref: b731794907
Ref: libraries/core library-core1794907
Ref: b741794907
Node: API documentation<57>1795083
Ref: libraries/core api-documentation1795185
Ref: b751795185
Node: Loading<58>1795318
Ref: libraries/core loading1795440
Ref: b761795440
Node: Testing<53>1795546
Ref: libraries/core testing1795638
Ref: b771795638
Node: copeland_ranker1795753
Ref: libraries/copeland_ranker doc1795867
Ref: b781795867
Ref: libraries/copeland_ranker copeland-ranker1795867
Ref: b791795867
Ref: libraries/copeland_ranker library-copeland-ranker1795867
Ref: b7a1795867
Node: API documentation<58>1797120
Ref: libraries/copeland_ranker api-documentation1797233
Ref: b7b1797233
Node: Loading<59>1797369
Ref: libraries/copeland_ranker loading1797502
Ref: b7c1797502
Node: Testing<54>1797638
Ref: libraries/copeland_ranker testing1797762
Ref: b7d1797762
Node: Features<11>1797909
Ref: libraries/copeland_ranker features1798042
Ref: b7e1798042
Node: Scoring semantics<3>1799361
Ref: libraries/copeland_ranker scoring-semantics1799492
Ref: b7f1799492
Node: Usage<23>1800493
Ref: libraries/copeland_ranker usage1800633
Ref: b801800633
Node: Learning a ranker<4>1800870
Ref: libraries/copeland_ranker learning-a-ranker1800990
Ref: b811800990
Node: Inspecting diagnostics<4>1801392
Ref: libraries/copeland_ranker inspecting-diagnostics1801547
Ref: b821801547
Node: Ranking candidate items<4>1801812
Ref: libraries/copeland_ranker ranking-candidate-items1801970
Ref: b831801970
Node: Exporting the ranker<4>1802503
Ref: libraries/copeland_ranker exporting-the-ranker1802627
Ref: b841802627
Node: Diagnostics syntax<5>1803179
Ref: libraries/copeland_ranker diagnostics-syntax1803310
Ref: b851803310
Node: Options<10>1804317
Ref: libraries/copeland_ranker options1804463
Ref: b861804463
Node: Ranker representation<4>1804639
Ref: libraries/copeland_ranker ranker-representation1804777
Ref: b871804777
Node: References<8>1805706
Ref: libraries/copeland_ranker references1805824
Ref: b881805824
Node: coroutining1806015
Ref: libraries/coroutining doc1806140
Ref: b891806140
Ref: libraries/coroutining coroutining1806140
Ref: b8a1806140
Ref: libraries/coroutining library-coroutining1806140
Ref: b8b1806140
Node: API documentation<59>1806885
Ref: libraries/coroutining api-documentation1806994
Ref: b8c1806994
Node: Loading<60>1807126
Ref: libraries/coroutining loading1807255
Ref: b8d1807255
Node: Testing<55>1807403
Ref: libraries/coroutining testing1807520
Ref: b8e1807520
Node: Usage<24>1807663
Ref: libraries/coroutining usage1807760
Ref: b8f1807760
Node: crs_projections1808127
Ref: libraries/crs_projections doc1808240
Ref: b901808240
Ref: libraries/crs_projections crs-projections1808240
Ref: b911808240
Ref: libraries/crs_projections library-crs-projections1808240
Ref: b921808240
Node: API documentation<60>1808744
Ref: libraries/crs_projections api-documentation1808857
Ref: b931808857
Node: Loading<61>1808993
Ref: libraries/crs_projections loading1809126
Ref: b941809126
Node: Testing<56>1809278
Ref: libraries/crs_projections testing1809428
Ref: b951809428
Node: Supported coordinate reference systems1809575
Ref: libraries/crs_projections supported-coordinate-reference-systems1809723
Ref: b961809723
Node: Usage<25>1811395
Ref: libraries/crs_projections usage1811537
Ref: b971811537
Node: Notes1814650
Ref: libraries/crs_projections notes1814745
Ref: b981814745
Node: csv1815657
Ref: libraries/csv doc1815764
Ref: b991815764
Ref: libraries/csv csv1815764
Ref: b9a1815764
Ref: libraries/csv library-csv1815764
Ref: b9b1815764
Node: API documentation<61>1817315
Ref: libraries/csv api-documentation1817416
Ref: b9c1817416
Node: Loading<62>1817540
Ref: libraries/csv loading1817661
Ref: b9d1817661
Node: Testing<57>1817801
Ref: libraries/csv testing1817910
Ref: b9e1817910
Node: Usage<26>1818045
Ref: libraries/csv usage1818134
Ref: b9f1818134
Node: cuid21820868
Ref: libraries/cuid2 doc1820982
Ref: ba01820982
Ref: libraries/cuid2 cuid21820982
Ref: ba11820982
Ref: libraries/cuid2 library-cuid21820982
Ref: ba21820982
Node: API documentation<62>1821898
Ref: libraries/cuid2 api-documentation1822001
Ref: ba31822001
Node: Loading<63>1822127
Ref: libraries/cuid2 loading1822250
Ref: ba41822250
Node: Testing<58>1822392
Ref: libraries/cuid2 testing1822503
Ref: ba51822503
Node: Usage<27>1822640
Ref: libraries/cuid2 usage1822731
Ref: ba61822731
Node: cusum_anomaly_detector1823101
Ref: libraries/cusum_anomaly_detector doc1823219
Ref: ba71823219
Ref: libraries/cusum_anomaly_detector cusum-anomaly-detector1823219
Ref: ba81823219
Ref: libraries/cusum_anomaly_detector library-cusum-anomaly-detector1823219
Ref: ba91823219
Node: API documentation<63>1824357
Ref: libraries/cusum_anomaly_detector api-documentation1824477
Ref: baa1824477
Node: Loading<64>1824620
Ref: libraries/cusum_anomaly_detector loading1824760
Ref: bab1824760
Node: Testing<59>1824903
Ref: libraries/cusum_anomaly_detector testing1825034
Ref: bac1825034
Node: Features<12>1825188
Ref: libraries/cusum_anomaly_detector features1825319
Ref: bad1825319
Node: Options<11>1828811
Ref: libraries/cusum_anomaly_detector options1828954
Ref: bae1828954
Node: Detector representation1829886
Ref: libraries/cusum_anomaly_detector detector-representation1830025
Ref: baf1830025
Node: Notes<2>1831096
Ref: libraries/cusum_anomaly_detector notes1831215
Ref: bb01831215
Node: datalog1832836
Ref: libraries/datalog doc1832954
Ref: bb11832954
Ref: libraries/datalog datalog1832954
Ref: bb21832954
Ref: libraries/datalog library-datalog1832954
Ref: bb31832954
Node: API documentation<64>1833418
Ref: libraries/datalog api-documentation1833523
Ref: bb41833523
Node: Loading<65>1833651
Ref: libraries/datalog loading1833776
Ref: bb51833776
Node: Testing<60>1833920
Ref: libraries/datalog testing1834032
Ref: bb61834032
Node: Scope<3>1834169
Ref: libraries/datalog scope1834289
Ref: bb71834289
Node: Public API overview1835139
Ref: libraries/datalog public-api-overview1835259
Ref: bb81835259
Node: Basic usage1836531
Ref: libraries/datalog basic-usage1836657
Ref: bb91836657
Node: Limitations<3>1837036
Ref: libraries/datalog limitations1837134
Ref: bba1837134
Node: dates1837480
Ref: libraries/dates doc1837584
Ref: bbb1837584
Ref: libraries/dates dates1837584
Ref: bbc1837584
Ref: libraries/dates library-dates1837584
Ref: bbd1837584
Node: API documentation<65>1841151
Ref: libraries/dates api-documentation1841254
Ref: bbe1841254
Node: Loading<66>1841380
Ref: libraries/dates loading1841503
Ref: bbf1841503
Node: Testing<61>1841653
Ref: libraries/dates testing1841746
Ref: bc01841746
Node: dates_tz1841883
Ref: libraries/dates_tz doc1841996
Ref: bc11841996
Ref: libraries/dates_tz dates-tz1841996
Ref: bc21841996
Ref: libraries/dates_tz library-dates-tz1841996
Ref: bc31841996
Node: API documentation<66>1842798
Ref: libraries/dates_tz api-documentation1842904
Ref: bc41842904
Node: Loading<67>1843033
Ref: libraries/dates_tz loading1843159
Ref: bc51843159
Node: Testing<62>1843312
Ref: libraries/dates_tz testing1843426
Ref: bc61843426
Node: Usage<28>1843566
Ref: libraries/dates_tz usage1843682
Ref: bc71843682
Node: Examples<167>1844049
Ref: libraries/dates_tz examples1844162
Ref: bc81844162
Node: Notes<3>1846508
Ref: libraries/dates_tz notes1846603
Ref: bc91846603
Node: dbscan_clusterer1847260
Ref: libraries/dbscan_clusterer doc1847378
Ref: bca1847378
Ref: libraries/dbscan_clusterer dbscan-clusterer1847378
Ref: bcb1847378
Ref: libraries/dbscan_clusterer library-dbscan-clusterer1847378
Ref: bcc1847378
Node: API documentation<67>1848257
Ref: libraries/dbscan_clusterer api-documentation1848371
Ref: bcd1848371
Node: Loading<68>1848508
Ref: libraries/dbscan_clusterer loading1848642
Ref: bce1848642
Node: Testing<63>1848779
Ref: libraries/dbscan_clusterer testing1848904
Ref: bcf1848904
Node: Features<13>1849200
Ref: libraries/dbscan_clusterer features1849325
Ref: bd01849325
Node: Options<12>1850437
Ref: libraries/dbscan_clusterer options1850578
Ref: bd11850578
Node: Clusterer representation<2>1851487
Ref: libraries/dbscan_clusterer clusterer-representation1851629
Ref: bd21851629
Node: References<9>1852271
Ref: libraries/dbscan_clusterer references1852393
Ref: bd31852393
Node: dependents1852596
Ref: libraries/dependents doc1852712
Ref: 2891852712
Ref: libraries/dependents dependents1852712
Ref: bd41852712
Ref: libraries/dependents library-dependents1852712
Ref: bd51852712
Node: API documentation<68>1853042
Ref: libraries/dependents api-documentation1853150
Ref: bd61853150
Node: Loading<69>1853281
Ref: libraries/dependents loading1853389
Ref: bd71853389
Node: deques1853544
Ref: libraries/deques doc1853656
Ref: bd81853656
Ref: libraries/deques deques1853656
Ref: bd91853656
Ref: libraries/deques library-deques1853656
Ref: bda1853656
Node: API documentation<69>1853977
Ref: libraries/deques api-documentation1854081
Ref: bdb1854081
Node: Loading<70>1854208
Ref: libraries/deques loading1854332
Ref: bdc1854332
Node: Testing<64>1854475
Ref: libraries/deques testing1854587
Ref: bdd1854587
Node: Usage<29>1854725
Ref: libraries/deques usage1854817
Ref: bde1854817
Node: derangements1855838
Ref: libraries/derangements doc1855952
Ref: bdf1855952
Ref: libraries/derangements derangements1855952
Ref: be01855952
Ref: libraries/derangements library-derangements1855952
Ref: be11855952
Node: API documentation<70>1857408
Ref: libraries/derangements api-documentation1857518
Ref: be21857518
Node: Loading<71>1857651
Ref: libraries/derangements loading1857781
Ref: be31857781
Node: Testing<65>1857930
Ref: libraries/derangements testing1858030
Ref: be41858030
Node: dictionaries1858174
Ref: libraries/dictionaries doc1858285
Ref: be51858285
Ref: libraries/dictionaries dictionaries1858285
Ref: be61858285
Ref: libraries/dictionaries library-dictionaries1858285
Ref: be71858285
Node: API documentation<71>1858792
Ref: libraries/dictionaries api-documentation1858902
Ref: be81858902
Node: Loading<72>1859035
Ref: libraries/dictionaries loading1859165
Ref: be91859165
Node: Testing<66>1859314
Ref: libraries/dictionaries testing1859432
Ref: bea1859432
Node: Usage<30>1859576
Ref: libraries/dictionaries usage1859693
Ref: beb1859693
Node: Credits<2>1861760
Ref: libraries/dictionaries credits1861857
Ref: bec1861857
Node: dif1862328
Ref: libraries/dif doc1862456
Ref: bed1862456
Ref: libraries/dif dif1862456
Ref: bee1862456
Ref: libraries/dif library-dif1862456
Ref: bef1862456
Node: API documentation<72>1863087
Ref: libraries/dif api-documentation1863188
Ref: bf01863188
Node: Loading<73>1863312
Ref: libraries/dif loading1863433
Ref: bf11863433
Node: Testing<67>1863573
Ref: libraries/dif testing1863682
Ref: bf21863682
Node: Usage<31>1863817
Ref: libraries/dif usage1863906
Ref: bf31863906
Node: dimension_reduction_protocols1864187
Ref: libraries/dimension_reduction_protocols doc1864322
Ref: bf41864322
Ref: libraries/dimension_reduction_protocols dimension-reduction-protocols1864322
Ref: bf51864322
Ref: libraries/dimension_reduction_protocols library-dimension-reduction-protocols1864322
Ref: bf61864322
Node: API documentation<73>1866411
Ref: libraries/dimension_reduction_protocols api-documentation1866538
Ref: bf71866538
Node: Loading<74>1866688
Ref: libraries/dimension_reduction_protocols loading1866838
Ref: bf81866838
Node: Common options1867004
Ref: libraries/dimension_reduction_protocols common-options1867144
Ref: bf91867144
Node: Testing<68>1867984
Ref: libraries/dimension_reduction_protocols testing1868129
Ref: bfa1868129
Node: Test datasets<4>1868289
Ref: libraries/dimension_reduction_protocols test-datasets1868411
Ref: bfb1868411
Node: eclat_pattern_miner1870536
Ref: libraries/eclat_pattern_miner doc1870672
Ref: bfc1870672
Ref: libraries/eclat_pattern_miner eclat-pattern-miner1870672
Ref: bfd1870672
Ref: libraries/eclat_pattern_miner library-eclat-pattern-miner1870672
Ref: bfe1870672
Node: API documentation<74>1871726
Ref: libraries/eclat_pattern_miner api-documentation1871843
Ref: bff1871843
Node: Loading<75>1871983
Ref: libraries/eclat_pattern_miner loading1872120
Ref: c001872120
Node: Testing<69>1872260
Ref: libraries/eclat_pattern_miner testing1872388
Ref: c011872388
Node: Features<14>1872539
Ref: libraries/eclat_pattern_miner features1872667
Ref: c021872667
Node: Options<13>1873548
Ref: libraries/eclat_pattern_miner options1873696
Ref: c031873696
Node: Pattern miner representation<3>1874363
Ref: libraries/eclat_pattern_miner pattern-miner-representation1874513
Ref: c041874513
Node: References<10>1875086
Ref: libraries/eclat_pattern_miner references1875216
Ref: c051875216
Node: edcg1875330
Ref: libraries/edcg doc1875459
Ref: 31f1875459
Ref: libraries/edcg edcg1875459
Ref: c061875459
Ref: libraries/edcg library-edcg1875459
Ref: c071875459
Node: API documentation<75>1876973
Ref: libraries/edcg api-documentation1877075
Ref: c081877075
Node: Loading<76>1877200
Ref: libraries/edcg loading1877322
Ref: c091877322
Node: Testing<70>1877471
Ref: libraries/edcg testing1877581
Ref: c0a1877581
Node: Usage<32>1877745
Ref: libraries/edcg usage1877856
Ref: c0b1877856
Node: Introduction1878595
Ref: libraries/edcg introduction1878701
Ref: c0c1878701
Node: Syntax1879333
Ref: libraries/edcg syntax1879455
Ref: c0d1879455
Node: Declaration of Predicates1881350
Ref: libraries/edcg declaration-of-predicates1881487
Ref: c0e1881487
Node: Declaration of Accumulators1881817
Ref: libraries/edcg declaration-of-accumulators1881979
Ref: c0f1881979
Node: Declaration of Passed Arguments1883365
Ref: libraries/edcg declaration-of-passed-arguments1883526
Ref: c101883526
Node: Additional documentation1884185
Ref: libraries/edcg additional-documentation1884310
Ref: c111884310
Ref: Additional documentation-Footnote-11884692
Ref: Additional documentation-Footnote-21884747
Ref: Additional documentation-Footnote-31884815
Ref: Additional documentation-Footnote-41884888
Node: elastic_net_regression1884961
Ref: libraries/elastic_net_regression doc1885081
Ref: c121885081
Ref: libraries/elastic_net_regression elastic-net-regression1885081
Ref: c131885081
Ref: libraries/elastic_net_regression library-elastic-net-regression1885081
Ref: c141885081
Node: API documentation<76>1885796
Ref: libraries/elastic_net_regression api-documentation1885916
Ref: c151885916
Node: Loading<77>1886059
Ref: libraries/elastic_net_regression loading1886199
Ref: c161886199
Node: Testing<71>1886342
Ref: libraries/elastic_net_regression testing1886473
Ref: c171886473
Node: Features<15>1886922
Ref: libraries/elastic_net_regression features1887069
Ref: c181887069
Node: Regressor representation<2>1888796
Ref: libraries/elastic_net_regression regressor-representation1888953
Ref: c191888953
Node: Diagnostics syntax<6>1889258
Ref: libraries/elastic_net_regression diagnostics-syntax1889414
Ref: c1a1889414
Node: Options<14>1891288
Ref: libraries/elastic_net_regression options1891408
Ref: c1b1891408
Node: elo_ranker1892758
Ref: libraries/elo_ranker doc1892880
Ref: c1c1892880
Ref: libraries/elo_ranker elo-ranker1892880
Ref: c1d1892880
Ref: libraries/elo_ranker library-elo-ranker1892880
Ref: c1e1892880
Node: API documentation<77>1894022
Ref: libraries/elo_ranker api-documentation1894130
Ref: c1f1894130
Node: Loading<78>1894261
Ref: libraries/elo_ranker loading1894389
Ref: c201894389
Node: Testing<72>1894520
Ref: libraries/elo_ranker testing1894639
Ref: c211894639
Node: Features<16>1894781
Ref: libraries/elo_ranker features1894905
Ref: c221894905
Node: Rating semantics1896280
Ref: libraries/elo_ranker rating-semantics1896402
Ref: c231896402
Node: Usage<33>1897280
Ref: libraries/elo_ranker usage1897401
Ref: c241897401
Node: Learning a ranker<5>1897638
Ref: libraries/elo_ranker learning-a-ranker1897758
Ref: c251897758
Node: Inspecting diagnostics<5>1898086
Ref: libraries/elo_ranker inspecting-diagnostics1898241
Ref: c261898241
Node: Ranking candidate items<5>1898506
Ref: libraries/elo_ranker ranking-candidate-items1898664
Ref: c271898664
Node: Exporting the ranker<5>1899187
Ref: libraries/elo_ranker exporting-the-ranker1899311
Ref: c281899311
Node: Options<15>1899838
Ref: libraries/elo_ranker options1899967
Ref: c291899967
Node: Ranker representation<5>1900418
Ref: libraries/elo_ranker ranker-representation1900552
Ref: c2a1900552
Node: References<11>1900933
Ref: libraries/elo_ranker references1901047
Ref: c2b1901047
Node: events1901169
Ref: libraries/events doc1901290
Ref: c2c1901290
Ref: libraries/events events1901290
Ref: c2d1901290
Ref: libraries/events library-events1901290
Ref: c2e1901290
Node: API documentation<78>1901945
Ref: libraries/events api-documentation1902049
Ref: c2f1902049
Node: Loading<79>1902176
Ref: libraries/events loading1902280
Ref: c301902280
Node: ewma_anomaly_detector1902430
Ref: libraries/ewma_anomaly_detector doc1902567
Ref: c311902567
Ref: libraries/ewma_anomaly_detector ewma-anomaly-detector1902567
Ref: c321902567
Ref: libraries/ewma_anomaly_detector library-ewma-anomaly-detector1902567
Ref: c331902567
Node: API documentation<79>1903947
Ref: libraries/ewma_anomaly_detector api-documentation1904066
Ref: c341904066
Node: Loading<80>1904208
Ref: libraries/ewma_anomaly_detector loading1904347
Ref: c351904347
Node: Testing<73>1904489
Ref: libraries/ewma_anomaly_detector testing1904619
Ref: c361904619
Node: Features<17>1904772
Ref: libraries/ewma_anomaly_detector features1904902
Ref: c371904902
Node: Options<16>1908492
Ref: libraries/ewma_anomaly_detector options1908637
Ref: c381908637
Node: Detector representation<2>1909448
Ref: libraries/ewma_anomaly_detector detector-representation1909589
Ref: c391909589
Node: Notes<4>1910658
Ref: libraries/ewma_anomaly_detector notes1910779
Ref: c3a1910779
Node: expand_library_alias_paths1912801
Ref: libraries/expand_library_alias_paths doc1912941
Ref: c3b1912941
Ref: libraries/expand_library_alias_paths expand-library-alias-paths1912941
Ref: c3c1912941
Ref: libraries/expand_library_alias_paths library-expand-library-alias-paths1912941
Ref: c3d1912941
Node: API documentation<80>1913350
Ref: libraries/expand_library_alias_paths api-documentation1913474
Ref: c3e1913474
Node: Loading<81>1913621
Ref: libraries/expand_library_alias_paths loading1913763
Ref: c3f1913763
Node: Usage<34>1913934
Ref: libraries/expand_library_alias_paths usage1914046
Ref: c401914046
Node: expecteds1914401
Ref: libraries/expecteds doc1914526
Ref: 24f1914526
Ref: libraries/expecteds expecteds1914526
Ref: c411914526
Ref: libraries/expecteds library-expecteds1914526
Ref: c421914526
Node: API documentation<81>1915367
Ref: libraries/expecteds api-documentation1915474
Ref: c431915474
Node: Loading<82>1915604
Ref: libraries/expecteds loading1915731
Ref: c441915731
Node: Testing<74>1915877
Ref: libraries/expecteds testing1915992
Ref: c451915992
Node: Usage<35>1916133
Ref: libraries/expecteds usage1916245
Ref: c461916245
Node: See also1922106
Ref: libraries/expecteds see-also1922198
Ref: c471922198
Node: format1922285
Ref: libraries/format doc1922407
Ref: c481922407
Ref: libraries/format format1922407
Ref: c491922407
Ref: libraries/format library-format1922407
Ref: c4a1922407
Node: API documentation<82>1923533
Ref: libraries/format api-documentation1923637
Ref: c4b1923637
Node: Loading<83>1923764
Ref: libraries/format loading1923888
Ref: c4c1923888
Node: Testing<75>1924031
Ref: libraries/format testing1924143
Ref: c4d1924143
Node: Usage<36>1924567
Ref: libraries/format usage1924682
Ref: c4e1924682
Node: Portability<2>1924975
Ref: libraries/format portability1925070
Ref: c4f1925070
Node: fp_growth_pattern_miner1926040
Ref: libraries/fp_growth_pattern_miner doc1926186
Ref: c501926186
Ref: libraries/fp_growth_pattern_miner fp-growth-pattern-miner1926186
Ref: c511926186
Ref: libraries/fp_growth_pattern_miner library-fp-growth-pattern-miner1926186
Ref: c521926186
Node: API documentation<83>1927183
Ref: libraries/fp_growth_pattern_miner api-documentation1927304
Ref: c531927304
Node: Loading<84>1927448
Ref: libraries/fp_growth_pattern_miner loading1927589
Ref: c541927589
Node: Testing<76>1927733
Ref: libraries/fp_growth_pattern_miner testing1927865
Ref: c551927865
Node: Features<18>1928020
Ref: libraries/fp_growth_pattern_miner features1928152
Ref: c561928152
Node: Options<17>1929032
Ref: libraries/fp_growth_pattern_miner options1929184
Ref: c571929184
Node: Pattern miner representation<4>1929851
Ref: libraries/fp_growth_pattern_miner pattern-miner-representation1930005
Ref: c581930005
Node: References<12>1930582
Ref: libraries/fp_growth_pattern_miner references1930716
Ref: c591930716
Node: frequent_pattern_mining_protocols1930864
Ref: libraries/frequent_pattern_mining_protocols doc1931030
Ref: c5a1931030
Ref: libraries/frequent_pattern_mining_protocols frequent-pattern-mining-protocols1931030
Ref: c5b1931030
Ref: libraries/frequent_pattern_mining_protocols library-frequent-pattern-mining-protocols1931030
Ref: c5c1931030
Node: API documentation<84>1931926
Ref: libraries/frequent_pattern_mining_protocols api-documentation1932057
Ref: c5d1932057
Node: Loading<85>1932211
Ref: libraries/frequent_pattern_mining_protocols loading1932362
Ref: c5e1932362
Node: Testing<77>1932532
Ref: libraries/frequent_pattern_mining_protocols testing1932678
Ref: c5f1932678
Node: Test datasets<5>1932842
Ref: libraries/frequent_pattern_mining_protocols test-datasets1932968
Ref: c601932968
Node: gaussian_mixture_clusterer1934243
Ref: libraries/gaussian_mixture_clusterer doc1934413
Ref: c611934413
Ref: libraries/gaussian_mixture_clusterer gaussian-mixture-clusterer1934413
Ref: c621934413
Ref: libraries/gaussian_mixture_clusterer library-gaussian-mixture-clusterer1934413
Ref: c631934413
Node: API documentation<85>1935405
Ref: libraries/gaussian_mixture_clusterer api-documentation1935529
Ref: c641935529
Node: Loading<86>1935676
Ref: libraries/gaussian_mixture_clusterer loading1935820
Ref: c651935820
Node: Testing<78>1935967
Ref: libraries/gaussian_mixture_clusterer testing1936102
Ref: c661936102
Node: Features<19>1936418
Ref: libraries/gaussian_mixture_clusterer features1936582
Ref: c671936582
Node: Gaussian-Mixture-Specific Prediction API1937868
Ref: libraries/gaussian_mixture_clusterer gaussian-mixture-specific-prediction-api1938032
Ref: c681938032
Node: Options<18>1938482
Ref: libraries/gaussian_mixture_clusterer options1938661
Ref: c691938661
Node: Clusterer representation<3>1939851
Ref: libraries/gaussian_mixture_clusterer clusterer-representation1939981
Ref: c6a1939981
Node: gaussian_process_regression1940787
Ref: libraries/gaussian_process_regression doc1940930
Ref: c6b1940930
Ref: libraries/gaussian_process_regression gaussian-process-regression1940930
Ref: c6c1940930
Ref: libraries/gaussian_process_regression library-gaussian-process-regression1940930
Ref: c6d1940930
Node: API documentation<86>1942185
Ref: libraries/gaussian_process_regression api-documentation1942310
Ref: c6e1942310
Node: Loading<87>1942458
Ref: libraries/gaussian_process_regression loading1942603
Ref: c6f1942603
Node: Testing<79>1942751
Ref: libraries/gaussian_process_regression testing1942887
Ref: c701942887
Node: Features<20>1943205
Ref: libraries/gaussian_process_regression features1943357
Ref: c711943357
Node: Regressor representation<3>1945641
Ref: libraries/gaussian_process_regression regressor-representation1945796
Ref: c721945796
Node: Prediction API1946799
Ref: libraries/gaussian_process_regression prediction-api1946963
Ref: c731946963
Node: Diagnostics syntax<7>1947451
Ref: libraries/gaussian_process_regression diagnostics-syntax1947599
Ref: c741947599
Node: Options<19>1950905
Ref: libraries/gaussian_process_regression options1951030
Ref: c751951030
Node: genint1954529
Ref: libraries/genint doc1954652
Ref: c761954652
Ref: libraries/genint genint1954652
Ref: c771954652
Ref: libraries/genint library-genint1954652
Ref: c781954652
Node: API documentation<87>1955052
Ref: libraries/genint api-documentation1955156
Ref: c791955156
Node: Loading<88>1955283
Ref: libraries/genint loading1955407
Ref: c7a1955407
Node: Testing<80>1955550
Ref: libraries/genint testing1955662
Ref: c7b1955662
Node: Usage<37>1955800
Ref: libraries/genint usage1955892
Ref: c7c1955892
Node: gensym1956327
Ref: libraries/gensym doc1956430
Ref: c7d1956430
Ref: libraries/gensym gensym1956430
Ref: c7e1956430
Ref: libraries/gensym library-gensym1956430
Ref: c7f1956430
Node: API documentation<88>1956804
Ref: libraries/gensym api-documentation1956908
Ref: c801956908
Node: Loading<89>1957035
Ref: libraries/gensym loading1957159
Ref: c811957159
Node: Testing<81>1957302
Ref: libraries/gensym testing1957414
Ref: c821957414
Node: Usage<38>1957552
Ref: libraries/gensym usage1957644
Ref: c831957644
Node: geojson1958239
Ref: libraries/geojson doc1958346
Ref: c841958346
Ref: libraries/geojson geojson1958346
Ref: c851958346
Ref: libraries/geojson library-geojson1958346
Ref: c861958346
Node: API documentation<89>1958962
Ref: libraries/geojson api-documentation1959067
Ref: c871959067
Node: Loading<90>1959195
Ref: libraries/geojson loading1959320
Ref: c881959320
Node: Testing<82>1959464
Ref: libraries/geojson testing1959586
Ref: c891959586
Node: Representation<10>1959725
Ref: libraries/geojson representation1959849
Ref: c8a1959849
Node: Examples<168>1961402
Ref: libraries/geojson examples1961523
Ref: c8b1961523
Node: Notes<5>1962593
Ref: libraries/geojson notes1962687
Ref: c8c1962687
Node: geospatial1964454
Ref: libraries/geospatial doc1964558
Ref: c8d1964558
Ref: libraries/geospatial geospatial1964558
Ref: c8e1964558
Ref: libraries/geospatial library-geospatial1964558
Ref: c8f1964558
Node: API documentation<90>1965011
Ref: libraries/geospatial api-documentation1965119
Ref: c901965119
Node: Loading<91>1965250
Ref: libraries/geospatial loading1965378
Ref: c911965378
Node: Testing<83>1965525
Ref: libraries/geospatial testing1965652
Ref: c921965652
Node: Available predicates1965794
Ref: libraries/geospatial available-predicates1965918
Ref: c931965918
Node: Notes<6>1967651
Ref: libraries/geospatial notes1967773
Ref: c941967773
Node: Usage<39>1968015
Ref: libraries/geospatial usage1968108
Ref: c951968108
Node: git1976171
Ref: libraries/git doc1976282
Ref: c961976282
Ref: libraries/git git1976282
Ref: c971976282
Ref: libraries/git library-git1976282
Ref: c981976282
Node: API documentation<91>1976676
Ref: libraries/git api-documentation1976777
Ref: c991976777
Node: Loading<92>1976901
Ref: libraries/git loading1977022
Ref: c9a1977022
Node: Testing<84>1977162
Ref: libraries/git testing1977271
Ref: c9b1977271
Node: Usage<40>1977406
Ref: libraries/git usage1977495
Ref: c9c1977495
Node: glicko2_ranker1978855
Ref: libraries/glicko2_ranker doc1978979
Ref: c9d1978979
Ref: libraries/glicko2_ranker glicko2-ranker1978979
Ref: c9e1978979
Ref: libraries/glicko2_ranker library-glicko2-ranker1978979
Ref: c9f1978979
Node: API documentation<92>1980215
Ref: libraries/glicko2_ranker api-documentation1980327
Ref: ca01980327
Node: Loading<93>1980462
Ref: libraries/glicko2_ranker loading1980594
Ref: ca11980594
Node: Testing<85>1980729
Ref: libraries/glicko2_ranker testing1980852
Ref: ca21980852
Node: Features<21>1980998
Ref: libraries/glicko2_ranker features1981129
Ref: ca31981129
Node: Rating semantics<2>1982514
Ref: libraries/glicko2_ranker rating-semantics1982643
Ref: ca41982643
Node: Usage<41>1983501
Ref: libraries/glicko2_ranker usage1983629
Ref: ca51983629
Node: Learning a ranker<6>1983866
Ref: libraries/glicko2_ranker learning-a-ranker1983986
Ref: ca61983986
Node: Inspecting diagnostics<6>1984352
Ref: libraries/glicko2_ranker inspecting-diagnostics1984507
Ref: ca71984507
Node: Ranking candidate items<6>1984798
Ref: libraries/glicko2_ranker ranking-candidate-items1984956
Ref: ca81984956
Node: Exporting the ranker<6>1985487
Ref: libraries/glicko2_ranker exporting-the-ranker1985611
Ref: ca91985611
Node: Options<20>1986158
Ref: libraries/glicko2_ranker options1986288
Ref: caa1986288
Node: Diagnostics syntax<8>1986987
Ref: libraries/glicko2_ranker diagnostics-syntax1987132
Ref: cab1987132
Node: Ranker representation<6>1987460
Ref: libraries/glicko2_ranker ranker-representation1987608
Ref: cac1987608
Node: References<13>1988051
Ref: libraries/glicko2_ranker references1988169
Ref: cad1988169
Node: glicko2_periodic_ranker1988273
Ref: libraries/glicko2_periodic_ranker doc1988422
Ref: cae1988422
Ref: libraries/glicko2_periodic_ranker glicko2-periodic-ranker1988422
Ref: caf1988422
Ref: libraries/glicko2_periodic_ranker library-glicko2-periodic-ranker1988422
Ref: cb01988422
Node: API documentation<93>1990212
Ref: libraries/glicko2_periodic_ranker api-documentation1990333
Ref: cb11990333
Node: Loading<94>1990477
Ref: libraries/glicko2_periodic_ranker loading1990618
Ref: cb21990618
Node: Testing<86>1990762
Ref: libraries/glicko2_periodic_ranker testing1990894
Ref: cb31990894
Node: Features<22>1991049
Ref: libraries/glicko2_periodic_ranker features1991189
Ref: cb41991189
Node: Rating semantics<3>1992983
Ref: libraries/glicko2_periodic_ranker rating-semantics1993121
Ref: cb51993121
Node: Usage<42>1994046
Ref: libraries/glicko2_periodic_ranker usage1994183
Ref: cb61994183
Node: Learning a ranker<7>1994420
Ref: libraries/glicko2_periodic_ranker learning-a-ranker1994540
Ref: cb71994540
Node: Inspecting diagnostics<7>1994933
Ref: libraries/glicko2_periodic_ranker inspecting-diagnostics1995088
Ref: cb81995088
Node: Ranking candidate items<7>1995396
Ref: libraries/glicko2_periodic_ranker ranking-candidate-items1995554
Ref: cb91995554
Node: Exporting the ranker<7>1996103
Ref: libraries/glicko2_periodic_ranker exporting-the-ranker1996227
Ref: cba1996227
Node: Options<21>1996819
Ref: libraries/glicko2_periodic_ranker options1996958
Ref: cbb1996958
Node: Diagnostics syntax<9>1997725
Ref: libraries/glicko2_periodic_ranker diagnostics-syntax1997879
Ref: cbc1997879
Node: Ranker representation<7>1998298
Ref: libraries/glicko2_periodic_ranker ranker-representation1998455
Ref: cbd1998455
Node: References<14>1998945
Ref: libraries/glicko2_periodic_ranker references1999072
Ref: cbe1999072
Node: gradient_boosting_classifier1999176
Ref: libraries/gradient_boosting_classifier doc1999339
Ref: cbf1999339
Ref: libraries/gradient_boosting_classifier gradient-boosting-classifier1999339
Ref: cc01999339
Ref: libraries/gradient_boosting_classifier library-gradient-boosting-classifier1999339
Ref: cc11999339
Node: API documentation<94>2000510
Ref: libraries/gradient_boosting_classifier api-documentation2000636
Ref: cc22000636
Node: Loading<95>2000785
Ref: libraries/gradient_boosting_classifier loading2000931
Ref: cc32000931
Node: Testing<87>2001080
Ref: libraries/gradient_boosting_classifier testing2001217
Ref: cc42001217
Node: Features<23>2001377
Ref: libraries/gradient_boosting_classifier features2001514
Ref: cc52001514
Node: Options<22>2002251
Ref: libraries/gradient_boosting_classifier options2002386
Ref: cc62002386
Node: Usage<43>2003106
Ref: libraries/gradient_boosting_classifier usage2003257
Ref: cc72003257
Node: Learning a classifier2003372
Ref: libraries/gradient_boosting_classifier learning-a-classifier2003486
Ref: cc82003486
Node: Making predictions2003739
Ref: libraries/gradient_boosting_classifier making-predictions2003886
Ref: cc92003886
Node: Exporting the classifier2004360
Ref: libraries/gradient_boosting_classifier exporting-the-classifier2004477
Ref: cca2004477
Node: Classifier representation<2>2004887
Ref: libraries/gradient_boosting_classifier classifier-representation2005041
Ref: ccb2005041
Node: References<15>2005866
Ref: libraries/gradient_boosting_classifier references2006002
Ref: ccc2006002
Node: gradient_boosting_regression2006356
Ref: libraries/gradient_boosting_regression doc2006504
Ref: ccd2006504
Ref: libraries/gradient_boosting_regression gradient-boosting-regression2006504
Ref: cce2006504
Ref: libraries/gradient_boosting_regression library-gradient-boosting-regression2006504
Ref: ccf2006504
Node: API documentation<95>2007380
Ref: libraries/gradient_boosting_regression api-documentation2007506
Ref: cd02007506
Node: Loading<96>2007655
Ref: libraries/gradient_boosting_regression loading2007801
Ref: cd12007801
Node: Testing<88>2007950
Ref: libraries/gradient_boosting_regression testing2008087
Ref: cd22008087
Node: Features<24>2008407
Ref: libraries/gradient_boosting_regression features2008560
Ref: cd32008560
Node: Regressor representation<4>2009627
Ref: libraries/gradient_boosting_regression regressor-representation2009791
Ref: cd42009791
Node: Diagnostics syntax<10>2010305
Ref: libraries/gradient_boosting_regression diagnostics-syntax2010468
Ref: cd52010468
Node: Options<23>2011751
Ref: libraries/gradient_boosting_regression options2011878
Ref: cd62011878
Node: grammars2013437
Ref: libraries/grammars doc2013563
Ref: cd72013563
Ref: libraries/grammars grammars2013563
Ref: cd82013563
Ref: libraries/grammars library-grammars2013563
Ref: cd92013563
Node: API documentation<96>2014194
Ref: libraries/grammars api-documentation2014300
Ref: cda2014300
Node: Loading<97>2014429
Ref: libraries/grammars loading2014555
Ref: cdb2014555
Node: Testing<89>2014700
Ref: libraries/grammars testing2014814
Ref: cdc2014814
Node: Usage<44>2014980
Ref: libraries/grammars usage2015074
Ref: cdd2015074
Node: graphs2015412
Ref: libraries/graphs doc2015527
Ref: cde2015527
Ref: libraries/graphs graphs2015527
Ref: cdf2015527
Ref: libraries/graphs library-graphs2015527
Ref: ce02015527
Node: API documentation<97>2016817
Ref: libraries/graphs api-documentation2016921
Ref: ce12016921
Node: Loading<98>2017048
Ref: libraries/graphs loading2017172
Ref: ce22017172
Node: Testing<90>2017315
Ref: libraries/graphs testing2017427
Ref: ce32017427
Node: Usage<45>2017689
Ref: libraries/graphs usage2017781
Ref: ce42017781
Node: Graph types2017896
Ref: libraries/graphs graph-types2017997
Ref: ce52017997
Node: Creating graphs2018357
Ref: libraries/graphs creating-graphs2018482
Ref: ce62018482
Node: Querying graphs2018995
Ref: libraries/graphs querying-graphs2019126
Ref: ce72019126
Node: Undirected graphs2019466
Ref: libraries/graphs undirected-graphs2019573
Ref: ce82019573
Node: gsp_pattern_miner2019846
Ref: libraries/gsp_pattern_miner doc2019959
Ref: ce92019959
Ref: libraries/gsp_pattern_miner gsp-pattern-miner2019959
Ref: cea2019959
Ref: libraries/gsp_pattern_miner library-gsp-pattern-miner2019959
Ref: ceb2019959
Node: API documentation<98>2020909
Ref: libraries/gsp_pattern_miner api-documentation2021024
Ref: cec2021024
Node: Loading<99>2021162
Ref: libraries/gsp_pattern_miner loading2021297
Ref: ced2021297
Node: Testing<91>2021435
Ref: libraries/gsp_pattern_miner testing2021561
Ref: cee2021561
Node: Features<25>2021710
Ref: libraries/gsp_pattern_miner features2021836
Ref: cef2021836
Node: Options<24>2022729
Ref: libraries/gsp_pattern_miner options2022875
Ref: cf02022875
Node: Pattern miner representation<5>2023566
Ref: libraries/gsp_pattern_miner pattern-miner-representation2023714
Ref: cf12023714
Node: References<16>2024309
Ref: libraries/gsp_pattern_miner references2024437
Ref: cf22024437
Node: hashes2024602
Ref: libraries/hashes doc2024726
Ref: cf32024726
Ref: libraries/hashes hashes2024726
Ref: cf42024726
Ref: libraries/hashes library-hashes2024726
Ref: cf52024726
Node: API documentation<99>2030023
Ref: libraries/hashes api-documentation2030128
Ref: cf62030128
Node: Loading<100>2030255
Ref: libraries/hashes loading2030380
Ref: cf72030380
Node: Testing<92>2030523
Ref: libraries/hashes testing2030640
Ref: cf82030640
Node: Examples<169>2030778
Ref: libraries/hashes examples2030874
Ref: cf92030874
Node: hdbscan_clusterer2033340
Ref: libraries/hdbscan_clusterer doc2033452
Ref: cfa2033452
Ref: libraries/hdbscan_clusterer hdbscan-clusterer2033452
Ref: cfb2033452
Ref: libraries/hdbscan_clusterer library-hdbscan-clusterer2033452
Ref: cfc2033452
Node: API documentation<100>2034456
Ref: libraries/hdbscan_clusterer api-documentation2034573
Ref: cfd2034573
Node: Loading<101>2034711
Ref: libraries/hdbscan_clusterer loading2034848
Ref: cfe2034848
Node: Testing<93>2034986
Ref: libraries/hdbscan_clusterer testing2035113
Ref: cff2035113
Node: Features<26>2035411
Ref: libraries/hdbscan_clusterer features2035537
Ref: d002035537
Node: Options<25>2036661
Ref: libraries/hdbscan_clusterer options2036803
Ref: d012036803
Node: Clusterer representation<4>2037609
Ref: libraries/hdbscan_clusterer clusterer-representation2037730
Ref: d022037730
Node: heaps2038393
Ref: libraries/heaps doc2038522
Ref: d032038522
Ref: libraries/heaps heaps2038522
Ref: d042038522
Ref: libraries/heaps library-heaps2038522
Ref: d052038522
Node: API documentation<101>2039318
Ref: libraries/heaps api-documentation2039423
Ref: d062039423
Node: Loading<102>2039549
Ref: libraries/heaps loading2039674
Ref: d072039674
Node: Testing<94>2039816
Ref: libraries/heaps testing2039928
Ref: d082039928
Node: Usage<46>2040065
Ref: libraries/heaps usage2040175
Ref: d092040175
Node: Credits<3>2041105
Ref: libraries/heaps credits2041195
Ref: d0a2041195
Node: hierarchical_clustering2041335
Ref: libraries/hierarchical_clustering doc2041458
Ref: d0b2041458
Ref: libraries/hierarchical_clustering hierarchical-clustering2041458
Ref: d0c2041458
Ref: libraries/hierarchical_clustering library-hierarchical-clustering2041458
Ref: d0d2041458
Node: API documentation<102>2042493
Ref: libraries/hierarchical_clustering api-documentation2042616
Ref: d0e2042616
Node: Loading<103>2042760
Ref: libraries/hierarchical_clustering loading2042903
Ref: d0f2042903
Node: Testing<95>2043047
Ref: libraries/hierarchical_clustering testing2043180
Ref: d102043180
Node: Features<27>2043490
Ref: libraries/hierarchical_clustering features2043622
Ref: d112043622
Node: Options<26>2045515
Ref: libraries/hierarchical_clustering options2045663
Ref: d122045663
Node: Clusterer representation<5>2046285
Ref: libraries/hierarchical_clustering clusterer-representation2046435
Ref: d132046435
Node: Additional API2047526
Ref: libraries/hierarchical_clustering additional-api2047679
Ref: d142047679
Node: Diagnostics<3>2047864
Ref: libraries/hierarchical_clustering diagnostics2047981
Ref: d152047981
Node: hierarchies2048493
Ref: libraries/hierarchies doc2048615
Ref: d162048615
Ref: libraries/hierarchies hierarchies2048615
Ref: d172048615
Ref: libraries/hierarchies library-hierarchies2048615
Ref: d182048615
Node: API documentation<103>2048960
Ref: libraries/hierarchies api-documentation2049071
Ref: d192049071
Node: Loading<104>2049203
Ref: libraries/hierarchies loading2049334
Ref: d1a2049334
Node: Testing<96>2049482
Ref: libraries/hierarchies testing2049582
Ref: d1b2049582
Node: hmac2049725
Ref: libraries/hmac doc2049834
Ref: d1c2049834
Ref: libraries/hmac hmac2049834
Ref: d1d2049834
Ref: libraries/hmac library-hmac2049834
Ref: d1e2049834
Node: API documentation<104>2051071
Ref: libraries/hmac api-documentation2051175
Ref: d1f2051175
Node: Loading<105>2051300
Ref: libraries/hmac loading2051424
Ref: d202051424
Node: Testing<97>2051565
Ref: libraries/hmac testing2051680
Ref: d212051680
Node: Examples<170>2051816
Ref: libraries/hmac examples2051910
Ref: d222051910
Node: hodge_rank2052848
Ref: libraries/hodge_rank doc2052956
Ref: d232052956
Ref: libraries/hodge_rank hodge-rank2052956
Ref: d242052956
Ref: libraries/hodge_rank library-hodge-rank2052956
Ref: d252052956
Node: API documentation<105>2054347
Ref: libraries/hodge_rank api-documentation2054457
Ref: d262054457
Node: Loading<106>2054588
Ref: libraries/hodge_rank loading2054718
Ref: d272054718
Node: Testing<98>2054849
Ref: libraries/hodge_rank testing2054969
Ref: d282054969
Node: Features<28>2055111
Ref: libraries/hodge_rank features2055239
Ref: d292055239
Node: Scoring semantics<4>2056270
Ref: libraries/hodge_rank scoring-semantics2056405
Ref: d2a2056405
Node: Residual semantics2057370
Ref: libraries/hodge_rank residual-semantics2057502
Ref: d2b2057502
Node: Usage<47>2057762
Ref: libraries/hodge_rank usage2057896
Ref: d2c2057896
Node: Learning a ranker<8>2058001
Ref: libraries/hodge_rank learning-a-ranker2058116
Ref: d2d2058116
Node: Inspecting residuals2058512
Ref: libraries/hodge_rank inspecting-residuals2058627
Ref: d2e2058627
Node: Diagnostics syntax<11>2058882
Ref: libraries/hodge_rank diagnostics-syntax2059022
Ref: d2f2059022
Node: Ranker representation<8>2059338
Ref: libraries/hodge_rank ranker-representation2059483
Ref: d302059483
Node: References<17>2059896
Ref: libraries/hodge_rank references2060010
Ref: d312060010
Node: hook_flows2060164
Ref: libraries/hook_flows doc2060280
Ref: 31a2060280
Ref: libraries/hook_flows hook-flows2060280
Ref: d322060280
Ref: libraries/hook_flows library-hook-flows2060280
Ref: d332060280
Node: API documentation<106>2061175
Ref: libraries/hook_flows api-documentation2061285
Ref: d342061285
Node: Loading<107>2061416
Ref: libraries/hook_flows loading2061546
Ref: d352061546
Node: Testing<99>2061693
Ref: libraries/hook_flows testing2061810
Ref: d362061810
Node: Usage<48>2061952
Ref: libraries/hook_flows usage2062048
Ref: d372062048
Node: hook_objects2063829
Ref: libraries/hook_objects doc2063939
Ref: 31b2063939
Ref: libraries/hook_objects hook-objects2063939
Ref: d382063939
Ref: libraries/hook_objects library-hook-objects2063939
Ref: d392063939
Node: API documentation<107>2064448
Ref: libraries/hook_objects api-documentation2064560
Ref: d3a2064560
Node: Loading<108>2064693
Ref: libraries/hook_objects loading2064826
Ref: d3b2064826
Node: Testing<100>2065118
Ref: libraries/hook_objects testing2065238
Ref: d3c2065238
Node: Usage<49>2065384
Ref: libraries/hook_objects usage2065483
Ref: d3d2065483
Node: Using the Prolog backend adapter file expansion rules2066164
Ref: libraries/hook_objects using-the-prolog-backend-adapter-file-expansion-rules2066341
Ref: d3e2066341
Node: Restoring the default compiler expansion workflow2066689
Ref: libraries/hook_objects restoring-the-default-compiler-expansion-workflow2066933
Ref: d3f2066933
Node: Preventing applying any other user-defined expansion rules2067290
Ref: libraries/hook_objects preventing-applying-any-other-user-defined-expansion-rules2067547
Ref: d402067547
Node: Expanding grammar rules into clauses independently of the compiler2068446
Ref: libraries/hook_objects expanding-grammar-rules-into-clauses-independently-of-the-compiler2068706
Ref: d412068706
Node: Using the expansion rules defined in a Prolog module2069104
Ref: libraries/hook_objects using-the-expansion-rules-defined-in-a-prolog-module2069359
Ref: d422069359
Node: Wrap the contents of a plain Prolog file as an object2069763
Ref: libraries/hook_objects wrap-the-contents-of-a-plain-prolog-file-as-an-object2070007
Ref: d432070007
Node: Outputting term-expansion results to a stream or a file2071492
Ref: libraries/hook_objects outputting-term-expansion-results-to-a-stream-or-a-file2071744
Ref: d442071744
Node: Printing entity predicate goals before or after calling them2072870
Ref: libraries/hook_objects printing-entity-predicate-goals-before-or-after-calling-them2073086
Ref: d452073086
Node: Suppressing goals2073697
Ref: libraries/hook_objects suppressing-goals2073849
Ref: d462073849
Node: html2074538
Ref: libraries/html doc2074652
Ref: d472074652
Ref: libraries/html html2074652
Ref: d482074652
Ref: libraries/html library-html2074652
Ref: d492074652
Node: API documentation<108>2076272
Ref: libraries/html api-documentation2076376
Ref: d4a2076376
Node: Loading<109>2076501
Ref: libraries/html loading2076626
Ref: d4b2076626
Node: Testing<101>2076767
Ref: libraries/html testing2076896
Ref: d4c2076896
Node: Generating a HTML document2077032
Ref: libraries/html generating-a-html-document2077175
Ref: d4d2077175
Node: Generating a HTML fragment2077910
Ref: libraries/html generating-a-html-fragment2078083
Ref: d4e2078083
Node: Working with callbacks to generate content2078553
Ref: libraries/html working-with-callbacks-to-generate-content2078728
Ref: d4f2078728
Node: Working with custom elements2079704
Ref: libraries/html working-with-custom-elements2079844
Ref: d502079844
Node: ica_projection2080456
Ref: libraries/ica_projection doc2080561
Ref: d512080561
Ref: libraries/ica_projection ica-projection2080561
Ref: d522080561
Ref: libraries/ica_projection library-ica-projection2080561
Ref: d532080561
Node: API documentation<109>2081450
Ref: libraries/ica_projection api-documentation2081564
Ref: d542081564
Node: Loading<110>2081699
Ref: libraries/ica_projection loading2081834
Ref: d552081834
Node: Testing<102>2081969
Ref: libraries/ica_projection testing2082094
Ref: d562082094
Node: Features<29>2082240
Ref: libraries/ica_projection features2082364
Ref: d572082364
Node: Options<27>2083376
Ref: libraries/ica_projection options2083497
Ref: d582083497
Node: Usage<50>2085125
Ref: libraries/ica_projection usage2085266
Ref: d592085266
Node: Learning a reducer2085603
Ref: libraries/ica_projection learning-a-reducer2085722
Ref: d5a2085722
Node: Transforming new instances2086023
Ref: libraries/ica_projection transforming-new-instances2086184
Ref: d5b2086184
Node: Exporting and reusing the reducer2086443
Ref: libraries/ica_projection exporting-and-reusing-the-reducer2086577
Ref: d5c2086577
Node: Dimension reducer representation2087045
Ref: libraries/ica_projection dimension-reducer-representation2087189
Ref: d5d2087189
Node: References<18>2087837
Ref: libraries/ica_projection references2087963
Ref: d5e2087963
Node: ids2088113
Ref: libraries/ids doc2088222
Ref: d5f2088222
Ref: libraries/ids ids2088222
Ref: d602088222
Ref: libraries/ids library-ids2088222
Ref: d612088222
Node: API documentation<110>2089007
Ref: libraries/ids api-documentation2089110
Ref: d622089110
Node: Loading<111>2089234
Ref: libraries/ids loading2089358
Ref: d632089358
Node: Testing<103>2089498
Ref: libraries/ids testing2089609
Ref: d642089609
Node: Usage<51>2089744
Ref: libraries/ids usage2089834
Ref: d652089834
Node: ieee_7542090672
Ref: libraries/ieee_754 doc2090776
Ref: d662090776
Ref: libraries/ieee_754 ieee-7542090776
Ref: d672090776
Ref: libraries/ieee_754 library-ieee-7542090776
Ref: d682090776
Node: Loading<112>2091194
Ref: libraries/ieee_754 loading2091292
Ref: d692091292
Node: Testing<104>2091437
Ref: libraries/ieee_754 testing2091556
Ref: d6a2091556
Node: Object model2091696
Ref: libraries/ieee_754 object-model2091823
Ref: d6b2091823
Node: Value representation2092518
Ref: libraries/ieee_754 value-representation2092646
Ref: d6c2092646
Node: Public API<2>2093846
Ref: libraries/ieee_754 public-api2093971
Ref: d6d2093971
Node: Semantics2095781
Ref: libraries/ieee_754 semantics2095877
Ref: d6e2095877
Node: intervals2096699
Ref: libraries/intervals doc2096820
Ref: d6f2096820
Ref: libraries/intervals intervals2096820
Ref: d702096820
Ref: libraries/intervals library-intervals2096820
Ref: d712096820
Node: Practical limits2098701
Ref: libraries/intervals practical-limits2098814
Ref: d722098814
Node: API documentation<111>2100009
Ref: libraries/intervals api-documentation2100143
Ref: d732100143
Node: Loading<113>2100273
Ref: libraries/intervals loading2100403
Ref: d742100403
Node: Testing<105>2100549
Ref: libraries/intervals testing2100670
Ref: d752100670
Node: Examples<171>2100811
Ref: libraries/intervals examples2100911
Ref: d762100911
Node: iqr_anomaly_detector2104187
Ref: libraries/iqr_anomaly_detector doc2104307
Ref: d772104307
Ref: libraries/iqr_anomaly_detector iqr-anomaly-detector2104307
Ref: d782104307
Ref: libraries/iqr_anomaly_detector library-iqr-anomaly-detector2104307
Ref: d792104307
Node: API documentation<112>2105709
Ref: libraries/iqr_anomaly_detector api-documentation2105829
Ref: d7a2105829
Node: Loading<114>2105970
Ref: libraries/iqr_anomaly_detector loading2106111
Ref: d7b2106111
Node: Testing<106>2106252
Ref: libraries/iqr_anomaly_detector testing2106383
Ref: d7c2106383
Node: Features<30>2106535
Ref: libraries/iqr_anomaly_detector features2106665
Ref: d7d2106665
Node: Options<28>2110281
Ref: libraries/iqr_anomaly_detector options2110425
Ref: d7e2110425
Node: Detector representation<3>2111425
Ref: libraries/iqr_anomaly_detector detector-representation2111565
Ref: d7f2111565
Node: Notes<7>2112453
Ref: libraries/iqr_anomaly_detector notes2112573
Ref: d802112573
Node: iso_6392115135
Ref: libraries/iso_639 doc2115254
Ref: d812115254
Ref: libraries/iso_639 iso-6392115254
Ref: d822115254
Ref: libraries/iso_639 library-iso-6392115254
Ref: d832115254
Node: API documentation<113>2116011
Ref: libraries/iso_639 api-documentation2116118
Ref: d842116118
Node: Loading<115>2116246
Ref: libraries/iso_639 loading2116374
Ref: d852116374
Node: Testing<107>2116518
Ref: libraries/iso_639 testing2116615
Ref: d862116615
Node: iso_31662116754
Ref: libraries/iso_3166 doc2116861
Ref: d872116861
Ref: libraries/iso_3166 iso-31662116861
Ref: d882116861
Ref: libraries/iso_3166 library-iso-31662116861
Ref: d892116861
Node: API documentation<114>2117823
Ref: libraries/iso_3166 api-documentation2117931
Ref: d8a2117931
Node: Loading<116>2118060
Ref: libraries/iso_3166 loading2118189
Ref: d8b2118189
Node: Testing<108>2118334
Ref: libraries/iso_3166 testing2118432
Ref: d8c2118432
Node: iso_42172118572
Ref: libraries/iso_4217 doc2118680
Ref: d8d2118680
Ref: libraries/iso_4217 iso-42172118680
Ref: d8e2118680
Ref: libraries/iso_4217 library-iso-42172118680
Ref: d8f2118680
Node: API documentation<115>2119517
Ref: libraries/iso_4217 api-documentation2119625
Ref: d902119625
Node: Loading<117>2119754
Ref: libraries/iso_4217 loading2119883
Ref: d912119883
Node: Testing<109>2120028
Ref: libraries/iso_4217 testing2120126
Ref: d922120126
Node: iso_93622120266
Ref: libraries/iso_9362 doc2120375
Ref: d932120375
Ref: libraries/iso_9362 iso-93622120375
Ref: d942120375
Ref: libraries/iso_9362 library-iso-93622120375
Ref: d952120375
Node: API documentation<116>2121413
Ref: libraries/iso_9362 api-documentation2121521
Ref: d962121521
Node: Loading<118>2121650
Ref: libraries/iso_9362 loading2121779
Ref: d972121779
Node: Testing<110>2121924
Ref: libraries/iso_9362 testing2122022
Ref: d982122022
Node: iso_136162122162
Ref: libraries/iso_13616 doc2122296
Ref: d992122296
Ref: libraries/iso_13616 iso-136162122296
Ref: d9a2122296
Ref: libraries/iso_13616 library-iso-136162122296
Ref: d9b2122296
Node: API documentation<117>2123550
Ref: libraries/iso_13616 api-documentation2123659
Ref: d9c2123659
Node: Loading<119>2123789
Ref: libraries/iso_13616 loading2123919
Ref: d9d2123919
Node: Testing<111>2124065
Ref: libraries/iso_13616 testing2124164
Ref: d9e2124164
Node: isolation_forest_anomaly_detector2124305
Ref: libraries/isolation_forest_anomaly_detector doc2124435
Ref: d9f2124435
Ref: libraries/isolation_forest_anomaly_detector isolation-forest-anomaly-detector2124435
Ref: da02124435
Ref: libraries/isolation_forest_anomaly_detector library-isolation-forest-anomaly-detector2124435
Ref: da12124435
Node: API documentation<118>2125889
Ref: libraries/isolation_forest_anomaly_detector api-documentation2126022
Ref: da22126022
Node: Loading<120>2126161
Ref: libraries/isolation_forest_anomaly_detector loading2126315
Ref: da32126315
Node: Testing<112>2126487
Ref: libraries/isolation_forest_anomaly_detector testing2126642
Ref: da42126642
Node: Implemented features<2>2126809
Ref: libraries/isolation_forest_anomaly_detector implemented-features2126963
Ref: da52126963
Node: Options<29>2129071
Ref: libraries/isolation_forest_anomaly_detector options2129239
Ref: da62129239
Node: Detector representation<4>2130293
Ref: libraries/isolation_forest_anomaly_detector detector-representation2130452
Ref: da72130452
Node: Limitations<4>2131586
Ref: libraries/isolation_forest_anomaly_detector limitations2131748
Ref: da82131748
Node: References<19>2131931
Ref: libraries/isolation_forest_anomaly_detector references2132076
Ref: da92132076
Node: Usage<52>2132548
Ref: libraries/isolation_forest_anomaly_detector usage2132670
Ref: daa2132670
Node: java2134733
Ref: libraries/java doc2134858
Ref: dab2134858
Ref: libraries/java java2134858
Ref: dac2134858
Ref: libraries/java library-java2134858
Ref: dad2134858
Node: API documentation<119>2136094
Ref: libraries/java api-documentation2136198
Ref: dae2136198
Node: Loading<121>2136325
Ref: libraries/java loading2136450
Ref: daf2136450
Node: Testing<113>2136593
Ref: libraries/java testing2136705
Ref: db02136705
Node: Usage<53>2136843
Ref: libraries/java usage2136959
Ref: db12136959
Node: Known issues<11>2137561
Ref: libraries/java known-issues2137656
Ref: db22137656
Node: json2138060
Ref: libraries/json doc2138159
Ref: db32138159
Ref: libraries/json json2138159
Ref: db42138159
Ref: libraries/json library-json2138159
Ref: db52138159
Node: API documentation<120>2138964
Ref: libraries/json api-documentation2139068
Ref: db62139068
Node: Loading<122>2139195
Ref: libraries/json loading2139320
Ref: db72139320
Node: Testing<114>2139463
Ref: libraries/json testing2139584
Ref: db82139584
Node: Representation<11>2139823
Ref: libraries/json representation2139943
Ref: db92139943
Node: Encoding<7>2145389
Ref: libraries/json encoding2145508
Ref: dba2145508
Node: Decoding<7>2146316
Ref: libraries/json decoding2146433
Ref: dbb2146433
Node: Known issues<12>2146961
Ref: libraries/json known-issues2147058
Ref: dbc2147058
Node: json_ld2147265
Ref: libraries/json_ld doc2147370
Ref: dbd2147370
Ref: libraries/json_ld json-ld2147370
Ref: dbe2147370
Ref: libraries/json_ld library-json-ld2147370
Ref: dbf2147370
Node: API documentation<121>2148312
Ref: libraries/json_ld api-documentation2148419
Ref: dc02148419
Node: Loading<123>2148549
Ref: libraries/json_ld loading2148677
Ref: dc12148677
Node: Testing<115>2148823
Ref: libraries/json_ld testing2148939
Ref: dc22148939
Node: Parsing<2>2149080
Ref: libraries/json_ld parsing2149197
Ref: dc32149197
Node: Generating<2>2149576
Ref: libraries/json_ld generating2149690
Ref: dc42149690
Node: Expansion2149930
Ref: libraries/json_ld expansion2150044
Ref: dc52150044
Node: Compaction2150574
Ref: libraries/json_ld compaction2150685
Ref: dc62150685
Node: Flattening2151049
Ref: libraries/json_ld flattening2151169
Ref: dc72151169
Node: Supported Features2151681
Ref: libraries/json_ld supported-features2151809
Ref: dc82151809
Node: Representation<12>2153151
Ref: libraries/json_ld representation2153260
Ref: dc92153260
Node: json_lines2154852
Ref: libraries/json_lines doc2154965
Ref: dca2154965
Ref: libraries/json_lines json-lines2154965
Ref: dcb2154965
Ref: libraries/json_lines library-json-lines2154965
Ref: dcc2154965
Node: API documentation<122>2155658
Ref: libraries/json_lines api-documentation2155768
Ref: dcd2155768
Node: Loading<124>2155901
Ref: libraries/json_lines loading2156032
Ref: dce2156032
Node: Testing<116>2156181
Ref: libraries/json_lines testing2156308
Ref: dcf2156308
Node: Representation<13>2156554
Ref: libraries/json_lines representation2156680
Ref: dd02156680
Node: Encoding<8>2162215
Ref: libraries/json_lines encoding2162340
Ref: dd12162340
Node: Decoding<8>2163162
Ref: libraries/json_lines decoding2163285
Ref: dd22163285
Node: Known issues<13>2163800
Ref: libraries/json_lines known-issues2163903
Ref: dd32163903
Node: json_pointer2164040
Ref: libraries/json_pointer doc2164154
Ref: dd42164154
Ref: libraries/json_pointer json-pointer2164154
Ref: dd52164154
Ref: libraries/json_pointer library-json-pointer2164154
Ref: dd62164154
Node: API documentation<123>2164712
Ref: libraries/json_pointer api-documentation2164824
Ref: dd72164824
Node: Loading<125>2164959
Ref: libraries/json_pointer loading2165092
Ref: dd82165092
Node: Testing<117>2165243
Ref: libraries/json_pointer testing2165372
Ref: dd92165372
Node: Representation<14>2165518
Ref: libraries/json_pointer representation2165648
Ref: dda2165648
Node: Examples<172>2166122
Ref: libraries/json_pointer examples2166231
Ref: ddb2166231
Node: json_rpc2166631
Ref: libraries/json_rpc doc2166746
Ref: ddc2166746
Ref: libraries/json_rpc json-rpc2166746
Ref: ddd2166746
Ref: libraries/json_rpc library-json-rpc2166746
Ref: dde2166746
Node: API documentation<124>2167409
Ref: libraries/json_rpc api-documentation2167517
Ref: ddf2167517
Node: Loading<126>2167648
Ref: libraries/json_rpc loading2167777
Ref: de02167777
Node: Testing<118>2167908
Ref: libraries/json_rpc testing2168024
Ref: de12168024
Node: Usage<54>2168166
Ref: libraries/json_rpc usage2168281
Ref: de22168281
Node: Constructing JSON-RPC 2 0 messages2168666
Ref: libraries/json_rpc constructing-json-rpc-2-0-messages2168802
Ref: de32168802
Ref: libraries/json_rpc constructing-json-rpc-20-messages2168802
Ref: de42168802
Node: Standard error constructors2169408
Ref: libraries/json_rpc standard-error-constructors2169574
Ref: de52169574
Node: Encoding and decoding2169965
Ref: libraries/json_rpc encoding-and-decoding2170119
Ref: de62170119
Node: Message classification2170438
Ref: libraries/json_rpc message-classification2170581
Ref: de72170581
Node: Field extraction2170915
Ref: libraries/json_rpc field-extraction2171069
Ref: de82171069
Node: Stream I/O client and server API2171518
Ref: libraries/json_rpc stream-i-o-client-and-server-api2171693
Ref: de92171693
Node: Content-Length framed I/O LSP/MCP protocols2172119
Ref: libraries/json_rpc content-length-framed-i-o-lsp-mcp-protocols2172269
Ref: dea2172269
Node: API summary2172895
Ref: libraries/json_rpc api-summary2172989
Ref: deb2172989
Node: Message construction2173254
Ref: libraries/json_rpc message-construction2173375
Ref: dec2173375
Node: Standard error responses2174231
Ref: libraries/json_rpc standard-error-responses2174385
Ref: ded2174385
Node: Encoding and decoding<2>2174898
Ref: libraries/json_rpc encoding-and-decoding-12175057
Ref: dee2175057
Ref: libraries/json_rpc id12175057
Ref: def2175057
Node: Message classification<2>2175336
Ref: libraries/json_rpc id22175490
Ref: df02175490
Ref: libraries/json_rpc message-classification-12175490
Ref: df12175490
Node: Field extraction<2>2175963
Ref: libraries/json_rpc field-extraction-12176103
Ref: df22176103
Ref: libraries/json_rpc id32176103
Ref: df32176103
Node: Stream I/O2176747
Ref: libraries/json_rpc stream-i-o2176853
Ref: df42176853
Node: json_schema2177547
Ref: libraries/json_schema doc2177668
Ref: df52177668
Ref: libraries/json_schema json-schema2177668
Ref: df62177668
Ref: libraries/json_schema library-json-schema2177668
Ref: df72177668
Node: API documentation<125>2178244
Ref: libraries/json_schema api-documentation2178355
Ref: df82178355
Node: Loading<127>2178489
Ref: libraries/json_schema loading2178621
Ref: df92178621
Node: Testing<119>2178771
Ref: libraries/json_schema testing2178895
Ref: dfa2178895
Node: Schema Parsing2179040
Ref: libraries/json_schema schema-parsing2179162
Ref: dfb2179162
Node: Validation2179468
Ref: libraries/json_schema validation2179596
Ref: dfc2179596
Node: Supported Keywords2180226
Ref: libraries/json_schema supported-keywords2180357
Ref: dfd2180357
Node: Known Limitations2183233
Ref: libraries/json_schema known-limitations2183345
Ref: dfe2183345
Node: kcenters_clusterer2183791
Ref: libraries/kcenters_clusterer doc2183923
Ref: dff2183923
Ref: libraries/kcenters_clusterer kcenters-clusterer2183923
Ref: e002183923
Ref: libraries/kcenters_clusterer library-kcenters-clusterer2183923
Ref: e012183923
Node: API documentation<126>2184812
Ref: libraries/kcenters_clusterer api-documentation2184930
Ref: e022184930
Node: Loading<128>2185071
Ref: libraries/kcenters_clusterer loading2185210
Ref: e032185210
Node: Testing<120>2185351
Ref: libraries/kcenters_clusterer testing2185480
Ref: e042185480
Node: Features<31>2185782
Ref: libraries/kcenters_clusterer features2185910
Ref: e052185910
Node: Options<30>2186795
Ref: libraries/kcenters_clusterer options2186925
Ref: e062186925
Node: Diagnostics<4>2187510
Ref: libraries/kcenters_clusterer diagnostics2187655
Ref: e072187655
Node: Clusterer representation<6>2187940
Ref: libraries/kcenters_clusterer clusterer-representation2188088
Ref: e082188088
Node: References<20>2188733
Ref: libraries/kcenters_clusterer references2188858
Ref: e092188858
Node: kemeny_young_ranker2189034
Ref: libraries/kemeny_young_ranker doc2189176
Ref: e0a2189176
Ref: libraries/kemeny_young_ranker kemeny-young-ranker2189176
Ref: e0b2189176
Ref: libraries/kemeny_young_ranker library-kemeny-young-ranker2189176
Ref: e0c2189176
Node: API documentation<127>2190528
Ref: libraries/kemeny_young_ranker api-documentation2190647
Ref: e0d2190647
Node: Loading<129>2190789
Ref: libraries/kemeny_young_ranker loading2190929
Ref: e0e2190929
Node: Testing<121>2191071
Ref: libraries/kemeny_young_ranker testing2191201
Ref: e0f2191201
Node: Features<32>2191354
Ref: libraries/kemeny_young_ranker features2191481
Ref: e102191481
Node: Usage<55>2192881
Ref: libraries/kemeny_young_ranker usage2193007
Ref: e112193007
Node: Learning a ranker<9>2193181
Ref: libraries/kemeny_young_ranker learning-a-ranker2193308
Ref: e122193308
Node: Inspecting the learned consensus2193640
Ref: libraries/kemeny_young_ranker inspecting-the-learned-consensus2193802
Ref: e132193802
Node: Ranking candidate items<8>2194336
Ref: libraries/kemeny_young_ranker ranking-candidate-items2194469
Ref: e142194469
Node: Options<31>2195012
Ref: libraries/kemeny_young_ranker options2195146
Ref: e152195146
Node: Scoring semantics<5>2195643
Ref: libraries/kemeny_young_ranker scoring-semantics2195790
Ref: e162195790
Node: Diagnostics syntax<12>2196309
Ref: libraries/kemeny_young_ranker diagnostics-syntax2196469
Ref: e172196469
Node: Ranker representation<9>2196815
Ref: libraries/kemeny_young_ranker ranker-representation2196963
Ref: e182196963
Node: Notes<8>2197412
Ref: libraries/kemeny_young_ranker notes2197552
Ref: e192197552
Node: References<21>2197741
Ref: libraries/kemeny_young_ranker references2197848
Ref: e1a2197848
Node: kernel_svm_classifier2198011
Ref: libraries/kernel_svm_classifier doc2198156
Ref: e1b2198156
Ref: libraries/kernel_svm_classifier kernel-svm-classifier2198156
Ref: e1c2198156
Ref: libraries/kernel_svm_classifier library-kernel-svm-classifier2198156
Ref: e1d2198156
Node: API documentation<128>2199320
Ref: libraries/kernel_svm_classifier api-documentation2199441
Ref: e1e2199441
Node: Loading<130>2199585
Ref: libraries/kernel_svm_classifier loading2199727
Ref: e1f2199727
Node: Testing<122>2199871
Ref: libraries/kernel_svm_classifier testing2200003
Ref: e202200003
Node: Features<33>2200158
Ref: libraries/kernel_svm_classifier features2200289
Ref: e212200289
Node: Options<32>2201068
Ref: libraries/kernel_svm_classifier options2201196
Ref: e222201196
Node: Usage<56>2202037
Ref: libraries/kernel_svm_classifier usage2202181
Ref: e232202181
Node: Learning a classifier<2>2202373
Ref: libraries/kernel_svm_classifier learning-a-classifier2202493
Ref: e242202493
Node: Making predictions<2>2202724
Ref: libraries/kernel_svm_classifier making-predictions2202880
Ref: e252202880
Node: Exporting the classifier<2>2203324
Ref: libraries/kernel_svm_classifier exporting-the-classifier2203447
Ref: e262203447
Node: Classifier representation<3>2203831
Ref: libraries/kernel_svm_classifier classifier-representation2203978
Ref: e272203978
Node: References<22>2204866
Ref: libraries/kernel_svm_classifier references2204995
Ref: e282204995
Node: kernel_pca_projection2205272
Ref: libraries/kernel_pca_projection doc2205414
Ref: e292205414
Ref: libraries/kernel_pca_projection kernel-pca-projection2205414
Ref: e2a2205414
Ref: libraries/kernel_pca_projection library-kernel-pca-projection2205414
Ref: e2b2205414
Node: API documentation<129>2206213
Ref: libraries/kernel_pca_projection api-documentation2206334
Ref: e2c2206334
Node: Loading<131>2206478
Ref: libraries/kernel_pca_projection loading2206620
Ref: e2d2206620
Node: Testing<123>2206764
Ref: libraries/kernel_pca_projection testing2206896
Ref: e2e2206896
Node: Features<34>2207051
Ref: libraries/kernel_pca_projection features2207182
Ref: e2f2207182
Node: Options<33>2208409
Ref: libraries/kernel_pca_projection options2208537
Ref: e302208537
Node: Usage<57>2210094
Ref: libraries/kernel_pca_projection usage2210245
Ref: e312210245
Node: Learning a reducer<2>2210665
Ref: libraries/kernel_pca_projection learning-a-reducer2210790
Ref: e322210790
Node: Transforming new instances<2>2211041
Ref: libraries/kernel_pca_projection transforming-new-instances2211211
Ref: e332211211
Node: Exporting and reusing the reducer<2>2211503
Ref: libraries/kernel_pca_projection exporting-and-reusing-the-reducer2211643
Ref: e342211643
Node: Dimension reducer representation<2>2212118
Ref: libraries/kernel_pca_projection dimension-reducer-representation2212272
Ref: e352212272
Node: References<23>2213690
Ref: libraries/kernel_pca_projection references2213826
Ref: e362213826
Node: kmeans_clusterer2214098
Ref: libraries/kmeans_clusterer doc2214237
Ref: e372214237
Ref: libraries/kmeans_clusterer kmeans-clusterer2214237
Ref: e382214237
Ref: libraries/kmeans_clusterer library-kmeans-clusterer2214237
Ref: e392214237
Node: API documentation<130>2215116
Ref: libraries/kmeans_clusterer api-documentation2215232
Ref: e3a2215232
Node: Loading<132>2215371
Ref: libraries/kmeans_clusterer loading2215508
Ref: e3b2215508
Node: Testing<124>2215647
Ref: libraries/kmeans_clusterer testing2215774
Ref: e3c2215774
Node: Features<35>2216072
Ref: libraries/kmeans_clusterer features2216198
Ref: e3d2216198
Node: Options<34>2216995
Ref: libraries/kmeans_clusterer options2217123
Ref: e3e2217123
Node: Diagnostics<5>2217811
Ref: libraries/kmeans_clusterer diagnostics2217954
Ref: e3f2217954
Node: Clusterer representation<7>2218291
Ref: libraries/kmeans_clusterer clusterer-representation2218437
Ref: e402218437
Node: References<24>2219086
Ref: libraries/kmeans_clusterer references2219209
Ref: e412219209
Node: kmedians_clusterer2219577
Ref: libraries/kmedians_clusterer doc2219713
Ref: e422219713
Ref: libraries/kmedians_clusterer kmedians-clusterer2219713
Ref: e432219713
Ref: libraries/kmedians_clusterer library-kmedians-clusterer2219713
Ref: e442219713
Node: API documentation<131>2220615
Ref: libraries/kmedians_clusterer api-documentation2220733
Ref: e452220733
Node: Loading<133>2220874
Ref: libraries/kmedians_clusterer loading2221013
Ref: e462221013
Node: Testing<125>2221154
Ref: libraries/kmedians_clusterer testing2221283
Ref: e472221283
Node: Features<36>2221585
Ref: libraries/kmedians_clusterer features2221713
Ref: e482221713
Node: Options<35>2222608
Ref: libraries/kmedians_clusterer options2222738
Ref: e492222738
Node: Diagnostics<6>2223430
Ref: libraries/kmedians_clusterer diagnostics2223575
Ref: e4a2223575
Node: Clusterer representation<8>2223912
Ref: libraries/kmedians_clusterer clusterer-representation2224060
Ref: e4b2224060
Node: References<25>2224705
Ref: libraries/kmedians_clusterer references2224830
Ref: e4c2224830
Node: kmedoids_clusterer2225188
Ref: libraries/kmedoids_clusterer doc2225324
Ref: e4d2225324
Ref: libraries/kmedoids_clusterer kmedoids-clusterer2225324
Ref: e4e2225324
Ref: libraries/kmedoids_clusterer library-kmedoids-clusterer2225324
Ref: e4f2225324
Node: API documentation<132>2226263
Ref: libraries/kmedoids_clusterer api-documentation2226381
Ref: e502226381
Node: Loading<134>2226522
Ref: libraries/kmedoids_clusterer loading2226661
Ref: e512226661
Node: Testing<126>2226802
Ref: libraries/kmedoids_clusterer testing2226931
Ref: e522226931
Node: Features<37>2227233
Ref: libraries/kmedoids_clusterer features2227361
Ref: e532227361
Node: Options<36>2228222
Ref: libraries/kmedoids_clusterer options2228352
Ref: e542228352
Node: Diagnostics<7>2229166
Ref: libraries/kmedoids_clusterer diagnostics2229311
Ref: e552229311
Node: Clusterer representation<9>2229648
Ref: libraries/kmedoids_clusterer clusterer-representation2229796
Ref: e562229796
Node: References<26>2230441
Ref: libraries/kmedoids_clusterer references2230566
Ref: e572230566
Node: kmodes_clusterer2230870
Ref: libraries/kmodes_clusterer doc2231002
Ref: e582231002
Ref: libraries/kmodes_clusterer kmodes-clusterer2231002
Ref: e592231002
Ref: libraries/kmodes_clusterer library-kmodes-clusterer2231002
Ref: e5a2231002
Node: API documentation<133>2231932
Ref: libraries/kmodes_clusterer api-documentation2232048
Ref: e5b2232048
Node: Loading<135>2232187
Ref: libraries/kmodes_clusterer loading2232324
Ref: e5c2232324
Node: Testing<127>2232463
Ref: libraries/kmodes_clusterer testing2232590
Ref: e5d2232590
Node: Features<38>2232888
Ref: libraries/kmodes_clusterer features2233014
Ref: e5e2233014
Node: Options<37>2233691
Ref: libraries/kmodes_clusterer options2233819
Ref: e5f2233819
Node: Diagnostics<8>2234340
Ref: libraries/kmodes_clusterer diagnostics2234484
Ref: e602234484
Node: Clusterer representation<10>2234817
Ref: libraries/kmodes_clusterer clusterer-representation2234964
Ref: e612234964
Node: References<27>2235567
Ref: libraries/kmodes_clusterer references2235691
Ref: e622235691
Node: knn_classifier2235909
Ref: libraries/knn_classifier doc2236052
Ref: e632236052
Ref: libraries/knn_classifier knn-classifier2236052
Ref: e642236052
Ref: libraries/knn_classifier library-knn-classifier2236052
Ref: e652236052
Node: API documentation<134>2237079
Ref: libraries/knn_classifier api-documentation2237193
Ref: e662237193
Node: Loading<136>2237330
Ref: libraries/knn_classifier loading2237465
Ref: e672237465
Node: Testing<128>2237602
Ref: libraries/knn_classifier testing2237727
Ref: e682237727
Node: Features<39>2237875
Ref: libraries/knn_classifier features2237997
Ref: e692237997
Node: Usage<58>2238575
Ref: libraries/knn_classifier usage2238696
Ref: e6a2238696
Node: Learning a Classifier<2>2238919
Ref: libraries/knn_classifier learning-a-classifier2239039
Ref: e6b2239039
Node: Making Predictions<2>2239389
Ref: libraries/knn_classifier making-predictions2239545
Ref: e6c2239545
Node: Exporting the Classifier<2>2240197
Ref: libraries/knn_classifier exporting-the-classifier2240355
Ref: e6d2240355
Node: Using a learned classifier2240932
Ref: libraries/knn_classifier using-a-learned-classifier2241060
Ref: e6e2241060
Node: Options<38>2241500
Ref: libraries/knn_classifier options2241637
Ref: e6f2241637
Node: Classifier representation<4>2242134
Ref: libraries/knn_classifier classifier-representation2242276
Ref: e702242276
Node: References<28>2242943
Ref: libraries/knn_classifier references2243065
Ref: e712243065
Node: knn_distance_anomaly_detector2243448
Ref: libraries/knn_distance_anomaly_detector doc2243589
Ref: e722243589
Ref: libraries/knn_distance_anomaly_detector knn-distance-anomaly-detector2243589
Ref: e732243589
Ref: libraries/knn_distance_anomaly_detector library-knn-distance-anomaly-detector2243589
Ref: e742243589
Node: API documentation<135>2244862
Ref: libraries/knn_distance_anomaly_detector api-documentation2244991
Ref: e752244991
Node: Loading<137>2245143
Ref: libraries/knn_distance_anomaly_detector loading2245293
Ref: e762245293
Node: Testing<129>2245445
Ref: libraries/knn_distance_anomaly_detector testing2245585
Ref: e772245585
Node: Features<40>2245748
Ref: libraries/knn_distance_anomaly_detector features2245887
Ref: e782245887
Node: Options<39>2246931
Ref: libraries/knn_distance_anomaly_detector options2247084
Ref: e792247084
Node: Detector representation<5>2247937
Ref: libraries/knn_distance_anomaly_detector detector-representation2248092
Ref: e7a2248092
Node: References<29>2249687
Ref: libraries/knn_distance_anomaly_detector references2249822
Ref: e7b2249822
Node: knn_regression2250095
Ref: libraries/knn_regression doc2250243
Ref: e7c2250243
Ref: libraries/knn_regression knn-regression2250243
Ref: e7d2250243
Ref: libraries/knn_regression library-knn-regression2250243
Ref: e7e2250243
Node: API documentation<136>2250996
Ref: libraries/knn_regression api-documentation2251110
Ref: e7f2251110
Node: Loading<138>2251247
Ref: libraries/knn_regression loading2251382
Ref: e802251382
Node: Testing<130>2251519
Ref: libraries/knn_regression testing2251644
Ref: e812251644
Node: Features<41>2251938
Ref: libraries/knn_regression features2252078
Ref: e822252078
Node: Regressor representation<5>2253435
Ref: libraries/knn_regression regressor-representation2253585
Ref: e832253585
Node: Diagnostics syntax<13>2254041
Ref: libraries/knn_regression diagnostics-syntax2254190
Ref: e842254190
Node: Options<40>2255320
Ref: libraries/knn_regression options2255433
Ref: e852255433
Node: kprototypes_clusterer2256608
Ref: libraries/kprototypes_clusterer doc2256732
Ref: e862256732
Ref: libraries/kprototypes_clusterer kprototypes-clusterer2256732
Ref: e872256732
Ref: libraries/kprototypes_clusterer library-kprototypes-clusterer2256732
Ref: e882256732
Node: API documentation<137>2257703
Ref: libraries/kprototypes_clusterer api-documentation2257824
Ref: e892257824
Node: Loading<139>2257968
Ref: libraries/kprototypes_clusterer loading2258110
Ref: e8a2258110
Node: Testing<131>2258254
Ref: libraries/kprototypes_clusterer testing2258386
Ref: e8b2258386
Node: Features<42>2258694
Ref: libraries/kprototypes_clusterer features2258825
Ref: e8c2258825
Node: Options<41>2259910
Ref: libraries/kprototypes_clusterer options2260046
Ref: e8d2260046
Node: Distance Function2260851
Ref: libraries/kprototypes_clusterer distance-function2261003
Ref: e8e2261003
Node: Clusterer representation<11>2261641
Ref: libraries/kprototypes_clusterer clusterer-representation2261796
Ref: e8f2261796
Node: References<30>2262443
Ref: libraries/kprototypes_clusterer references2262572
Ref: e902262572
Node: ksuid2262987
Ref: libraries/ksuid doc2263113
Ref: e912263113
Ref: libraries/ksuid ksuid2263113
Ref: e922263113
Ref: libraries/ksuid library-ksuid2263113
Ref: e932263113
Node: API documentation<138>2264070
Ref: libraries/ksuid api-documentation2264175
Ref: e942264175
Node: Loading<140>2264303
Ref: libraries/ksuid loading2264429
Ref: e952264429
Node: Testing<132>2264573
Ref: libraries/ksuid testing2264686
Ref: e962264686
Node: Usage<59>2264825
Ref: libraries/ksuid usage2264917
Ref: e972264917
Node: lasso_regression2265385
Ref: libraries/lasso_regression doc2265504
Ref: e982265504
Ref: libraries/lasso_regression lasso-regression2265504
Ref: e992265504
Ref: libraries/lasso_regression library-lasso-regression2265504
Ref: e9a2265504
Node: API documentation<139>2266410
Ref: libraries/lasso_regression api-documentation2266526
Ref: e9b2266526
Node: Loading<141>2266665
Ref: libraries/lasso_regression loading2266802
Ref: e9c2266802
Node: Testing<133>2266941
Ref: libraries/lasso_regression testing2267068
Ref: e9d2267068
Node: Features<43>2267366
Ref: libraries/lasso_regression features2267508
Ref: e9e2267508
Node: Regressor representation<6>2269040
Ref: libraries/lasso_regression regressor-representation2269192
Ref: e9f2269192
Node: Diagnostics syntax<14>2269742
Ref: libraries/lasso_regression diagnostics-syntax2269893
Ref: ea02269893
Node: Options<42>2271757
Ref: libraries/lasso_regression options2271872
Ref: ea12271872
Node: lda_classifier2272908
Ref: libraries/lda_classifier doc2273036
Ref: ea22273036
Ref: libraries/lda_classifier lda-classifier2273036
Ref: ea32273036
Ref: libraries/lda_classifier library-lda-classifier2273036
Ref: ea42273036
Node: API documentation<140>2274107
Ref: libraries/lda_classifier api-documentation2274221
Ref: ea52274221
Node: Loading<142>2274358
Ref: libraries/lda_classifier loading2274493
Ref: ea62274493
Node: Testing<134>2274630
Ref: libraries/lda_classifier testing2274755
Ref: ea72274755
Node: Features<44>2274903
Ref: libraries/lda_classifier features2275027
Ref: ea82275027
Node: Options<43>2275723
Ref: libraries/lda_classifier options2275844
Ref: ea92275844
Node: Usage<60>2276189
Ref: libraries/lda_classifier usage2276326
Ref: eaa2276326
Node: Learning a classifier<3>2276518
Ref: libraries/lda_classifier learning-a-classifier2276638
Ref: eab2276638
Node: Making predictions<3>2276845
Ref: libraries/lda_classifier making-predictions2277001
Ref: eac2277001
Node: Exporting the classifier<3>2277436
Ref: libraries/lda_classifier exporting-the-classifier2277559
Ref: ead2277559
Node: Classifier representation<5>2277927
Ref: libraries/lda_classifier classifier-representation2278067
Ref: eae2278067
Node: References<31>2278762
Ref: libraries/lda_classifier references2278884
Ref: eaf2278884
Node: lda_projection2279234
Ref: libraries/lda_projection doc2279351
Ref: eb02279351
Ref: libraries/lda_projection lda-projection2279351
Ref: eb12279351
Ref: libraries/lda_projection library-lda-projection2279351
Ref: eb22279351
Node: API documentation<141>2280386
Ref: libraries/lda_projection api-documentation2280500
Ref: eb32280500
Node: Loading<143>2280637
Ref: libraries/lda_projection loading2280772
Ref: eb42280772
Node: Testing<135>2280909
Ref: libraries/lda_projection testing2281034
Ref: eb52281034
Node: Features<45>2281182
Ref: libraries/lda_projection features2281306
Ref: eb62281306
Node: Options<44>2282139
Ref: libraries/lda_projection options2282260
Ref: eb72282260
Node: Usage<61>2283352
Ref: libraries/lda_projection usage2283496
Ref: eb82283496
Node: Learning a reducer<3>2283927
Ref: libraries/lda_projection learning-a-reducer2284052
Ref: eb92284052
Node: Transforming new instances<3>2284370
Ref: libraries/lda_projection transforming-new-instances2284540
Ref: eba2284540
Node: Exporting and reusing the reducer<3>2285024
Ref: libraries/lda_projection exporting-and-reusing-the-reducer2285164
Ref: ebb2285164
Node: Dimension reducer representation<3>2285660
Ref: libraries/lda_projection dimension-reducer-representation2285807
Ref: ebc2285807
Node: References<32>2286727
Ref: libraries/lda_projection references2286856
Ref: ebd2286856
Node: linda2287111
Ref: libraries/linda doc2287228
Ref: ebe2287228
Ref: libraries/linda library-linda2287228
Ref: ebf2287228
Ref: libraries/linda linda2287228
Ref: ec02287228
Node: API documentation<142>2288350
Ref: libraries/linda api-documentation2288455
Ref: ec12288455
Node: Loading<144>2288583
Ref: libraries/linda loading2288709
Ref: ec22288709
Node: Testing<136>2288837
Ref: libraries/linda testing2288950
Ref: ec32288950
Node: Usage<62>2289089
Ref: libraries/linda usage2289203
Ref: ec42289203
Node: Starting a server2289792
Ref: libraries/linda starting-a-server2289903
Ref: ec52289903
Node: Connecting a client2290290
Ref: libraries/linda connecting-a-client2290426
Ref: ec62290426
Node: Tuple operations2290561
Ref: libraries/linda tuple-operations2290693
Ref: ec72290693
Node: Disconnecting2291729
Ref: libraries/linda disconnecting2291857
Ref: ec82291857
Node: Timeout control2292091
Ref: libraries/linda timeout-control2292194
Ref: ec92292194
Node: Examples<173>2292425
Ref: libraries/linda examples2292538
Ref: eca2292538
Node: Producer-Consumer2292645
Ref: libraries/linda producer-consumer2292756
Ref: ecb2292756
Node: Critical Region2293032
Ref: libraries/linda critical-region2293167
Ref: ecc2293167
Node: Synchronization2293412
Ref: libraries/linda synchronization2293521
Ref: ecd2293521
Node: API Summary2293709
Ref: libraries/linda api-summary2293829
Ref: ece2293829
Node: Server predicates2294082
Ref: libraries/linda server-predicates2294193
Ref: ecf2294193
Node: Client predicates2294356
Ref: libraries/linda client-predicates2294514
Ref: ed02294514
Node: Tuple predicates single/default server2294796
Ref: libraries/linda tuple-predicates-single-default-server2294970
Ref: ed12294970
Node: Tuple predicates multiple servers2295895
Ref: libraries/linda tuple-predicates-multiple-servers2296043
Ref: ed22296043
Node: Known issues<14>2296287
Ref: libraries/linda known-issues2296405
Ref: ed32296405
Node: See also<2>2296739
Ref: libraries/linda see-also2296837
Ref: ed42296837
Node: linear_algebra2297220
Ref: libraries/linear_algebra doc2297340
Ref: ed52297340
Ref: libraries/linear_algebra library-linear-algebra2297340
Ref: ed62297340
Ref: libraries/linear_algebra linear-algebra2297340
Ref: ed72297340
Node: API documentation<143>2299681
Ref: libraries/linear_algebra api-documentation2299795
Ref: ed82299795
Node: Loading<145>2299932
Ref: libraries/linear_algebra loading2300067
Ref: ed92300067
Node: Testing<137>2300220
Ref: libraries/linear_algebra testing2300324
Ref: eda2300324
Node: linear_regression2300472
Ref: libraries/linear_regression doc2300608
Ref: edb2300608
Ref: libraries/linear_regression library-linear-regression2300608
Ref: edc2300608
Ref: libraries/linear_regression linear-regression2300608
Ref: edd2300608
Node: API documentation<144>2301488
Ref: libraries/linear_regression api-documentation2301605
Ref: ede2301605
Node: Loading<146>2301745
Ref: libraries/linear_regression loading2301883
Ref: edf2301883
Node: Testing<138>2302023
Ref: libraries/linear_regression testing2302151
Ref: ee02302151
Node: Features<46>2302451
Ref: libraries/linear_regression features2302594
Ref: ee12302594
Node: Regressor representation<7>2304178
Ref: libraries/linear_regression regressor-representation2304331
Ref: ee22304331
Node: Diagnostics syntax<15>2304882
Ref: libraries/linear_regression diagnostics-syntax2305034
Ref: ee32305034
Node: Options<45>2307112
Ref: libraries/linear_regression options2307228
Ref: ee42307228
Node: linear_svm_classifier2307529
Ref: libraries/linear_svm_classifier doc2307658
Ref: ee52307658
Ref: libraries/linear_svm_classifier library-linear-svm-classifier2307658
Ref: ee62307658
Ref: libraries/linear_svm_classifier linear-svm-classifier2307658
Ref: ee72307658
Node: API documentation<145>2308845
Ref: libraries/linear_svm_classifier api-documentation2308966
Ref: ee82308966
Node: Loading<147>2309110
Ref: libraries/linear_svm_classifier loading2309252
Ref: ee92309252
Node: Testing<139>2309396
Ref: libraries/linear_svm_classifier testing2309528
Ref: eea2309528
Node: Features<47>2309836
Ref: libraries/linear_svm_classifier features2309967
Ref: eeb2309967
Node: Options<46>2311220
Ref: libraries/linear_svm_classifier options2311348
Ref: eec2311348
Node: Usage<63>2311838
Ref: libraries/linear_svm_classifier usage2311982
Ref: eed2311982
Node: Learning a classifier<4>2312174
Ref: libraries/linear_svm_classifier learning-a-classifier2312294
Ref: eee2312294
Node: Making predictions<4>2312535
Ref: libraries/linear_svm_classifier making-predictions2312691
Ref: eef2312691
Node: Exporting the classifier<4>2312927
Ref: libraries/linear_svm_classifier exporting-the-classifier2313050
Ref: ef02313050
Node: Classifier representation<6>2313434
Ref: libraries/linear_svm_classifier classifier-representation2313581
Ref: ef12313581
Node: References<33>2314308
Ref: libraries/linear_svm_classifier references2314437
Ref: ef22314437
Node: listing2314765
Ref: libraries/listing doc2314897
Ref: ef32314897
Ref: libraries/listing library-listing2314897
Ref: ef42314897
Ref: libraries/listing listing2314897
Ref: ef52314897
Node: API documentation<146>2315248
Ref: libraries/listing api-documentation2315355
Ref: ef62315355
Node: Loading<148>2315485
Ref: libraries/listing loading2315613
Ref: ef72315613
Node: Testing<140>2315767
Ref: libraries/listing testing2315882
Ref: ef82315882
Node: Usage<64>2316023
Ref: libraries/listing usage2316117
Ref: ef92316117
Node: lof_anomaly_detector2318213
Ref: libraries/lof_anomaly_detector doc2318331
Ref: efa2318331
Ref: libraries/lof_anomaly_detector library-lof-anomaly-detector2318331
Ref: efb2318331
Ref: libraries/lof_anomaly_detector lof-anomaly-detector2318331
Ref: efc2318331
Node: API documentation<147>2319558
Ref: libraries/lof_anomaly_detector api-documentation2319678
Ref: efd2319678
Node: Loading<149>2319821
Ref: libraries/lof_anomaly_detector loading2319962
Ref: efe2319962
Node: Testing<141>2320105
Ref: libraries/lof_anomaly_detector testing2320236
Ref: eff2320236
Node: Features<48>2320390
Ref: libraries/lof_anomaly_detector features2320520
Ref: f002320520
Node: Options<47>2321767
Ref: libraries/lof_anomaly_detector options2321911
Ref: f012321911
Node: Detector representation<6>2322642
Ref: libraries/lof_anomaly_detector detector-representation2322788
Ref: f022322788
Node: References<34>2324374
Ref: libraries/lof_anomaly_detector references2324500
Ref: f032324500
Node: logging2324678
Ref: libraries/logging doc2324819
Ref: f042324819
Ref: libraries/logging library-logging2324819
Ref: f052324819
Ref: libraries/logging logging2324819
Ref: f062324819
Node: API documentation<148>2324996
Ref: libraries/logging api-documentation2325103
Ref: f072325103
Node: Loading<150>2325233
Ref: libraries/logging loading2325340
Ref: f082325340
Node: logistic_regression_classifier2325494
Ref: libraries/logistic_regression_classifier doc2325620
Ref: f092325620
Ref: libraries/logistic_regression_classifier library-logistic-regression-classifier2325620
Ref: f0a2325620
Ref: libraries/logistic_regression_classifier logistic-regression-classifier2325620
Ref: f0b2325620
Node: API documentation<149>2326863
Ref: libraries/logistic_regression_classifier api-documentation2326993
Ref: f0c2326993
Node: Loading<151>2327146
Ref: libraries/logistic_regression_classifier loading2327297
Ref: f0d2327297
Node: Testing<142>2327450
Ref: libraries/logistic_regression_classifier testing2327591
Ref: f0e2327591
Node: Features<49>2327917
Ref: libraries/logistic_regression_classifier features2328057
Ref: f0f2328057
Node: Options<48>2329447
Ref: libraries/logistic_regression_classifier options2329584
Ref: f102329584
Node: Usage<65>2330063
Ref: libraries/logistic_regression_classifier usage2330216
Ref: f112330216
Node: Learning a classifier<5>2330408
Ref: libraries/logistic_regression_classifier learning-a-classifier2330528
Ref: f122330528
Node: Making predictions<5>2330787
Ref: libraries/logistic_regression_classifier making-predictions2330943
Ref: f132330943
Node: Exporting the classifier<5>2331435
Ref: libraries/logistic_regression_classifier exporting-the-classifier2331558
Ref: f142331558
Node: Classifier representation<7>2331978
Ref: libraries/logistic_regression_classifier classifier-representation2332134
Ref: f152332134
Node: References<35>2332853
Ref: libraries/logistic_regression_classifier references2332991
Ref: f162332991
Node: loops2333345
Ref: libraries/loops doc2333477
Ref: f172333477
Ref: libraries/loops library-loops2333477
Ref: f182333477
Ref: libraries/loops loops2333477
Ref: f192333477
Node: API documentation<150>2333733
Ref: libraries/loops api-documentation2333838
Ref: f1a2333838
Node: Loading<152>2333966
Ref: libraries/loops loading2334092
Ref: f1b2334092
Node: Testing<143>2334241
Ref: libraries/loops testing2334354
Ref: f1c2334354
Node: Usage<66>2334493
Ref: libraries/loops usage2334585
Ref: f1d2334585
Node: massey_ranker2334654
Ref: libraries/massey_ranker doc2334766
Ref: f1e2334766
Ref: libraries/massey_ranker library-massey-ranker2334766
Ref: f1f2334766
Ref: libraries/massey_ranker massey-ranker2334766
Ref: f202334766
Node: API documentation<151>2336076
Ref: libraries/massey_ranker api-documentation2336189
Ref: f212336189
Node: Loading<153>2336325
Ref: libraries/massey_ranker loading2336459
Ref: f222336459
Node: Testing<144>2336595
Ref: libraries/massey_ranker testing2336719
Ref: f232336719
Node: Features<50>2336866
Ref: libraries/massey_ranker features2336998
Ref: f242336998
Node: Scoring semantics<6>2338252
Ref: libraries/massey_ranker scoring-semantics2338381
Ref: f252338381
Node: Usage<67>2339286
Ref: libraries/massey_ranker usage2339425
Ref: f262339425
Node: Learning a ranker<10>2339665
Ref: libraries/massey_ranker learning-a-ranker2339786
Ref: f272339786
Node: Inspecting diagnostics<8>2340186
Ref: libraries/massey_ranker inspecting-diagnostics2340342
Ref: f282340342
Node: Ranking candidate items<9>2340605
Ref: libraries/massey_ranker ranking-candidate-items2340763
Ref: f292340763
Node: Exporting the ranker<8>2341294
Ref: libraries/massey_ranker exporting-the-ranker2341418
Ref: f2a2341418
Node: Diagnostics syntax<16>2341962
Ref: libraries/massey_ranker diagnostics-syntax2342106
Ref: f2b2342106
Node: Ranker representation<10>2342358
Ref: libraries/massey_ranker ranker-representation2342507
Ref: f2c2342507
Node: References<36>2342894
Ref: libraries/massey_ranker references2343012
Ref: f2d2343012
Node: mcp_server2343142
Ref: libraries/mcp_server doc2343258
Ref: f2e2343258
Ref: libraries/mcp_server library-mcp-server2343258
Ref: f2f2343258
Ref: libraries/mcp_server mcp-server2343258
Ref: f302343258
Node: API documentation<152>2343941
Ref: libraries/mcp_server api-documentation2344051
Ref: f312344051
Node: Loading<154>2344184
Ref: libraries/mcp_server loading2344315
Ref: f322344315
Node: Testing<145>2344448
Ref: libraries/mcp_server testing2344566
Ref: f332344566
Node: Usage<68>2344710
Ref: libraries/mcp_server usage2344833
Ref: f342344833
Node: Implementing the tool protocol2345309
Ref: libraries/mcp_server implementing-the-tool-protocol2345449
Ref: f352345449
Node: Auto-dispatch vs custom tool_call/32347697
Ref: libraries/mcp_server auto-dispatch-vs-custom-tool-call-32347883
Ref: f362347883
Ref: libraries/mcp_server auto-dispatch-vs-custom-tool-call32347883
Ref: f372347883
Node: Output schemas structured tool output2349172
Ref: libraries/mcp_server output-schemas-structured-tool-output2349361
Ref: f382349361
Node: Starting the server for debugging2349967
Ref: libraries/mcp_server starting-the-server-for-debugging2350145
Ref: f392350145
Node: MCP client configuration2350643
Ref: libraries/mcp_server mcp-client-configuration2350813
Ref: f3a2350813
Node: Elicitation interactive tools2352345
Ref: libraries/mcp_server elicitation-interactive-tools2352506
Ref: f3b2352506
Node: Prompts prompt templates2354629
Ref: libraries/mcp_server prompts-prompt-templates2354789
Ref: f3c2354789
Node: Resources data exposure2357821
Ref: libraries/mcp_server resources-data-exposure2357943
Ref: f3d2357943
Node: Error handling<3>2360421
Ref: libraries/mcp_server error-handling2360540
Ref: f3e2360540
Node: Protocol2360922
Ref: libraries/mcp_server protocol2361053
Ref: f3f2361053
Node: Supported MCP methods2362336
Ref: libraries/mcp_server supported-mcp-methods2362441
Ref: f402362441
Node: memcached2363841
Ref: libraries/memcached doc2363956
Ref: f412363956
Ref: libraries/memcached library-memcached2363956
Ref: f422363956
Ref: libraries/memcached memcached2363956
Ref: f432363956
Node: API documentation<153>2364526
Ref: libraries/memcached api-documentation2364635
Ref: f442364635
Node: Loading<155>2364767
Ref: libraries/memcached loading2364897
Ref: f452364897
Node: Testing<146>2365029
Ref: libraries/memcached testing2365153
Ref: f462365153
Node: Protocol Version2365692
Ref: libraries/memcached protocol-version2365816
Ref: f472365816
Node: Features<51>2366202
Ref: libraries/memcached features2366323
Ref: f482366323
Node: Usage<69>2366913
Ref: libraries/memcached usage2367032
Ref: f492367032
Node: Connecting to a Memcached server2367314
Ref: libraries/memcached connecting-to-a-memcached-server2367433
Ref: f4a2367433
Node: Storing data2367742
Ref: libraries/memcached storing-data2367885
Ref: f4b2367885
Node: Retrieving data2368548
Ref: libraries/memcached retrieving-data2368676
Ref: f4c2368676
Node: Check-and-Set CAS2369097
Ref: libraries/memcached check-and-set-cas2369226
Ref: f4d2369226
Node: Deleting data2369656
Ref: libraries/memcached deleting-data2369789
Ref: f4e2369789
Node: Increment/Decrement2369944
Ref: libraries/memcached increment-decrement2370083
Ref: f4f2370083
Node: Touch and Get-and-Touch2370572
Ref: libraries/memcached touch-and-get-and-touch2370715
Ref: f502370715
Node: Server management2371098
Ref: libraries/memcached server-management2371238
Ref: f512371238
Node: Disconnecting<2>2371678
Ref: libraries/memcached disconnecting2371786
Ref: f522371786
Node: API Summary<2>2371879
Ref: libraries/memcached api-summary2372003
Ref: f532372003
Node: Connection management2372214
Ref: libraries/memcached connection-management2372331
Ref: f542372331
Node: Storage commands2372600
Ref: libraries/memcached storage-commands2372744
Ref: f552372744
Node: Retrieval commands2373403
Ref: libraries/memcached retrieval-commands2373534
Ref: f562373534
Node: Deletion2373949
Ref: libraries/memcached deletion2374086
Ref: f572374086
Node: Increment/Decrement<2>2374177
Ref: libraries/memcached id12374301
Ref: f582374301
Ref: libraries/memcached incrementdecrement-12374301
Ref: f592374301
Node: Touch2374498
Ref: libraries/memcached touch2374629
Ref: f5a2374629
Node: Server commands2374894
Ref: libraries/memcached server-commands2374994
Ref: f5b2374994
Node: Error Handling<2>2375387
Ref: libraries/memcached error-handling2375512
Ref: f5c2375512
Node: Key Format2376239
Ref: libraries/memcached key-format2376366
Ref: f5d2376366
Node: Expiration Times2376538
Ref: libraries/memcached expiration-times2376639
Ref: f5e2376639
Node: message_pack2376949
Ref: libraries/message_pack doc2377058
Ref: f5f2377058
Ref: libraries/message_pack library-message-pack2377058
Ref: f602377058
Ref: libraries/message_pack message-pack2377058
Ref: f612377058
Ref: message_pack-Footnote-12377733
Node: API documentation<154>2377762
Ref: libraries/message_pack api-documentation2377874
Ref: f622377874
Node: Loading<156>2378009
Ref: libraries/message_pack loading2378142
Ref: f632378142
Node: Testing<147>2378293
Ref: libraries/message_pack testing2378422
Ref: f642378422
Node: Representation<15>2378568
Ref: libraries/message_pack representation2378693
Ref: f652378693
Node: Notes<9>2380953
Ref: libraries/message_pack notes2381057
Ref: f662381057
Node: meta2382360
Ref: libraries/meta doc2382473
Ref: f672382473
Ref: libraries/meta library-meta2382473
Ref: f682382473
Ref: libraries/meta meta2382473
Ref: f692382473
Node: API documentation<155>2382897
Ref: libraries/meta api-documentation2383001
Ref: f6a2383001
Node: Loading<157>2383128
Ref: libraries/meta loading2383253
Ref: f6b2383253
Node: Testing<148>2383401
Ref: libraries/meta testing2383513
Ref: f6c2383513
Node: Usage<70>2383651
Ref: libraries/meta usage2383742
Ref: f6d2383742
Node: meta_compiler2383831
Ref: libraries/meta_compiler doc2383942
Ref: f6e2383942
Ref: libraries/meta_compiler library-meta-compiler2383942
Ref: 36a2383942
Ref: libraries/meta_compiler meta-compiler2383942
Ref: f6f2383942
Node: API documentation<156>2384279
Ref: libraries/meta_compiler api-documentation2384392
Ref: f702384392
Node: Loading<158>2384528
Ref: libraries/meta_compiler loading2384662
Ref: f712384662
Node: Testing<149>2384819
Ref: libraries/meta_compiler testing2384940
Ref: f722384940
Node: Usage<71>2385087
Ref: libraries/meta_compiler usage2385212
Ref: f732385212
Node: Known issues<15>2385834
Ref: libraries/meta_compiler known-issues2385938
Ref: f742385938
Node: mime_types2386097
Ref: libraries/mime_types doc2386237
Ref: f752386237
Ref: libraries/mime_types library-mime-types2386237
Ref: f762386237
Ref: libraries/mime_types mime-types2386237
Ref: f772386237
Node: API documentation<157>2387172
Ref: libraries/mime_types api-documentation2387282
Ref: f782387282
Node: Loading<159>2387415
Ref: libraries/mime_types loading2387546
Ref: f792387546
Node: Testing<150>2387695
Ref: libraries/mime_types testing2387813
Ref: f7a2387813
Node: Usage<72>2387957
Ref: libraries/mime_types usage2388054
Ref: f7b2388054
Node: modified_z_score_anomaly_detector2388677
Ref: libraries/modified_z_score_anomaly_detector doc2388813
Ref: f7c2388813
Ref: libraries/modified_z_score_anomaly_detector library-modified-z-score-anomaly-detector2388813
Ref: f7d2388813
Ref: libraries/modified_z_score_anomaly_detector modified-z-score-anomaly-detector2388813
Ref: f7e2388813
Node: API documentation<158>2390172
Ref: libraries/modified_z_score_anomaly_detector api-documentation2390305
Ref: f7f2390305
Node: Loading<160>2390444
Ref: libraries/modified_z_score_anomaly_detector loading2390598
Ref: f802390598
Node: Testing<151>2390754
Ref: libraries/modified_z_score_anomaly_detector testing2390898
Ref: f812390898
Node: Features<52>2391065
Ref: libraries/modified_z_score_anomaly_detector features2391208
Ref: f822391208
Node: Options<49>2394746
Ref: libraries/modified_z_score_anomaly_detector options2394903
Ref: f832394903
Node: Detector representation<7>2395787
Ref: libraries/modified_z_score_anomaly_detector detector-representation2395941
Ref: f842395941
Node: Notes<10>2396725
Ref: libraries/modified_z_score_anomaly_detector notes2396859
Ref: f852396859
Node: mutations2398789
Ref: libraries/mutations doc2398924
Ref: f862398924
Ref: libraries/mutations library-mutations2398924
Ref: f872398924
Ref: libraries/mutations mutations2398924
Ref: f882398924
Node: API documentation<159>2399982
Ref: libraries/mutations api-documentation2400091
Ref: f892400091
Node: Loading<161>2400223
Ref: libraries/mutations loading2400353
Ref: f8a2400353
Node: Testing<152>2400501
Ref: libraries/mutations testing2400618
Ref: f8b2400618
Node: Usage<73>2400761
Ref: libraries/mutations usage2400857
Ref: f8c2400857
Node: multisets2401848
Ref: libraries/multisets doc2401956
Ref: f8d2401956
Ref: libraries/multisets library-multisets2401956
Ref: f8e2401956
Ref: libraries/multisets multisets2401956
Ref: f8f2401956
Node: API documentation<160>2403352
Ref: libraries/multisets api-documentation2403461
Ref: f902403461
Node: Loading<162>2403593
Ref: libraries/multisets loading2403723
Ref: f912403723
Node: Testing<153>2403871
Ref: libraries/multisets testing2403970
Ref: f922403970
Node: nanoid2404113
Ref: libraries/nanoid doc2404234
Ref: f932404234
Ref: libraries/nanoid library-nanoid2404234
Ref: f942404234
Ref: libraries/nanoid nanoid2404234
Ref: f952404234
Node: API documentation<161>2405127
Ref: libraries/nanoid api-documentation2405233
Ref: f962405233
Node: Loading<163>2405362
Ref: libraries/nanoid loading2405489
Ref: f972405489
Node: Testing<154>2405634
Ref: libraries/nanoid testing2405748
Ref: f982405748
Node: Usage<74>2405888
Ref: libraries/nanoid usage2405981
Ref: f992405981
Node: naive_bayes_classifier2406656
Ref: libraries/naive_bayes_classifier doc2406795
Ref: f9a2406795
Ref: libraries/naive_bayes_classifier library-naive-bayes-classifier2406795
Ref: f9b2406795
Ref: libraries/naive_bayes_classifier naive-bayes-classifier2406795
Ref: f9c2406795
Node: API documentation<162>2407765
Ref: libraries/naive_bayes_classifier api-documentation2407887
Ref: f9d2407887
Node: Loading<164>2408032
Ref: libraries/naive_bayes_classifier loading2408175
Ref: f9e2408175
Node: Testing<155>2408320
Ref: libraries/naive_bayes_classifier testing2408453
Ref: f9f2408453
Node: Features<53>2408609
Ref: libraries/naive_bayes_classifier features2408739
Ref: fa02408739
Node: Usage<75>2409144
Ref: libraries/naive_bayes_classifier usage2409290
Ref: fa12409290
Node: Learning a Classifier<3>2409543
Ref: libraries/naive_bayes_classifier learning-a-classifier2409663
Ref: fa22409663
Node: Making Predictions<3>2409838
Ref: libraries/naive_bayes_classifier making-predictions2409994
Ref: fa32409994
Node: Exporting the Classifier<3>2410456
Ref: libraries/naive_bayes_classifier exporting-the-classifier2410617
Ref: fa42410617
Node: Using a learned classifier<2>2411202
Ref: libraries/naive_bayes_classifier using-a-learned-classifier2411333
Ref: fa52411333
Node: Classifier representation<8>2411781
Ref: libraries/naive_bayes_classifier classifier-representation2411929
Ref: fa62411929
Node: References<37>2412709
Ref: libraries/naive_bayes_classifier references2412839
Ref: fa72412839
Node: nearest_centroid_classifier2413146
Ref: libraries/nearest_centroid_classifier doc2413298
Ref: fa82413298
Ref: libraries/nearest_centroid_classifier library-nearest-centroid-classifier2413298
Ref: fa92413298
Ref: libraries/nearest_centroid_classifier nearest-centroid-classifier2413298
Ref: faa2413298
Node: API documentation<163>2414225
Ref: libraries/nearest_centroid_classifier api-documentation2414352
Ref: fab2414352
Node: Loading<165>2414502
Ref: libraries/nearest_centroid_classifier loading2414650
Ref: fac2414650
Node: Testing<156>2414800
Ref: libraries/nearest_centroid_classifier testing2414938
Ref: fad2414938
Node: Features<54>2415099
Ref: libraries/nearest_centroid_classifier features2415234
Ref: fae2415234
Node: Usage<76>2415656
Ref: libraries/nearest_centroid_classifier usage2415790
Ref: faf2415790
Node: Learning a Classifier<4>2416043
Ref: libraries/nearest_centroid_classifier learning-a-classifier2416163
Ref: fb02416163
Node: Making Predictions<4>2416528
Ref: libraries/nearest_centroid_classifier making-predictions2416684
Ref: fb12416684
Node: Exporting the Classifier<4>2417382
Ref: libraries/nearest_centroid_classifier exporting-the-classifier2417543
Ref: fb22417543
Node: Using a learned classifier<3>2418172
Ref: libraries/nearest_centroid_classifier using-a-learned-classifier2418303
Ref: fb32418303
Node: Options<50>2418829
Ref: libraries/nearest_centroid_classifier options2418979
Ref: fb42418979
Node: Classifier representation<9>2419251
Ref: libraries/nearest_centroid_classifier classifier-representation2419406
Ref: fb52419406
Node: References<38>2420042
Ref: libraries/nearest_centroid_classifier references2420177
Ref: fb62420177
Node: nested_dictionaries2420715
Ref: libraries/nested_dictionaries doc2420872
Ref: fb72420872
Ref: libraries/nested_dictionaries library-nested-dictionaries2420872
Ref: fb82420872
Ref: libraries/nested_dictionaries nested-dictionaries2420872
Ref: fb92420872
Node: API documentation<164>2421450
Ref: libraries/nested_dictionaries api-documentation2421569
Ref: fba2421569
Node: Loading<166>2421711
Ref: libraries/nested_dictionaries loading2421851
Ref: fbb2421851
Node: Testing<157>2422009
Ref: libraries/nested_dictionaries testing2422136
Ref: fbc2422136
Node: Usage<77>2422289
Ref: libraries/nested_dictionaries usage2422429
Ref: fbd2422429
Node: Curly term representation2424135
Ref: libraries/nested_dictionaries curly-term-representation2424254
Ref: fbe2424254
Ref: libraries/nmea library-nmea2424837
Ref: fbf2424837
Node: Raw Sentence Representation2424937
Ref: libraries/nmea doc2425087
Ref: fc02425087
Ref: libraries/nmea raw-sentence-representation2425087
Ref: fc12425087
Node: Typed data/2 Results2425801
Ref: libraries/nmea typed-data-2-results2425941
Ref: fc22425941
Node: Date Rule2427027
Ref: libraries/nmea date-rule2427153
Ref: fc32427153
Node: Current Scope2427340
Ref: libraries/nmea current-scope2427460
Ref: fc42427460
Node: nmf_projection2428030
Ref: libraries/nmf_projection doc2428157
Ref: fc52428157
Ref: libraries/nmf_projection library-nmf-projection2428157
Ref: fc62428157
Ref: libraries/nmf_projection nmf-projection2428157
Ref: fc72428157
Node: API documentation<165>2428781
Ref: libraries/nmf_projection api-documentation2428895
Ref: fc82428895
Node: Loading<167>2429032
Ref: libraries/nmf_projection loading2429167
Ref: fc92429167
Node: Testing<158>2429320
Ref: libraries/nmf_projection testing2429445
Ref: fca2429445
Node: Features<55>2429593
Ref: libraries/nmf_projection features2429717
Ref: fcb2429717
Node: Options<51>2430112
Ref: libraries/nmf_projection options2430233
Ref: fcc2430233
Node: Usage<78>2431175
Ref: libraries/nmf_projection usage2431319
Ref: fcd2431319
Node: Dimension reducer representation<4>2432280
Ref: libraries/nmf_projection dimension-reducer-representation2432427
Ref: fce2432427
Node: References<39>2432859
Ref: libraries/nmf_projection references2432988
Ref: fcf2432988
Node: optics_clusterer2433195
Ref: libraries/optics_clusterer doc2433318
Ref: fd02433318
Ref: libraries/optics_clusterer library-optics-clusterer2433318
Ref: fd12433318
Ref: libraries/optics_clusterer optics-clusterer2433318
Ref: fd22433318
Node: API documentation<166>2434182
Ref: libraries/optics_clusterer api-documentation2434298
Ref: fd32434298
Node: Loading<168>2434437
Ref: libraries/optics_clusterer loading2434574
Ref: fd42434574
Node: Testing<159>2434713
Ref: libraries/optics_clusterer testing2434840
Ref: fd52434840
Node: Features<56>2435138
Ref: libraries/optics_clusterer features2435264
Ref: fd62435264
Node: Options<52>2436524
Ref: libraries/optics_clusterer options2436666
Ref: fd72436666
Node: Clusterer representation<12>2437924
Ref: libraries/optics_clusterer clusterer-representation2438045
Ref: fd82438045
Node: optionals2438751
Ref: libraries/optionals doc2438867
Ref: fd92438867
Ref: libraries/optionals library-optionals2438867
Ref: fda2438867
Ref: libraries/optionals optionals2438867
Ref: fdb2438867
Node: API documentation<167>2439766
Ref: libraries/optionals api-documentation2439875
Ref: fdc2439875
Node: Loading<169>2440007
Ref: libraries/optionals loading2440137
Ref: fdd2440137
Node: Testing<160>2440285
Ref: libraries/optionals testing2440402
Ref: fde2440402
Node: Usage<79>2440545
Ref: libraries/optionals usage2440661
Ref: fdf2440661
Node: See also<3>2444174
Ref: libraries/optionals see-also2444269
Ref: fe02444269
Node: options2444358
Ref: libraries/options doc2444460
Ref: fe12444460
Ref: libraries/options library-options2444460
Ref: fe22444460
Ref: libraries/options options2444460
Ref: fe32444460
Node: API documentation<168>2444716
Ref: libraries/options api-documentation2444823
Ref: fe42444823
Node: Loading<170>2444953
Ref: libraries/options loading2445081
Ref: fe52445081
Node: Testing<161>2445235
Ref: libraries/options testing2445350
Ref: fe62445350
Node: Usage<80>2445491
Ref: libraries/options usage2445585
Ref: fe72445585
Node: os2447575
Ref: libraries/os doc2447678
Ref: fe82447678
Ref: libraries/os library-os2447678
Ref: fe92447678
Ref: libraries/os os2447678
Ref: fea2447678
Node: API documentation<169>2448088
Ref: libraries/os api-documentation2448190
Ref: feb2448190
Node: Loading<171>2448315
Ref: libraries/os loading2448438
Ref: fec2448438
Node: Testing<162>2448579
Ref: libraries/os testing2448696
Ref: fed2448696
Node: Known issues<16>2448832
Ref: libraries/os known-issues2448928
Ref: fee2448928
Node: partitions2449342
Ref: libraries/partitions doc2449462
Ref: fef2449462
Ref: libraries/partitions library-partitions2449462
Ref: ff02449462
Ref: libraries/partitions partitions2449462
Ref: ff12449462
Node: API documentation<170>2451694
Ref: libraries/partitions api-documentation2451804
Ref: ff22451804
Node: Loading<172>2451937
Ref: libraries/partitions loading2452068
Ref: ff32452068
Node: Testing<163>2452217
Ref: libraries/partitions testing2452317
Ref: ff42452317
Node: pattern_mining_protocols2452461
Ref: libraries/pattern_mining_protocols doc2452593
Ref: ff52452593
Ref: libraries/pattern_mining_protocols library-pattern-mining-protocols2452593
Ref: ff62452593
Ref: libraries/pattern_mining_protocols pattern-mining-protocols2452593
Ref: ff72452593
Node: API documentation<171>2453435
Ref: libraries/pattern_mining_protocols api-documentation2453559
Ref: ff82453559
Node: Loading<173>2453706
Ref: libraries/pattern_mining_protocols loading2453851
Ref: ff92453851
Node: Testing<164>2454014
Ref: libraries/pattern_mining_protocols testing2454154
Ref: ffa2454154
Node: Common options<2>2454311
Ref: libraries/pattern_mining_protocols common-options2454453
Ref: ffb2454453
Node: Diagnostics<9>2455408
Ref: libraries/pattern_mining_protocols diagnostics2455563
Ref: ffc2455563
Node: Related support libraries2456364
Ref: libraries/pattern_mining_protocols related-support-libraries2456493
Ref: ffd2456493
Node: pca_projection2456936
Ref: libraries/pca_projection doc2457070
Ref: ffe2457070
Ref: libraries/pca_projection library-pca-projection2457070
Ref: fff2457070
Ref: libraries/pca_projection pca-projection2457070
Ref: 10002457070
Node: API documentation<172>2457814
Ref: libraries/pca_projection api-documentation2457928
Ref: 10012457928
Node: Loading<174>2458065
Ref: libraries/pca_projection loading2458200
Ref: 10022458200
Node: Testing<165>2458337
Ref: libraries/pca_projection testing2458462
Ref: 10032458462
Node: Features<57>2458610
Ref: libraries/pca_projection features2458734
Ref: 10042458734
Node: Options<53>2459415
Ref: libraries/pca_projection options2459536
Ref: 10052459536
Node: Usage<81>2460362
Ref: libraries/pca_projection usage2460506
Ref: 10062460506
Node: Learning a reducer<4>2461028
Ref: libraries/pca_projection learning-a-reducer2461153
Ref: 10072461153
Node: Transforming new instances<4>2461439
Ref: libraries/pca_projection transforming-new-instances2461609
Ref: 10082461609
Node: Exporting and reusing the reducer<4>2462073
Ref: libraries/pca_projection exporting-and-reusing-the-reducer2462213
Ref: 10092462213
Node: Dimension reducer representation<5>2462653
Ref: libraries/pca_projection dimension-reducer-representation2462800
Ref: 100a2462800
Node: References<40>2463749
Ref: libraries/pca_projection references2463878
Ref: 100b2463878
Node: permutations2464135
Ref: libraries/permutations doc2464265
Ref: 100c2464265
Ref: libraries/permutations library-permutations2464265
Ref: 100d2464265
Ref: libraries/permutations permutations2464265
Ref: 100e2464265
Node: API documentation<173>2465714
Ref: libraries/permutations api-documentation2465826
Ref: 100f2465826
Node: Loading<175>2465961
Ref: libraries/permutations loading2466094
Ref: 10102466094
Node: Testing<166>2466245
Ref: libraries/permutations testing2466347
Ref: 10112466347
Node: plackett_luce_ranker2466493
Ref: libraries/plackett_luce_ranker doc2466634
Ref: 10122466634
Ref: libraries/plackett_luce_ranker library-plackett-luce-ranker2466634
Ref: 10132466634
Ref: libraries/plackett_luce_ranker plackett-luce-ranker2466634
Ref: 10142466634
Node: API documentation<174>2468044
Ref: libraries/plackett_luce_ranker api-documentation2468164
Ref: 10152468164
Node: Loading<176>2468307
Ref: libraries/plackett_luce_ranker loading2468448
Ref: 10162468448
Node: Testing<167>2468591
Ref: libraries/plackett_luce_ranker testing2468722
Ref: 10172468722
Node: Features<58>2468876
Ref: libraries/plackett_luce_ranker features2469018
Ref: 10182469018
Node: Dataset requirements<2>2470690
Ref: libraries/plackett_luce_ranker dataset-requirements2470829
Ref: 10192470829
Node: Usage<82>2471452
Ref: libraries/plackett_luce_ranker usage2471601
Ref: 101a2471601
Node: Learning a ranker<11>2471737
Ref: libraries/plackett_luce_ranker learning-a-ranker2471858
Ref: 101b2471858
Node: Inspecting diagnostics<9>2472241
Ref: libraries/plackett_luce_ranker inspecting-diagnostics2472362
Ref: 101c2472362
Node: Diagnostics syntax<17>2472645
Ref: libraries/plackett_luce_ranker diagnostics-syntax2472782
Ref: 101d2472782
Node: Ranking candidate items<10>2474136
Ref: libraries/plackett_luce_ranker ranking-candidate-items2474274
Ref: 101e2474274
Node: Exporting the ranker<9>2474819
Ref: libraries/plackett_luce_ranker exporting-the-ranker2474957
Ref: 101f2474957
Node: Options<54>2475536
Ref: libraries/plackett_luce_ranker options2475689
Ref: 10202475689
Node: Ranker representation<11>2476075
Ref: libraries/plackett_luce_ranker ranker-representation2476217
Ref: 10212476217
Node: See also<4>2476918
Ref: libraries/plackett_luce_ranker see-also2477040
Ref: 10222477040
Node: plackett_luce_last_ranker2477209
Ref: libraries/plackett_luce_last_ranker doc2477352
Ref: 10232477352
Ref: libraries/plackett_luce_last_ranker library-plackett-luce-last-ranker2477352
Ref: 10242477352
Ref: libraries/plackett_luce_last_ranker plackett-luce-last-ranker2477352
Ref: 10252477352
Node: API documentation<175>2478815
Ref: libraries/plackett_luce_last_ranker api-documentation2478940
Ref: 10262478940
Node: Loading<177>2479088
Ref: libraries/plackett_luce_last_ranker loading2479234
Ref: 10272479234
Node: Testing<168>2479382
Ref: libraries/plackett_luce_last_ranker testing2479518
Ref: 10282479518
Node: Features<59>2479677
Ref: libraries/plackett_luce_last_ranker features2479824
Ref: 10292479824
Node: Dataset requirements<3>2481498
Ref: libraries/plackett_luce_last_ranker dataset-requirements2481642
Ref: 102a2481642
Node: Usage<83>2482270
Ref: libraries/plackett_luce_last_ranker usage2482424
Ref: 102b2482424
Node: Learning a ranker<12>2482561
Ref: libraries/plackett_luce_last_ranker learning-a-ranker2482683
Ref: 102c2482683
Node: Inspecting diagnostics<10>2483076
Ref: libraries/plackett_luce_last_ranker inspecting-diagnostics2483198
Ref: 102d2483198
Node: Diagnostics syntax<18>2483491
Ref: libraries/plackett_luce_last_ranker diagnostics-syntax2483633
Ref: 102e2483633
Node: Ranking candidate items<11>2484998
Ref: libraries/plackett_luce_last_ranker ranking-candidate-items2485137
Ref: 102f2485137
Node: Exporting the ranker<10>2485692
Ref: libraries/plackett_luce_last_ranker exporting-the-ranker2485831
Ref: 10302485831
Node: Options<55>2486435
Ref: libraries/plackett_luce_last_ranker options2486593
Ref: 10312486593
Node: Ranker representation<12>2486979
Ref: libraries/plackett_luce_last_ranker ranker-representation2487126
Ref: 10322487126
Node: See also<5>2487832
Ref: libraries/plackett_luce_last_ranker see-also2487982
Ref: 10332487982
Node: References<41>2488277
Ref: libraries/plackett_luce_last_ranker references2488393
Ref: 10342488393
Node: pls_projection2488764
Ref: libraries/pls_projection doc2488912
Ref: 10352488912
Ref: libraries/pls_projection library-pls-projection2488912
Ref: 10362488912
Ref: libraries/pls_projection pls-projection2488912
Ref: 10372488912
Node: API documentation<176>2489920
Ref: libraries/pls_projection api-documentation2490034
Ref: 10382490034
Node: Loading<178>2490171
Ref: libraries/pls_projection loading2490306
Ref: 10392490306
Node: Testing<169>2490443
Ref: libraries/pls_projection testing2490568
Ref: 103a2490568
Node: Features<60>2490716
Ref: libraries/pls_projection features2490840
Ref: 103b2490840
Node: Options<56>2491995
Ref: libraries/pls_projection options2492116
Ref: 103c2492116
Node: Usage<84>2493251
Ref: libraries/pls_projection usage2493395
Ref: 103d2493395
Node: Learning a reducer<5>2493838
Ref: libraries/pls_projection learning-a-reducer2493963
Ref: 103e2493963
Node: Transforming new instances<5>2494225
Ref: libraries/pls_projection transforming-new-instances2494395
Ref: 103f2494395
Node: Exporting and reusing the reducer<5>2494678
Ref: libraries/pls_projection exporting-and-reusing-the-reducer2494818
Ref: 10402494818
Node: Dimension reducer representation<6>2495314
Ref: libraries/pls_projection dimension-reducer-representation2495461
Ref: 10412495461
Node: References<42>2496387
Ref: libraries/pls_projection references2496516
Ref: 10422496516
Node: prefix_span_pattern_miner2496794
Ref: libraries/prefix_span_pattern_miner doc2496945
Ref: 10432496945
Ref: libraries/prefix_span_pattern_miner library-prefix-span-pattern-miner2496945
Ref: 10442496945
Ref: libraries/prefix_span_pattern_miner prefix-span-pattern-miner2496945
Ref: 10452496945
Node: API documentation<177>2497817
Ref: libraries/prefix_span_pattern_miner api-documentation2497942
Ref: 10462497942
Node: Loading<179>2498090
Ref: libraries/prefix_span_pattern_miner loading2498236
Ref: 10472498236
Node: Testing<170>2498384
Ref: libraries/prefix_span_pattern_miner testing2498520
Ref: 10482498520
Node: Features<61>2498679
Ref: libraries/prefix_span_pattern_miner features2498814
Ref: 10492498814
Node: Options<57>2499462
Ref: libraries/prefix_span_pattern_miner options2499616
Ref: 104a2499616
Node: Pattern miner representation<6>2500309
Ref: libraries/prefix_span_pattern_miner pattern-miner-representation2500465
Ref: 104b2500465
Node: References<43>2501070
Ref: libraries/prefix_span_pattern_miner references2501206
Ref: 104c2501206
Node: probabilistic_pca_projection2501408
Ref: libraries/probabilistic_pca_projection doc2501552
Ref: 104d2501552
Ref: libraries/probabilistic_pca_projection library-probabilistic-pca-projection2501552
Ref: 104e2501552
Ref: libraries/probabilistic_pca_projection probabilistic-pca-projection2501552
Ref: 104f2501552
Node: API documentation<178>2502480
Ref: libraries/probabilistic_pca_projection api-documentation2502608
Ref: 10502502608
Node: Loading<180>2502759
Ref: libraries/probabilistic_pca_projection loading2502908
Ref: 10512502908
Node: Testing<171>2503059
Ref: libraries/probabilistic_pca_projection testing2503198
Ref: 10522503198
Node: Features<62>2503360
Ref: libraries/probabilistic_pca_projection features2503498
Ref: 10532503498
Node: Options<58>2504376
Ref: libraries/probabilistic_pca_projection options2504511
Ref: 10542504511
Node: Usage<85>2505881
Ref: libraries/probabilistic_pca_projection usage2506039
Ref: 10552506039
Node: Learning a reducer<6>2506459
Ref: libraries/probabilistic_pca_projection learning-a-reducer2506584
Ref: 10562506584
Node: Transforming new instances<6>2506879
Ref: libraries/probabilistic_pca_projection transforming-new-instances2507049
Ref: 10572507049
Node: Exporting and reusing the reducer<6>2507336
Ref: libraries/probabilistic_pca_projection exporting-and-reusing-the-reducer2507476
Ref: 10582507476
Node: Dimension reducer representation<7>2507986
Ref: libraries/probabilistic_pca_projection dimension-reducer-representation2508147
Ref: 10592508147
Node: References<44>2509491
Ref: libraries/probabilistic_pca_projection references2509634
Ref: 105a2509634
Node: process2509872
Ref: libraries/process doc2509999
Ref: 105b2509999
Ref: libraries/process library-process2509999
Ref: 105c2509999
Ref: libraries/process process2509999
Ref: 105d2509999
Node: API documentation<179>2510372
Ref: libraries/process api-documentation2510479
Ref: 105e2510479
Node: Loading<181>2510609
Ref: libraries/process loading2510737
Ref: 105f2510737
Node: Testing<172>2510883
Ref: libraries/process testing2510998
Ref: 10602510998
Node: Usage<86>2511139
Ref: libraries/process usage2511233
Ref: 10612511233
Node: protobuf2512382
Ref: libraries/protobuf doc2512495
Ref: 10622512495
Ref: libraries/protobuf library-protobuf2512495
Ref: 10632512495
Ref: libraries/protobuf protobuf2512495
Ref: 10642512495
Node: API documentation<180>2513346
Ref: libraries/protobuf api-documentation2513454
Ref: 10652513454
Node: Loading<182>2513581
Ref: libraries/protobuf loading2513710
Ref: 10662513710
Node: Testing<173>2513853
Ref: libraries/protobuf testing2513985
Ref: 10672513985
Node: Protocol Buffers Overview2514123
Ref: libraries/protobuf protocol-buffers-overview2514264
Ref: 10682514264
Node: Schema Representation2514528
Ref: libraries/protobuf schema-representation2514676
Ref: 10692514676
Node: Supported Types2515221
Ref: libraries/protobuf supported-types2515341
Ref: 106a2515341
Node: Scalar Value Types2515445
Ref: libraries/protobuf scalar-value-types2515557
Ref: 106b2515557
Node: Complex Types2516820
Ref: libraries/protobuf complex-types2516932
Ref: 106c2516932
Node: Schema Examples<2>2517067
Ref: libraries/protobuf schema-examples2517187
Ref: 106d2517187
Node: Data Representation2517769
Ref: libraries/protobuf data-representation2517903
Ref: 106e2517903
Node: Encoding<9>2518417
Ref: libraries/protobuf encoding2518541
Ref: 106f2518541
Node: Simple Value Encoding2518749
Ref: libraries/protobuf simple-value-encoding2518863
Ref: 10702518863
Node: Message Encoding2519222
Ref: libraries/protobuf message-encoding2519371
Ref: 10712519371
Node: Including Schema in Output2519825
Ref: libraries/protobuf including-schema-in-output2519944
Ref: 10722519944
Node: Decoding<9>2520365
Ref: libraries/protobuf decoding2520489
Ref: 10732520489
Node: Parsing with Schema Embedded2520711
Ref: libraries/protobuf parsing-with-schema-embedded2520841
Ref: 10742520841
Node: Parsing with Known Schema2521194
Ref: libraries/protobuf parsing-with-known-schema2521363
Ref: 10752521363
Node: Parsing from Different Sources2521795
Ref: libraries/protobuf parsing-from-different-sources2521927
Ref: 10762521927
Node: Wire Format Details2522214
Ref: libraries/protobuf wire-format-details2522354
Ref: 10772522354
Node: Binary Format Compatibility2522903
Ref: libraries/protobuf binary-format-compatibility2523055
Ref: 10782523055
Node: Examples and Test Files2523558
Ref: libraries/protobuf examples-and-test-files2523706
Ref: 10792523706
Node: person proto2524006
Ref: libraries/protobuf person-proto2524124
Ref: 107a2524124
Ref: libraries/protobuf personproto2524124
Ref: 107b2524124
Node: addressbook proto2524498
Ref: libraries/protobuf addressbook-proto2524651
Ref: 107c2524651
Ref: libraries/protobuf addressbookproto2524651
Ref: 107d2524651
Node: Performance Considerations2524987
Ref: libraries/protobuf performance-considerations2525119
Ref: 107e2525119
Node: Further Reading2525620
Ref: libraries/protobuf further-reading2525732
Ref: 107f2525732
Node: qda_classifier2526059
Ref: libraries/qda_classifier doc2526171
Ref: 10802526171
Ref: libraries/qda_classifier library-qda-classifier2526171
Ref: 10812526171
Ref: libraries/qda_classifier qda-classifier2526171
Ref: 10822526171
Node: API documentation<181>2527248
Ref: libraries/qda_classifier api-documentation2527362
Ref: 10832527362
Node: Loading<183>2527499
Ref: libraries/qda_classifier loading2527634
Ref: 10842527634
Node: Testing<174>2527771
Ref: libraries/qda_classifier testing2527896
Ref: 10852527896
Node: Features<63>2528044
Ref: libraries/qda_classifier features2528168
Ref: 10862528168
Node: Options<59>2528859
Ref: libraries/qda_classifier options2528980
Ref: 10872528980
Node: Usage<87>2529325
Ref: libraries/qda_classifier usage2529463
Ref: 10882529463
Node: Learning a classifier<6>2529655
Ref: libraries/qda_classifier learning-a-classifier2529775
Ref: 10892529775
Node: Making predictions<6>2529982
Ref: libraries/qda_classifier making-predictions2530138
Ref: 108a2530138
Node: Exporting the classifier<6>2530573
Ref: libraries/qda_classifier exporting-the-classifier2530696
Ref: 108b2530696
Node: Classifier representation<10>2531064
Ref: libraries/qda_classifier classifier-representation2531205
Ref: 108c2531205
Node: References<45>2531920
Ref: libraries/qda_classifier references2532043
Ref: 108d2532043
Node: queues2532399
Ref: libraries/queues doc2532509
Ref: 108e2532509
Ref: libraries/queues library-queues2532509
Ref: 108f2532509
Ref: libraries/queues queues2532509
Ref: 10902532509
Node: API documentation<182>2532813
Ref: libraries/queues api-documentation2532919
Ref: 10912532919
Node: Loading<184>2533048
Ref: libraries/queues loading2533175
Ref: 10922533175
Node: Testing<175>2533320
Ref: libraries/queues testing2533434
Ref: 10932533434
Node: Usage<88>2533574
Ref: libraries/queues usage2533667
Ref: 10942533667
Node: random2534508
Ref: libraries/random doc2534628
Ref: 10952534628
Ref: libraries/random library-random2534628
Ref: 10962534628
Ref: libraries/random random2534628
Ref: 10972534628
Node: API documentation<183>2535332
Ref: libraries/random api-documentation2535438
Ref: 10982535438
Node: Loading<185>2535567
Ref: libraries/random loading2535694
Ref: 10992535694
Node: Testing<176>2535839
Ref: libraries/random testing2535954
Ref: 109a2535954
Node: Algorithms2536094
Ref: libraries/random algorithms2536206
Ref: 109b2536206
Node: Usage<89>2537705
Ref: libraries/random usage2537796
Ref: 109c2537796
Node: random_forest_classifier2540435
Ref: libraries/random_forest_classifier doc2540573
Ref: 109d2540573
Ref: libraries/random_forest_classifier library-random-forest-classifier2540573
Ref: 109e2540573
Ref: libraries/random_forest_classifier random-forest-classifier2540573
Ref: 109f2540573
Node: API documentation<184>2541614
Ref: libraries/random_forest_classifier api-documentation2541738
Ref: 10a02541738
Node: Loading<186>2541885
Ref: libraries/random_forest_classifier loading2542030
Ref: 10a12542030
Node: Testing<177>2542193
Ref: libraries/random_forest_classifier testing2542328
Ref: 10a22542328
Node: Features<64>2542486
Ref: libraries/random_forest_classifier features2542620
Ref: 10a32542620
Node: Options<60>2543546
Ref: libraries/random_forest_classifier options2543697
Ref: 10a42543697
Node: Classifier representation<11>2544340
Ref: libraries/random_forest_classifier classifier-representation2544493
Ref: 10a52544493
Node: References<46>2545094
Ref: libraries/random_forest_classifier references2545245
Ref: 10a62545245
Node: Usage<90>2545611
Ref: libraries/random_forest_classifier usage2545724
Ref: 10a72545724
Node: Learning a Classifier<5>2546028
Ref: libraries/random_forest_classifier learning-a-classifier2546148
Ref: 10a82546148
Node: Making Predictions<5>2546533
Ref: libraries/random_forest_classifier making-predictions2546689
Ref: 10a92546689
Node: Exporting the Classifier<5>2547332
Ref: libraries/random_forest_classifier exporting-the-classifier2547491
Ref: 10aa2547491
Node: Using a Saved Classifier<2>2548036
Ref: libraries/random_forest_classifier using-a-saved-classifier2548200
Ref: 10ab2548200
Node: Printing the Classifier<2>2548545
Ref: libraries/random_forest_classifier printing-the-classifier2548673
Ref: 10ac2548673
Node: random_forest_regression2549186
Ref: libraries/random_forest_regression doc2549335
Ref: 10ad2549335
Ref: libraries/random_forest_regression library-random-forest-regression2549335
Ref: 10ae2549335
Ref: libraries/random_forest_regression random-forest-regression2549335
Ref: 10af2549335
Node: API documentation<185>2550024
Ref: libraries/random_forest_regression api-documentation2550148
Ref: 10b02550148
Node: Loading<187>2550295
Ref: libraries/random_forest_regression loading2550440
Ref: 10b12550440
Node: Testing<178>2550587
Ref: libraries/random_forest_regression testing2550722
Ref: 10b22550722
Node: Features<65>2551036
Ref: libraries/random_forest_regression features2551186
Ref: 10b32551186
Node: Regressor representation<8>2552622
Ref: libraries/random_forest_regression regressor-representation2552782
Ref: 10b42552782
Node: Diagnostics syntax<19>2553044
Ref: libraries/random_forest_regression diagnostics-syntax2553203
Ref: 10b52553203
Node: Options<61>2554466
Ref: libraries/random_forest_regression options2554589
Ref: 10b62554589
Node: random_projection2556315
Ref: libraries/random_projection doc2556455
Ref: 10b72556455
Ref: libraries/random_projection library-random-projection2556455
Ref: 10b82556455
Ref: libraries/random_projection random-projection2556455
Ref: 10b92556455
Node: API documentation<186>2557277
Ref: libraries/random_projection api-documentation2557394
Ref: 10ba2557394
Node: Loading<188>2557534
Ref: libraries/random_projection loading2557672
Ref: 10bb2557672
Node: Testing<179>2557812
Ref: libraries/random_projection testing2557940
Ref: 10bc2557940
Node: Features<66>2558091
Ref: libraries/random_projection features2558218
Ref: 10bd2558218
Node: Options<62>2558849
Ref: libraries/random_projection options2558973
Ref: 10be2558973
Node: Usage<91>2559611
Ref: libraries/random_projection usage2559758
Ref: 10bf2559758
Node: Learning a reducer<7>2560280
Ref: libraries/random_projection learning-a-reducer2560405
Ref: 10c02560405
Node: Transforming new instances<7>2560670
Ref: libraries/random_projection transforming-new-instances2560840
Ref: 10c12560840
Node: Exporting and reusing the reducer<7>2561352
Ref: libraries/random_projection exporting-and-reusing-the-reducer2561492
Ref: 10c22561492
Node: Dimension reducer representation<8>2561986
Ref: libraries/random_projection dimension-reducer-representation2562136
Ref: 10c32562136
Node: References<47>2562978
Ref: libraries/random_projection references2563110
Ref: 10c42563110
Node: rank_centrality2563387
Ref: libraries/rank_centrality doc2563515
Ref: 10c52563515
Ref: libraries/rank_centrality library-rank-centrality2563515
Ref: 10c62563515
Ref: libraries/rank_centrality rank-centrality2563515
Ref: 10c72563515
Node: API documentation<187>2565030
Ref: libraries/rank_centrality api-documentation2565145
Ref: 10c82565145
Node: Loading<189>2565283
Ref: libraries/rank_centrality loading2565419
Ref: 10c92565419
Node: Testing<180>2565557
Ref: libraries/rank_centrality testing2565683
Ref: 10ca2565683
Node: Features<67>2565832
Ref: libraries/rank_centrality features2565969
Ref: 10cb2565969
Node: Dataset requirements<4>2567284
Ref: libraries/rank_centrality dataset-requirements2567418
Ref: 10cc2567418
Node: Usage<92>2567864
Ref: libraries/rank_centrality usage2568008
Ref: 10cd2568008
Node: Learning a ranker<13>2568145
Ref: libraries/rank_centrality learning-a-ranker2568267
Ref: 10ce2568267
Node: Inspecting diagnostics<11>2568609
Ref: libraries/rank_centrality inspecting-diagnostics2568731
Ref: 10cf2568731
Node: Diagnostics syntax<20>2569004
Ref: libraries/rank_centrality diagnostics-syntax2569136
Ref: 10d02569136
Node: Ranking candidate items<12>2570900
Ref: libraries/rank_centrality ranking-candidate-items2571039
Ref: 10d12571039
Node: Exporting the ranker<11>2571574
Ref: libraries/rank_centrality exporting-the-ranker2571713
Ref: 10d22571713
Node: Options<63>2572274
Ref: libraries/rank_centrality options2572422
Ref: 10d32572422
Node: Ranker representation<13>2572680
Ref: libraries/rank_centrality ranker-representation2572820
Ref: 10d42572820
Node: References<48>2573806
Ref: libraries/rank_centrality references2573926
Ref: 10d52573926
Node: ranked_pairs2574119
Ref: libraries/ranked_pairs doc2574247
Ref: 10d62574247
Ref: libraries/ranked_pairs library-ranked-pairs2574247
Ref: 10d72574247
Ref: libraries/ranked_pairs ranked-pairs2574247
Ref: 10d82574247
Node: API documentation<188>2575515
Ref: libraries/ranked_pairs api-documentation2575627
Ref: 10d92575627
Node: Loading<190>2575762
Ref: libraries/ranked_pairs loading2575895
Ref: 10da2575895
Node: Testing<181>2576030
Ref: libraries/ranked_pairs testing2576153
Ref: 10db2576153
Node: Features<68>2576299
Ref: libraries/ranked_pairs features2576419
Ref: 10dc2576419
Node: Usage<93>2577917
Ref: libraries/ranked_pairs usage2578047
Ref: 10dd2578047
Node: Learning a ranker<14>2578318
Ref: libraries/ranked_pairs learning-a-ranker2578440
Ref: 10de2578440
Node: Inspecting diagnostics<12>2578899
Ref: libraries/ranked_pairs inspecting-diagnostics2579057
Ref: 10df2579057
Node: Ranking candidate items<13>2579324
Ref: libraries/ranked_pairs ranking-candidate-items2579484
Ref: 10e02579484
Node: Inspecting locked pairs2580013
Ref: libraries/ranked_pairs inspecting-locked-pairs2580171
Ref: 10e12580171
Node: Exporting the ranker<12>2580628
Ref: libraries/ranked_pairs exporting-the-ranker2580750
Ref: 10e22580750
Node: Diagnostics syntax<21>2581296
Ref: libraries/ranked_pairs diagnostics-syntax2581425
Ref: 10e32581425
Node: Options<64>2582345
Ref: libraries/ranked_pairs options2582485
Ref: 10e42582485
Node: Scoring semantics<7>2583249
Ref: libraries/ranked_pairs scoring-semantics2583392
Ref: 10e52583392
Node: Ranker representation<14>2584057
Ref: libraries/ranked_pairs ranker-representation2584200
Ref: 10e62584200
Node: See also<6>2584860
Ref: libraries/ranked_pairs see-also2584974
Ref: 10e72584974
Node: ranking_protocols2585155
Ref: libraries/ranking_protocols doc2585274
Ref: 10e82585274
Ref: libraries/ranking_protocols library-ranking-protocols2585274
Ref: 10e92585274
Ref: libraries/ranking_protocols ranking-protocols2585274
Ref: 10ea2585274
Node: Protocol requirements2586131
Ref: libraries/ranking_protocols protocol-requirements2586252
Ref: 10eb2586252
Node: Shared categories2587785
Ref: libraries/ranking_protocols shared-categories2587930
Ref: 10ec2587930
Node: Diagnostics<10>2589460
Ref: libraries/ranking_protocols diagnostics2589607
Ref: 10ed2589607
Node: Export header format<3>2590475
Ref: libraries/ranking_protocols export-header-format2590627
Ref: 10ee2590627
Node: API documentation<189>2591158
Ref: libraries/ranking_protocols api-documentation2591307
Ref: 10ef2591307
Node: Loading<191>2591447
Ref: libraries/ranking_protocols loading2591585
Ref: 10f02591585
Node: Testing<182>2591741
Ref: libraries/ranking_protocols testing2591873
Ref: 10f12591873
Node: Test datasets<6>2592037
Ref: libraries/ranking_protocols test-datasets2592148
Ref: 10f22592148
Node: reader2595937
Ref: libraries/reader doc2596061
Ref: 10f32596061
Ref: libraries/reader library-reader2596061
Ref: 10f42596061
Ref: libraries/reader reader2596061
Ref: 10f52596061
Node: API documentation<190>2596477
Ref: libraries/reader api-documentation2596583
Ref: 10f62596583
Node: Loading<192>2596712
Ref: libraries/reader loading2596839
Ref: 10f72596839
Node: Testing<183>2596984
Ref: libraries/reader testing2597080
Ref: 10f82597080
Node: recorded_database2597220
Ref: libraries/recorded_database doc2597332
Ref: 10f92597332
Ref: libraries/recorded_database library-recorded-database2597332
Ref: 10fa2597332
Ref: libraries/recorded_database recorded-database2597332
Ref: 10fb2597332
Node: API documentation<191>2597786
Ref: libraries/recorded_database api-documentation2597903
Ref: 10fc2597903
Node: Loading<193>2598043
Ref: libraries/recorded_database loading2598181
Ref: 10fd2598181
Node: Testing<184>2598337
Ref: libraries/recorded_database testing2598462
Ref: 10fe2598462
Node: Usage<94>2598613
Ref: libraries/recorded_database usage2598742
Ref: 10ff2598742
Node: Known issues<17>2599361
Ref: libraries/recorded_database known-issues2599469
Ref: 11002599469
Node: redis2599807
Ref: libraries/redis doc2599933
Ref: 11012599933
Ref: libraries/redis library-redis2599933
Ref: 11022599933
Ref: libraries/redis redis2599933
Ref: 11032599933
Node: API documentation<192>2600373
Ref: libraries/redis api-documentation2600478
Ref: 11042600478
Node: Loading<194>2600606
Ref: libraries/redis loading2600732
Ref: 11052600732
Node: Testing<185>2600860
Ref: libraries/redis testing2600988
Ref: 11062600988
Node: Supported Redis Features2601622
Ref: libraries/redis supported-redis-features2601748
Ref: 11072601748
Node: Connection Management2602230
Ref: libraries/redis connection-management2602358
Ref: 11082602358
Node: String Operations2602668
Ref: libraries/redis string-operations2602819
Ref: 11092602819
Node: Key Operations2603571
Ref: libraries/redis key-operations2603716
Ref: 110a2603716
Node: Hash Operations2604164
Ref: libraries/redis hash-operations2604307
Ref: 110b2604307
Node: List Operations2604854
Ref: libraries/redis list-operations2604997
Ref: 110c2604997
Node: Set Operations2605531
Ref: libraries/redis set-operations2605680
Ref: 110d2605680
Node: Sorted Set Operations2606036
Ref: libraries/redis sorted-set-operations2606184
Ref: 110e2606184
Node: Usage Examples2606737
Ref: libraries/redis usage-examples2606862
Ref: 110f2606862
Node: Credits<4>2608629
Ref: libraries/redis credits2608759
Ref: 11102608759
Node: Known issues<18>2608871
Ref: libraries/redis known-issues2608968
Ref: 11112608968
Node: regression_protocols2609388
Ref: libraries/regression_protocols doc2609512
Ref: 11122609512
Ref: libraries/regression_protocols library-regression-protocols2609512
Ref: 11132609512
Ref: libraries/regression_protocols regression-protocols2609512
Ref: 11142609512
Node: API documentation<193>2610512
Ref: libraries/regression_protocols api-documentation2610632
Ref: 11152610632
Node: Loading<195>2610775
Ref: libraries/regression_protocols loading2610916
Ref: 11162610916
Node: Testing<186>2611075
Ref: libraries/regression_protocols testing2611210
Ref: 11172611210
Node: Test datasets<7>2611392
Ref: libraries/regression_protocols test-datasets2611506
Ref: 11182611506
Node: regression_tree2613446
Ref: libraries/regression_tree doc2613597
Ref: 11192613597
Ref: libraries/regression_tree library-regression-tree2613597
Ref: 111a2613597
Ref: libraries/regression_tree regression-tree2613597
Ref: 111b2613597
Node: API documentation<194>2614288
Ref: libraries/regression_tree api-documentation2614403
Ref: 111c2614403
Node: Loading<196>2614541
Ref: libraries/regression_tree loading2614677
Ref: 111d2614677
Node: Testing<187>2614815
Ref: libraries/regression_tree testing2614952
Ref: 111e2614952
Node: Export header format<4>2615248
Ref: libraries/regression_tree export-header-format2615385
Ref: 111f2615385
Node: Features<69>2616145
Ref: libraries/regression_tree features2616297
Ref: 11202616297
Node: Regressor representation<9>2617893
Ref: libraries/regression_tree regressor-representation2618044
Ref: 11212618044
Node: Diagnostics syntax<22>2618476
Ref: libraries/regression_tree diagnostics-syntax2618626
Ref: 11222618626
Node: Options<65>2619758
Ref: libraries/regression_tree options2619872
Ref: 11232619872
Node: regularized_bradley_terry_ranker2621094
Ref: libraries/regularized_bradley_terry_ranker doc2621241
Ref: 11242621241
Ref: libraries/regularized_bradley_terry_ranker library-regularized-bradley-terry-ranker2621241
Ref: 11252621241
Ref: libraries/regularized_bradley_terry_ranker regularized-bradley-terry-ranker2621241
Ref: 11262621241
Node: API documentation<195>2622666
Ref: libraries/regularized_bradley_terry_ranker api-documentation2622798
Ref: 11272622798
Node: Loading<197>2622953
Ref: libraries/regularized_bradley_terry_ranker loading2623106
Ref: 11282623106
Node: Testing<188>2623261
Ref: libraries/regularized_bradley_terry_ranker testing2623404
Ref: 11292623404
Node: Features<70>2623570
Ref: libraries/regularized_bradley_terry_ranker features2623724
Ref: 112a2623724
Node: Dataset requirements<5>2624937
Ref: libraries/regularized_bradley_terry_ranker dataset-requirements2625088
Ref: 112b2625088
Node: Usage<95>2625807
Ref: libraries/regularized_bradley_terry_ranker usage2625968
Ref: 112c2625968
Node: Learning a ranker<15>2626105
Ref: libraries/regularized_bradley_terry_ranker learning-a-ranker2626227
Ref: 112d2626227
Node: Inspecting diagnostics<13>2626633
Ref: libraries/regularized_bradley_terry_ranker inspecting-diagnostics2626755
Ref: 112e2626755
Node: Diagnostics syntax<23>2627070
Ref: libraries/regularized_bradley_terry_ranker diagnostics-syntax2627219
Ref: 112f2627219
Node: Ranking candidate items<14>2628727
Ref: libraries/regularized_bradley_terry_ranker ranking-candidate-items2628866
Ref: 11302628866
Node: Exporting the ranker<13>2629435
Ref: libraries/regularized_bradley_terry_ranker exporting-the-ranker2629574
Ref: 11312629574
Node: Options<66>2630202
Ref: libraries/regularized_bradley_terry_ranker options2630367
Ref: 11322630367
Node: Ranker representation<15>2630776
Ref: libraries/regularized_bradley_terry_ranker ranker-representation2630933
Ref: 11332630933
Node: References<49>2631637
Ref: libraries/regularized_bradley_terry_ranker references2631774
Ref: 11342631774
Node: ridge_regression2632302
Ref: libraries/ridge_regression doc2632448
Ref: 11352632448
Ref: libraries/ridge_regression library-ridge-regression2632448
Ref: 11362632448
Ref: libraries/ridge_regression ridge-regression2632448
Ref: 11372632448
Node: API documentation<196>2633268
Ref: libraries/ridge_regression api-documentation2633384
Ref: 11382633384
Node: Loading<198>2633523
Ref: libraries/ridge_regression loading2633660
Ref: 11392633660
Node: Testing<189>2633799
Ref: libraries/ridge_regression testing2633926
Ref: 113a2633926
Node: Features<71>2634224
Ref: libraries/ridge_regression features2634367
Ref: 113b2634367
Node: Regressor representation<10>2635994
Ref: libraries/ridge_regression regressor-representation2636147
Ref: 113c2636147
Node: Diagnostics syntax<24>2636448
Ref: libraries/ridge_regression diagnostics-syntax2636600
Ref: 113d2636600
Node: Options<67>2638577
Ref: libraries/ridge_regression options2638692
Ref: 113e2638692
Node: schulze_ranker2639203
Ref: libraries/schulze_ranker doc2639352
Ref: 113f2639352
Ref: libraries/schulze_ranker library-schulze-ranker2639352
Ref: 11402639352
Ref: libraries/schulze_ranker schulze-ranker2639352
Ref: 11412639352
Node: API documentation<197>2640509
Ref: libraries/schulze_ranker api-documentation2640623
Ref: 11422640623
Node: Loading<199>2640760
Ref: libraries/schulze_ranker loading2640895
Ref: 11432640895
Node: Testing<190>2641032
Ref: libraries/schulze_ranker testing2641157
Ref: 11442641157
Node: Features<72>2641305
Ref: libraries/schulze_ranker features2641429
Ref: 11452641429
Node: Options<68>2642886
Ref: libraries/schulze_ranker options2643013
Ref: 11462643013
Node: Strongest paths2643392
Ref: libraries/schulze_ranker strongest-paths2643529
Ref: 11472643529
Node: Diagnostics syntax<25>2644092
Ref: libraries/schulze_ranker diagnostics-syntax2644243
Ref: 11482644243
Node: Ranker representation<16>2644538
Ref: libraries/schulze_ranker ranker-representation2644665
Ref: 11492644665
Node: sequential_pattern_mining_protocols2645113
Ref: libraries/sequential_pattern_mining_protocols doc2645250
Ref: 114a2645250
Ref: libraries/sequential_pattern_mining_protocols library-sequential-pattern-mining-protocols2645250
Ref: 114b2645250
Ref: libraries/sequential_pattern_mining_protocols sequential-pattern-mining-protocols2645250
Ref: 114c2645250
Node: API documentation<198>2646167
Ref: libraries/sequential_pattern_mining_protocols api-documentation2646302
Ref: 114d2646302
Node: Loading<200>2646460
Ref: libraries/sequential_pattern_mining_protocols loading2646616
Ref: 114e2646616
Node: Testing<191>2646790
Ref: libraries/sequential_pattern_mining_protocols testing2646940
Ref: 114f2646940
Node: Test datasets<8>2647108
Ref: libraries/sequential_pattern_mining_protocols test-datasets2647237
Ref: 11502647237
Node: sets2649254
Ref: libraries/sets doc2649391
Ref: 11512649391
Ref: libraries/sets library-sets2649391
Ref: 11522649391
Ref: libraries/sets sets2649391
Ref: 11532649391
Node: API documentation<199>2650753
Ref: libraries/sets api-documentation2650857
Ref: 11542650857
Node: Loading<201>2650984
Ref: libraries/sets loading2651109
Ref: 11552651109
Node: Testing<192>2651252
Ref: libraries/sets testing2651364
Ref: 11562651364
Node: Usage<96>2651502
Ref: libraries/sets usage2651612
Ref: 11572651612
Node: Credits<5>2653506
Ref: libraries/sets credits2653595
Ref: 11582653595
Node: sgd_classifier2653694
Ref: libraries/sgd_classifier doc2653807
Ref: 11592653807
Ref: libraries/sgd_classifier library-sgd-classifier2653807
Ref: 115a2653807
Ref: libraries/sgd_classifier sgd-classifier2653807
Ref: 115b2653807
Node: API documentation<200>2654933
Ref: libraries/sgd_classifier api-documentation2655047
Ref: 115c2655047
Node: Loading<202>2655184
Ref: libraries/sgd_classifier loading2655319
Ref: 115d2655319
Node: Testing<193>2655456
Ref: libraries/sgd_classifier testing2655581
Ref: 115e2655581
Node: Features<73>2655729
Ref: libraries/sgd_classifier features2655853
Ref: 115f2655853
Node: Options<69>2656661
Ref: libraries/sgd_classifier options2656782
Ref: 11602656782
Node: Usage<97>2657719
Ref: libraries/sgd_classifier usage2657857
Ref: 11612657857
Node: Learning a classifier<7>2658049
Ref: libraries/sgd_classifier learning-a-classifier2658169
Ref: 11622658169
Node: Making predictions<7>2658382
Ref: libraries/sgd_classifier making-predictions2658538
Ref: 11632658538
Node: Exporting the classifier<7>2658965
Ref: libraries/sgd_classifier exporting-the-classifier2659088
Ref: 11642659088
Node: Classifier representation<12>2659444
Ref: libraries/sgd_classifier classifier-representation2659585
Ref: 11652659585
Node: References<50>2660364
Ref: libraries/sgd_classifier references2660487
Ref: 11662660487
Node: snowflakeid2660855
Ref: libraries/snowflakeid doc2660971
Ref: 11672660971
Ref: libraries/snowflakeid library-snowflakeid2660971
Ref: 11682660971
Ref: libraries/snowflakeid snowflakeid2660971
Ref: 11692660971
Node: API documentation<201>2661437
Ref: libraries/snowflakeid api-documentation2661548
Ref: 116a2661548
Node: Loading<203>2661682
Ref: libraries/snowflakeid loading2661814
Ref: 116b2661814
Node: Testing<194>2661964
Ref: libraries/snowflakeid testing2662083
Ref: 116c2662083
Node: Usage<98>2662228
Ref: libraries/snowflakeid usage2662326
Ref: 116d2662326
Node: sockets2663609
Ref: libraries/sockets doc2663730
Ref: 116e2663730
Ref: libraries/sockets library-sockets2663730
Ref: 116f2663730
Ref: libraries/sockets sockets2663730
Ref: 11702663730
Node: Design rationale2664242
Ref: libraries/sockets design-rationale2664353
Ref: 11712664353
Node: API documentation<202>2664808
Ref: libraries/sockets api-documentation2664940
Ref: 11722664940
Node: Loading<204>2665070
Ref: libraries/sockets loading2665198
Ref: 11732665198
Node: Testing<195>2665328
Ref: libraries/sockets testing2665443
Ref: 11742665443
Node: Usage<99>2665584
Ref: libraries/sockets usage2665701
Ref: 11752665701
Node: Creating a client connection2665829
Ref: libraries/sockets creating-a-client-connection2665949
Ref: 11762665949
Node: Creating a server2666465
Ref: libraries/sockets creating-a-server2666623
Ref: 11772666623
Node: Getting the current host name2667278
Ref: libraries/sockets getting-the-current-host-name2667399
Ref: 11782667399
Node: API Summary<3>2667517
Ref: libraries/sockets api-summary2667644
Ref: 11792667644
Node: Backend-specific notes2668698
Ref: libraries/sockets backend-specific-notes2668832
Ref: 117a2668832
Node: Stream representation2668957
Ref: libraries/sockets stream-representation2669087
Ref: 117b2669087
Node: Binary and text modes2669576
Ref: libraries/sockets binary-and-text-modes2669706
Ref: 117c2669706
Node: Known issues<19>2669940
Ref: libraries/sockets known-issues2670051
Ref: 117d2670051
Node: spade_pattern_miner2670385
Ref: libraries/spade_pattern_miner doc2670514
Ref: 117e2670514
Ref: libraries/spade_pattern_miner library-spade-pattern-miner2670514
Ref: 117f2670514
Ref: libraries/spade_pattern_miner spade-pattern-miner2670514
Ref: 11802670514
Node: API documentation<203>2671424
Ref: libraries/spade_pattern_miner api-documentation2671543
Ref: 11812671543
Node: Loading<205>2671685
Ref: libraries/spade_pattern_miner loading2671825
Ref: 11822671825
Node: Testing<196>2671967
Ref: libraries/spade_pattern_miner testing2672097
Ref: 11832672097
Node: Features<74>2672250
Ref: libraries/spade_pattern_miner features2672379
Ref: 11842672379
Node: Options<70>2673386
Ref: libraries/spade_pattern_miner options2673534
Ref: 11852673534
Node: Pattern miner representation<7>2674227
Ref: libraries/spade_pattern_miner pattern-miner-representation2674377
Ref: 11862674377
Node: References<51>2674976
Ref: libraries/spade_pattern_miner references2675106
Ref: 11872675106
Node: simulated_annealing2675244
Ref: libraries/simulated_annealing doc2675376
Ref: 11882675376
Ref: libraries/simulated_annealing library-simulated-annealing2675376
Ref: 11892675376
Ref: libraries/simulated_annealing simulated-annealing2675376
Ref: 118a2675376
Node: API documentation<204>2676433
Ref: libraries/simulated_annealing api-documentation2676552
Ref: 118b2676552
Node: Loading<206>2676694
Ref: libraries/simulated_annealing loading2676834
Ref: 118c2676834
Node: Testing<197>2676992
Ref: libraries/simulated_annealing testing2677122
Ref: 118d2677122
Node: Features<75>2677275
Ref: libraries/simulated_annealing features2677411
Ref: 118e2677411
Node: Defining a problem2680152
Ref: libraries/simulated_annealing defining-a-problem2680287
Ref: 118f2680287
Node: Options<71>2681954
Ref: libraries/simulated_annealing options2682091
Ref: 11902682091
Node: Run statistics2683294
Ref: libraries/simulated_annealing run-statistics2683423
Ref: 11912683423
Node: Usage<100>2683862
Ref: libraries/simulated_annealing usage2683971
Ref: 11922683971
Node: Defining a problem<2>2684271
Ref: libraries/simulated_annealing defining-a-problem-12684389
Ref: 11932684389
Ref: libraries/simulated_annealing id12684389
Ref: 11942684389
Node: Running the algorithm2684932
Ref: libraries/simulated_annealing running-the-algorithm2685086
Ref: 11952685086
Node: Running with custom options2685255
Ref: libraries/simulated_annealing running-with-custom-options2685411
Ref: 11962685411
Node: Running with statistics2685612
Ref: libraries/simulated_annealing running-with-statistics2685774
Ref: 11972685774
Node: Reproducible runs with seed2686048
Ref: libraries/simulated_annealing reproducible-runs-with-seed2686201
Ref: 11982686201
Node: Reheating restarts2686436
Ref: libraries/simulated_annealing reheating-restarts2686593
Ref: 11992686593
Node: Auto-temperature estimation2686897
Ref: libraries/simulated_annealing auto-temperature-estimation2687065
Ref: 119a2687065
Node: Using a custom random number generator2687502
Ref: libraries/simulated_annealing using-a-custom-random-number-generator2687643
Ref: 119b2687643
Node: statistics2688067
Ref: libraries/statistics doc2688188
Ref: 119c2688188
Ref: libraries/statistics library-statistics2688188
Ref: 119d2688188
Ref: libraries/statistics statistics2688188
Ref: 119e2688188
Node: API documentation<205>2689011
Ref: libraries/statistics api-documentation2689121
Ref: 119f2689121
Node: Loading<207>2689254
Ref: libraries/statistics loading2689385
Ref: 11a02689385
Node: Testing<198>2689534
Ref: libraries/statistics testing2689655
Ref: 11a12689655
Node: API overview2689799
Ref: libraries/statistics api-overview2689899
Ref: 11a22689899
Node: Aggregation2690216
Ref: libraries/statistics aggregation2690323
Ref: 11a32690323
Node: Extremes and Range2690603
Ref: libraries/statistics extremes-and-range2690735
Ref: 11a42690735
Node: Central Tendency2691131
Ref: libraries/statistics central-tendency2691284
Ref: 11a52691284
Node: Measures of Position / Quantiles2692090
Ref: libraries/statistics id12692247
Ref: 11a62692247
Ref: libraries/statistics measures-of-position-quantiles2692247
Ref: 11a72692247
Node: Measures of Dispersion2692984
Ref: libraries/statistics measures-of-dispersion2693142
Ref: 11a82693142
Node: Measures of Shape2694622
Ref: libraries/statistics measures-of-shape2694771
Ref: 11a92694771
Node: Measures of Association2695224
Ref: libraries/statistics measures-of-association2695364
Ref: 11aa2695364
Node: Error Metrics2695852
Ref: libraries/statistics error-metrics2695988
Ref: 11ab2695988
Node: Normalization2696425
Ref: libraries/statistics normalization2696558
Ref: 11ac2696558
Node: Frequency / Counting2696990
Ref: libraries/statistics frequency-counting2697123
Ref: 11ad2697123
Ref: libraries/statistics id22697123
Ref: 11ae2697123
Node: Validation<2>2697463
Ref: libraries/statistics validation2697574
Ref: 11af2697574
Node: stemming2697789
Ref: libraries/stemming doc2697896
Ref: 11b02697896
Ref: libraries/stemming library-stemming2697896
Ref: 11b12697896
Ref: libraries/stemming stemming2697896
Ref: 11b22697896
Node: API documentation<206>2698862
Ref: libraries/stemming api-documentation2698970
Ref: 11b32698970
Node: Loading<208>2699101
Ref: libraries/stemming loading2699230
Ref: 11b42699230
Node: Testing<199>2699377
Ref: libraries/stemming testing2699494
Ref: 11b52699494
Node: Usage<101>2699636
Ref: libraries/stemming usage2699754
Ref: 11b62699754
Node: Porter Stemmer2700197
Ref: libraries/stemming porter-stemmer2700301
Ref: 11b72700301
Node: Lovins Stemmer2700724
Ref: libraries/stemming lovins-stemmer2700828
Ref: 11b82700828
Node: Algorithms<2>2701132
Ref: libraries/stemming algorithms2701259
Ref: 11b92701259
Node: Porter Stemmer<2>2701382
Ref: libraries/stemming id12701495
Ref: 11ba2701495
Ref: libraries/stemming porter-stemmer-12701495
Ref: 11bb2701495
Node: Lovins Stemmer<2>2702462
Ref: libraries/stemming id22702575
Ref: 11bc2702575
Ref: libraries/stemming lovins-stemmer-12702575
Ref: 11bd2702575
Node: Choosing an Algorithm2703504
Ref: libraries/stemming choosing-an-algorithm2703641
Ref: 11be2703641
Node: Known Limitations<2>2704091
Ref: libraries/stemming known-limitations2704206
Ref: 11bf2704206
Node: stomp2704526
Ref: libraries/stomp doc2704638
Ref: 11c02704638
Ref: libraries/stomp library-stomp2704638
Ref: 11c12704638
Ref: libraries/stomp stomp2704638
Ref: 11c22704638
Node: Protocol Version<2>2705287
Ref: libraries/stomp protocol-version2705389
Ref: 11c32705389
Node: Features<76>2705686
Ref: libraries/stomp features2705819
Ref: 11c42705819
Node: API documentation<207>2706307
Ref: libraries/stomp api-documentation2706433
Ref: 11c52706433
Node: Loading<209>2706561
Ref: libraries/stomp loading2706687
Ref: 11c62706687
Node: Testing<200>2706815
Ref: libraries/stomp testing2706929
Ref: 11c72706929
Node: Usage<102>2707653
Ref: libraries/stomp usage2707769
Ref: 11c82707769
Node: Connecting to a STOMP server2708077
Ref: libraries/stomp connecting-to-a-stomp-server2708197
Ref: 11c92708197
Node: Sending messages2708840
Ref: libraries/stomp sending-messages2708996
Ref: 11ca2708996
Node: Subscribing to destinations2709811
Ref: libraries/stomp subscribing-to-destinations2709957
Ref: 11cb2709957
Node: Receiving messages2710450
Ref: libraries/stomp receiving-messages2710602
Ref: 11cc2710602
Node: Acknowledging messages2711159
Ref: libraries/stomp acknowledging-messages2711297
Ref: 11cd2711297
Node: Unsubscribing2711746
Ref: libraries/stomp unsubscribing2711881
Ref: 11ce2711881
Node: Transactions<2>2711984
Ref: libraries/stomp transactions2712113
Ref: 11cf2712113
Node: Disconnecting<3>2712411
Ref: libraries/stomp disconnecting2712545
Ref: 11d02712545
Node: Heartbeat handling2712686
Ref: libraries/stomp heartbeat-handling2712824
Ref: 11d12712824
Node: Working with frames2713039
Ref: libraries/stomp working-with-frames2713152
Ref: 11d22713152
Node: API Summary<4>2713492
Ref: libraries/stomp api-summary2713614
Ref: 11d32713614
Node: Connection management<2>2713817
Ref: libraries/stomp connection-management2713930
Ref: 11d42713930
Node: Messaging2714216
Ref: libraries/stomp messaging2714352
Ref: 11d52714352
Node: Acknowledgment2714678
Ref: libraries/stomp acknowledgment2714805
Ref: 11d62714805
Node: Transactions<3>2714990
Ref: libraries/stomp id12715117
Ref: 11d72715117
Ref: libraries/stomp transactions-12715117
Ref: 11d82715117
Node: Heartbeat2715402
Ref: libraries/stomp heartbeat2715531
Ref: 11d92715531
Node: Frame inspection2715633
Ref: libraries/stomp frame-inspection2715738
Ref: 11da2715738
Node: Connection Options2716041
Ref: libraries/stomp connection-options2716165
Ref: 11db2716165
Node: Send Options2716499
Ref: libraries/stomp send-options2716626
Ref: 11dc2716626
Node: Subscribe Options2716996
Ref: libraries/stomp subscribe-options2717120
Ref: 11dd2717120
Node: Receive Options2717278
Ref: libraries/stomp receive-options2717407
Ref: 11de2717407
Node: Error Handling<3>2717549
Ref: libraries/stomp error-handling2717652
Ref: 11df2717652
Node: string_distance2718074
Ref: libraries/string_distance doc2718185
Ref: 11e02718185
Ref: libraries/string_distance library-string-distance2718185
Ref: 11e12718185
Ref: libraries/string_distance string-distance2718185
Ref: 11e22718185
Node: API documentation<208>2718916
Ref: libraries/string_distance api-documentation2719031
Ref: 11e32719031
Node: Loading<210>2719169
Ref: libraries/string_distance loading2719305
Ref: 11e42719305
Node: Testing<201>2719459
Ref: libraries/string_distance testing2719586
Ref: 11e52719586
Node: Algorithms<3>2719735
Ref: libraries/string_distance algorithms2719841
Ref: 11e62719841
Node: strings2722975
Ref: libraries/strings doc2723093
Ref: 11e72723093
Ref: libraries/strings library-strings2723093
Ref: 11e82723093
Ref: libraries/strings strings2723093
Ref: 11e92723093
Node: API documentation<209>2723886
Ref: libraries/strings api-documentation2723993
Ref: 11ea2723993
Node: Loading<211>2724123
Ref: libraries/strings loading2724251
Ref: 11eb2724251
Node: Testing<202>2724397
Ref: libraries/strings testing2724516
Ref: 11ec2724516
Node: Predicates<2>2724657
Ref: libraries/strings predicates2724755
Ref: 11ed2724755
Node: subsequences2726060
Ref: libraries/subsequences doc2726170
Ref: 11ee2726170
Ref: libraries/subsequences library-subsequences2726170
Ref: 11ef2726170
Ref: libraries/subsequences subsequences2726170
Ref: 11f02726170
Node: API documentation<210>2727851
Ref: libraries/subsequences api-documentation2727963
Ref: 11f12727963
Node: Loading<212>2728098
Ref: libraries/subsequences loading2728231
Ref: 11f22728231
Node: Testing<203>2728382
Ref: libraries/subsequences testing2728484
Ref: 11f32728484
Node: term_io2728630
Ref: libraries/term_io doc2728759
Ref: 11f42728759
Ref: libraries/term_io library-term-io2728759
Ref: 11f52728759
Ref: libraries/term_io term-io2728759
Ref: 11f62728759
Node: API documentation<211>2729264
Ref: libraries/term_io api-documentation2729371
Ref: 11f72729371
Node: Loading<213>2729501
Ref: libraries/term_io loading2729629
Ref: 11f82729629
Node: Testing<204>2729775
Ref: libraries/term_io testing2729872
Ref: 11f92729872
Node: thurstone_mosteller_ranker2730013
Ref: libraries/thurstone_mosteller_ranker doc2730141
Ref: 11fa2730141
Ref: libraries/thurstone_mosteller_ranker library-thurstone-mosteller-ranker2730141
Ref: 11fb2730141
Ref: libraries/thurstone_mosteller_ranker thurstone-mosteller-ranker2730141
Ref: 11fc2730141
Node: API documentation<212>2731463
Ref: libraries/thurstone_mosteller_ranker api-documentation2731589
Ref: 11fd2731589
Node: Loading<214>2731738
Ref: libraries/thurstone_mosteller_ranker loading2731885
Ref: 11fe2731885
Node: Testing<205>2732034
Ref: libraries/thurstone_mosteller_ranker testing2732171
Ref: 11ff2732171
Node: Features<77>2732331
Ref: libraries/thurstone_mosteller_ranker features2732476
Ref: 12002732476
Node: Scoring semantics<8>2733544
Ref: libraries/thurstone_mosteller_ranker scoring-semantics2733688
Ref: 12012733688
Node: Options<72>2734401
Ref: libraries/thurstone_mosteller_ranker options2734555
Ref: 12022734555
Node: Diagnostics syntax<26>2734733
Ref: libraries/thurstone_mosteller_ranker diagnostics-syntax2734892
Ref: 12032734892
Node: Ranker representation<17>2735243
Ref: libraries/thurstone_mosteller_ranker ranker-representation2735382
Ref: 12042735382
Node: time_scales2735800
Ref: libraries/time_scales doc2735928
Ref: 12052735928
Ref: libraries/time_scales library-time-scales2735928
Ref: 12062735928
Ref: libraries/time_scales time-scales2735928
Ref: 12072735928
Node: API documentation<213>2736710
Ref: libraries/time_scales api-documentation2736821
Ref: 12082736821
Node: Loading<215>2736955
Ref: libraries/time_scales loading2737087
Ref: 12092737087
Node: Testing<206>2737237
Ref: libraries/time_scales testing2737359
Ref: 120a2737359
Node: Features<78>2737504
Ref: libraries/time_scales features2737628
Ref: 120b2737628
Node: Limitations<5>2738608
Ref: libraries/time_scales limitations2738738
Ref: 120c2738738
Node: Representation<16>2739279
Ref: libraries/time_scales representation2739410
Ref: 120d2739410
Node: Examples<174>2739908
Ref: libraries/time_scales examples2740016
Ref: 120e2740016
Node: timeout2742146
Ref: libraries/timeout doc2742258
Ref: 120f2742258
Ref: libraries/timeout library-timeout2742258
Ref: 12102742258
Ref: libraries/timeout timeout2742258
Ref: 12112742258
Node: API documentation<214>2742905
Ref: libraries/timeout api-documentation2743012
Ref: 12122743012
Node: Loading<216>2743142
Ref: libraries/timeout loading2743270
Ref: 12132743270
Node: Testing<207>2743416
Ref: libraries/timeout testing2743538
Ref: 12142743538
Node: Known issues<20>2743679
Ref: libraries/timeout known-issues2743780
Ref: 12152743780
Node: tle_orbits2744225
Ref: libraries/tle_orbits doc2744330
Ref: 12162744330
Ref: libraries/tle_orbits library-tle-orbits2744330
Ref: 12172744330
Ref: libraries/tle_orbits tle-orbits2744330
Ref: 12182744330
Node: API documentation<215>2745424
Ref: libraries/tle_orbits api-documentation2745534
Ref: 12192745534
Node: Loading<217>2745667
Ref: libraries/tle_orbits loading2745798
Ref: 121a2745798
Node: Testing<208>2745947
Ref: libraries/tle_orbits testing2746074
Ref: 121b2746074
Node: Representation<17>2746218
Ref: libraries/tle_orbits representation2746346
Ref: 121c2746346
Node: Public API<3>2747075
Ref: libraries/tle_orbits public-api2747204
Ref: 121d2747204
Node: Examples<175>2749071
Ref: libraries/tle_orbits examples2749191
Ref: 121e2749191
Node: Notes<11>2750647
Ref: libraries/tle_orbits notes2750745
Ref: 121f2750745
Node: toml2751764
Ref: libraries/toml doc2751866
Ref: 12202751866
Ref: libraries/toml library-toml2751866
Ref: 12212751866
Ref: libraries/toml toml2751866
Ref: 12222751866
Node: API documentation<216>2752475
Ref: libraries/toml api-documentation2752579
Ref: 12232752579
Node: Loading<218>2752706
Ref: libraries/toml loading2752831
Ref: 12242752831
Node: Testing<209>2752974
Ref: libraries/toml testing2753083
Ref: 12252753083
Node: Status2753221
Ref: libraries/toml status2753336
Ref: 12262753336
Node: Representation<18>2753886
Ref: libraries/toml representation2754002
Ref: 12272754002
Node: Examples<176>2755713
Ref: libraries/toml examples2755832
Ref: 12282755832
Node: Parsing a TOML String2755967
Ref: libraries/toml parsing-a-toml-string2756106
Ref: 12292756106
Node: Parsing with Curly Table Representation2756315
Ref: libraries/toml parsing-with-curly-table-representation2756478
Ref: 122a2756478
Node: Generating TOML2756729
Ref: libraries/toml generating-toml2756862
Ref: 122b2756862
Node: Notes<12>2757065
Ref: libraries/toml notes2757157
Ref: 122c2757157
Node: toon2757387
Ref: libraries/toon doc2757503
Ref: 122d2757503
Ref: libraries/toon library-toon2757503
Ref: 122e2757503
Ref: libraries/toon toon2757503
Ref: 122f2757503
Node: API documentation<217>2758055
Ref: libraries/toon api-documentation2758159
Ref: 12302758159
Node: Loading<219>2758286
Ref: libraries/toon loading2758411
Ref: 12312758411
Node: Testing<210>2758554
Ref: libraries/toon testing2758675
Ref: 12322758675
Node: Representation<19>2758813
Ref: libraries/toon representation2758942
Ref: 12332758942
Node: Objects<2>2759600
Ref: libraries/toon objects2759700
Ref: 12342759700
Node: Arrays2759963
Ref: libraries/toon arrays2760082
Ref: 12352760082
Node: Primitives2760188
Ref: libraries/toon primitives2760288
Ref: 12362760288
Node: TOON format features2760572
Ref: libraries/toon toon-format-features2760703
Ref: 12372760703
Node: Usage examples2761258
Ref: libraries/toon usage-examples2761362
Ref: 12382761362
Node: truncated_svd_projection2762009
Ref: libraries/truncated_svd_projection doc2762124
Ref: 12392762124
Ref: libraries/truncated_svd_projection library-truncated-svd-projection2762124
Ref: 123a2762124
Ref: libraries/truncated_svd_projection truncated-svd-projection2762124
Ref: 123b2762124
Node: API documentation<218>2762920
Ref: libraries/truncated_svd_projection api-documentation2763044
Ref: 123c2763044
Node: Loading<220>2763191
Ref: libraries/truncated_svd_projection loading2763336
Ref: 123d2763336
Node: Testing<211>2763483
Ref: libraries/truncated_svd_projection testing2763618
Ref: 123e2763618
Node: Features<79>2763776
Ref: libraries/truncated_svd_projection features2763910
Ref: 123f2763910
Node: Options<73>2764872
Ref: libraries/truncated_svd_projection options2765004
Ref: 12402765004
Node: Usage<103>2766505
Ref: libraries/truncated_svd_projection usage2766660
Ref: 12412766660
Node: Learning a reducer<8>2767084
Ref: libraries/truncated_svd_projection learning-a-reducer2767210
Ref: 12422767210
Node: Transforming new instances<8>2767539
Ref: libraries/truncated_svd_projection transforming-new-instances2767710
Ref: 12432767710
Node: Exporting and reusing the reducer<8>2767977
Ref: libraries/truncated_svd_projection exporting-and-reusing-the-reducer2768118
Ref: 12442768118
Node: Dimension reducer representation<9>2768619
Ref: libraries/truncated_svd_projection dimension-reducer-representation2768777
Ref: 12452768777
Node: References<52>2769560
Ref: libraries/truncated_svd_projection references2769699
Ref: 12462769699
Node: tsv2769847
Ref: libraries/tsv doc2769963
Ref: 12472769963
Ref: libraries/tsv library-tsv2769963
Ref: 12482769963
Ref: libraries/tsv tsv2769963
Ref: 12492769963
Node: API documentation<219>2771430
Ref: libraries/tsv api-documentation2771533
Ref: 124a2771533
Node: Loading<221>2771659
Ref: libraries/tsv loading2771783
Ref: 124b2771783
Node: Testing<212>2771925
Ref: libraries/tsv testing2772037
Ref: 124c2772037
Node: Usage<104>2772174
Ref: libraries/tsv usage2772265
Ref: 124d2772265
Node: types2773157
Ref: libraries/types doc2773253
Ref: 124e2773253
Ref: libraries/types library-types2773253
Ref: 14c2773253
Ref: libraries/types types2773253
Ref: 124f2773253
Node: API documentation<220>2774150
Ref: libraries/types api-documentation2774255
Ref: 12502774255
Node: Loading<222>2774383
Ref: libraries/types loading2774509
Ref: 12512774509
Node: Testing<213>2774856
Ref: libraries/types testing2774976
Ref: 12522774976
Node: Type-checking<2>2775115
Ref: libraries/types type-checking2775241
Ref: 12532775241
Node: Defining new types2776213
Ref: libraries/types defining-new-types2776340
Ref: 12542776340
Node: Examples<177>2777394
Ref: libraries/types examples2777496
Ref: 12552777496
Node: tzif2777738
Ref: libraries/tzif doc2777835
Ref: 12562777835
Ref: libraries/tzif library-tzif2777835
Ref: 12572777835
Ref: libraries/tzif tzif2777835
Ref: 12582777835
Node: API documentation<221>2780179
Ref: libraries/tzif api-documentation2780283
Ref: 12592780283
Node: Loading<223>2780410
Ref: libraries/tzif loading2780535
Ref: 125a2780535
Node: Testing<214>2780678
Ref: libraries/tzif testing2780799
Ref: 125b2780799
Node: Representation<20>2780937
Ref: libraries/tzif representation2781072
Ref: 125c2781072
Node: Zone identifier validation2782311
Ref: libraries/tzif zone-identifier-validation2782447
Ref: 125d2782447
Node: Local Queries2783034
Ref: libraries/tzif local-queries2783165
Ref: 125e2783165
Node: Examples<178>2784649
Ref: libraries/tzif examples2784745
Ref: 125f2784745
Node: ulid2786505
Ref: libraries/ulid doc2786609
Ref: 12602786609
Ref: libraries/ulid library-ulid2786609
Ref: 12612786609
Ref: libraries/ulid ulid2786609
Ref: 12622786609
Node: API documentation<222>2787593
Ref: libraries/ulid api-documentation2787697
Ref: 12632787697
Node: Loading<224>2787824
Ref: libraries/ulid loading2787949
Ref: 12642787949
Node: Testing<215>2788092
Ref: libraries/ulid testing2788211
Ref: 12652788211
Node: Generating ULIDs2788349
Ref: libraries/ulid generating-ulids2788475
Ref: 12662788475
Node: Type-checking ULIDs2790351
Ref: libraries/ulid type-checking-ulids2790456
Ref: 12672790456
Node: unicode_data2790796
Ref: libraries/unicode_data doc2790906
Ref: 12682790906
Ref: libraries/unicode_data library-unicode-data2790906
Ref: 12692790906
Ref: libraries/unicode_data unicode-data2790906
Ref: 126a2790906
Node: Authors2791202
Ref: libraries/unicode_data authors2791294
Ref: 126b2791294
Node: License2791394
Ref: libraries/unicode_data license2791502
Ref: 126c2791502
Node: Website2791787
Ref: libraries/unicode_data website2791904
Ref: 126d2791904
Node: Description<165>2792206
Ref: libraries/unicode_data description2792331
Ref: 126e2792331
Node: Requirements<6>2792944
Ref: libraries/unicode_data requirements2793072
Ref: 126f2793072
Node: Usage<105>2793484
Ref: libraries/unicode_data usage2793612
Ref: 12702793612
Node: Known issues<21>2794062
Ref: libraries/unicode_data known-issues2794191
Ref: 12712794191
Node: Acknowledgements2794855
Ref: libraries/unicode_data acknowledgements2794995
Ref: 12722794995
Node: Files and API Summary2795143
Ref: libraries/unicode_data files-and-api-summary2795258
Ref: 12732795258
Node: unicode_arabic_shaping pl2798434
Ref: libraries/unicode_data unicode-arabic-shaping-pl2798571
Ref: 12742798571
Ref: libraries/unicode_data unicode-arabic-shapingpl2798571
Ref: 12752798571
Node: unicode_bidi_mirroring pl2798726
Ref: libraries/unicode_data unicode-bidi-mirroring-pl2798889
Ref: 12762798889
Ref: libraries/unicode_data unicode-bidi-mirroringpl2798889
Ref: 12772798889
Node: unicode_blocks pl2799044
Ref: libraries/unicode_data unicode-blocks-pl2799205
Ref: 12782799205
Ref: libraries/unicode_data unicode-blockspl2799205
Ref: 12792799205
Node: unicode_case_folding pl2799337
Ref: libraries/unicode_data unicode-case-folding-pl2799494
Ref: 127a2799494
Ref: libraries/unicode_data unicode-case-foldingpl2799494
Ref: 127b2799494
Node: unicode_categories pl2799643
Ref: libraries/unicode_data unicode-categories-pl2799806
Ref: 127c2799806
Ref: libraries/unicode_data unicode-categoriespl2799806
Ref: 127d2799806
Node: unicode_cjk_radicals pl2799988
Ref: libraries/unicode_data unicode-cjk-radicals-pl2800161
Ref: 127e2800161
Ref: libraries/unicode_data unicode-cjk-radicalspl2800161
Ref: 127f2800161
Node: unicode_composition_exclusions pl2800309
Ref: libraries/unicode_data unicode-composition-exclusions-pl2800487
Ref: 12802800487
Ref: libraries/unicode_data unicode-composition-exclusionspl2800487
Ref: 12812800487
Node: unicode_core_properties pl2800665
Ref: libraries/unicode_data unicode-core-properties-pl2800849
Ref: 12822800849
Ref: libraries/unicode_data unicode-core-propertiespl2800849
Ref: 12832800849
Node: unicode_decomposition_type pl2801734
Ref: libraries/unicode_data unicode-decomposition-type-pl2801907
Ref: 12842801907
Ref: libraries/unicode_data unicode-decomposition-typepl2801907
Ref: 12852801907
Node: unicode_derived_age pl2802539
Ref: libraries/unicode_data unicode-derived-age-pl2802715
Ref: 12862802715
Ref: libraries/unicode_data unicode-derived-agepl2802715
Ref: 12872802715
Node: unicode_derived_bidi_class pl2802857
Ref: libraries/unicode_data unicode-derived-bidi-class-pl2803038
Ref: 12882803038
Ref: libraries/unicode_data unicode-derived-bidi-classpl2803038
Ref: 12892803038
Node: unicode_derived_combining_class pl2803201
Ref: libraries/unicode_data unicode-derived-combining-class-pl2803394
Ref: 128a2803394
Ref: libraries/unicode_data unicode-derived-combining-classpl2803394
Ref: 128b2803394
Node: unicode_derived_core_properties pl2803572
Ref: libraries/unicode_data unicode-derived-core-properties-pl2803773
Ref: 128c2803773
Ref: libraries/unicode_data unicode-derived-core-propertiespl2803773
Ref: 128d2803773
Node: unicode_derived_decomposition_type pl2803949
Ref: libraries/unicode_data unicode-derived-decomposition-type-pl2804151
Ref: 128e2804151
Ref: libraries/unicode_data unicode-derived-decomposition-typepl2804151
Ref: 128f2804151
Node: unicode_derived_east_asian_width pl2804338
Ref: libraries/unicode_data unicode-derived-east-asian-width-pl2804538
Ref: 12902804538
Ref: libraries/unicode_data unicode-derived-east-asian-widthpl2804538
Ref: 12912804538
Node: unicode_derived_joining_group pl2804719
Ref: libraries/unicode_data unicode-derived-joining-group-pl2804913
Ref: 12922804913
Ref: libraries/unicode_data unicode-derived-joining-grouppl2804913
Ref: 12932804913
Node: unicode_derived_joining_type pl2805085
Ref: libraries/unicode_data unicode-derived-joining-type-pl2805273
Ref: 12942805273
Ref: libraries/unicode_data unicode-derived-joining-typepl2805273
Ref: 12952805273
Node: unicode_derived_line_break pl2805442
Ref: libraries/unicode_data unicode-derived-line-break-pl2805636
Ref: 12962805636
Ref: libraries/unicode_data unicode-derived-line-breakpl2805636
Ref: 12972805636
Node: unicode_derived_normalization_props pl2805799
Ref: libraries/unicode_data unicode-derived-normalization-props-pl2805993
Ref: 12982805993
Ref: libraries/unicode_data unicode-derived-normalization-propspl2805993
Ref: 12992805993
Node: unicode_derived_numeric_type pl2806694
Ref: libraries/unicode_data unicode-derived-numeric-type-pl2806892
Ref: 129a2806892
Ref: libraries/unicode_data unicode-derived-numeric-typepl2806892
Ref: 129b2806892
Node: unicode_derived_numeric_values pl2807061
Ref: libraries/unicode_data unicode-derived-numeric-values-pl2807252
Ref: 129c2807252
Ref: libraries/unicode_data unicode-derived-numeric-valuespl2807252
Ref: 129d2807252
Node: unicode_hangul_syllable_type pl2807426
Ref: libraries/unicode_data unicode-hangul-syllable-type-pl2807617
Ref: 129e2807617
Ref: libraries/unicode_data unicode-hangul-syllable-typepl2807617
Ref: 129f2807617
Node: unicode_indic_matra_category pl2807794
Ref: libraries/unicode_data unicode-indic-matra-category-pl2807986
Ref: 12a02807986
Ref: libraries/unicode_data unicode-indic-matra-categorypl2807986
Ref: 12a12807986
Node: unicode_indic_syllabic_category pl2808163
Ref: libraries/unicode_data unicode-indic-syllabic-category-pl2808339
Ref: 12a22808339
Ref: libraries/unicode_data unicode-indic-syllabic-categorypl2808339
Ref: 12a32808339
Node: unicode_jamo pl2808525
Ref: libraries/unicode_data unicode-jamo-pl2808693
Ref: 12a42808693
Ref: libraries/unicode_data unicode-jamopl2808693
Ref: 12a52808693
Node: unicode_name_aliases pl2808820
Ref: libraries/unicode_data unicode-name-aliases-pl2808970
Ref: 12a62808970
Ref: libraries/unicode_data unicode-name-aliasespl2808970
Ref: 12a72808970
Node: unicode_names pl2809119
Ref: libraries/unicode_data unicode-names-pl2809274
Ref: 12a82809274
Ref: libraries/unicode_data unicode-namespl2809274
Ref: 12a92809274
Node: unicode_prop_list pl2809439
Ref: libraries/unicode_data unicode-prop-list-pl2809595
Ref: 12aa2809595
Ref: libraries/unicode_data unicode-prop-listpl2809595
Ref: 12ab2809595
Node: unicode_range_scripts pl2810887
Ref: libraries/unicode_data unicode-range-scripts-pl2811055
Ref: 12ac2811055
Ref: libraries/unicode_data unicode-range-scriptspl2811055
Ref: 12ad2811055
Node: unicode_script_extensions pl2811231
Ref: libraries/unicode_data unicode-script-extensions-pl2811397
Ref: 12ae2811397
Ref: libraries/unicode_data unicode-script-extensionspl2811397
Ref: 12af2811397
Node: unicode_scripts pl2811582
Ref: libraries/unicode_data unicode-scripts-pl2811749
Ref: 12b02811749
Ref: libraries/unicode_data unicode-scriptspl2811749
Ref: 12b12811749
Node: unicode_special_casing pl2811916
Ref: libraries/unicode_data unicode-special-casing-pl2812081
Ref: 12b22812081
Ref: libraries/unicode_data unicode-special-casingpl2812081
Ref: 12b32812081
Node: unicode_unihan_variants pl2812238
Ref: libraries/unicode_data unicode-unihan-variants-pl2812403
Ref: 12b42812403
Ref: libraries/unicode_data unicode-unihan-variantspl2812403
Ref: 12b52812403
Node: unicode_version pl2812564
Ref: libraries/unicode_data unicode-version-pl2812695
Ref: 12b62812695
Ref: libraries/unicode_data unicode-versionpl2812695
Ref: 12b72812695
Node: union_find2812831
Ref: libraries/union_find doc2812940
Ref: 12b82812940
Ref: libraries/union_find library-union-find2812940
Ref: 12b92812940
Ref: libraries/union_find union-find2812940
Ref: 12ba2812940
Node: API documentation<223>2814042
Ref: libraries/union_find api-documentation2814152
Ref: 12bb2814152
Node: Loading<225>2814285
Ref: libraries/union_find loading2814416
Ref: 12bc2814416
Node: Testing<216>2814565
Ref: libraries/union_find testing2814684
Ref: 12bd2814684
Node: Usage<106>2814828
Ref: libraries/union_find usage2814926
Ref: 12be2814926
Node: url2816384
Ref: libraries/url doc2816485
Ref: 12bf2816485
Ref: libraries/url library-url2816485
Ref: 12c02816485
Ref: libraries/url url2816485
Ref: 12c12816485
Node: API documentation<224>2818033
Ref: libraries/url api-documentation2818136
Ref: 12c22818136
Node: Loading<226>2818262
Ref: libraries/url loading2818386
Ref: 12c32818386
Node: Testing<217>2818528
Ref: libraries/url testing2818621
Ref: 12c42818621
Node: uuid2818758
Ref: libraries/uuid doc2818860
Ref: 12c52818860
Ref: libraries/uuid library-uuid2818860
Ref: 12c62818860
Ref: libraries/uuid uuid2818860
Ref: 12c72818860
Node: API documentation<225>2820565
Ref: libraries/uuid api-documentation2820669
Ref: 12c82820669
Node: Loading<227>2820796
Ref: libraries/uuid loading2820921
Ref: 12c92820921
Node: Testing<218>2821064
Ref: libraries/uuid testing2821193
Ref: 12ca2821193
Node: Generating version 1 UUIDs2821331
Ref: libraries/uuid generating-version-1-uuids2821474
Ref: 12cb2821474
Node: Generating version 4 UUIDs2822364
Ref: libraries/uuid generating-version-4-uuids2822521
Ref: 12cc2822521
Node: Generating version 3 UUIDs2823315
Ref: libraries/uuid generating-version-3-uuids2823472
Ref: 12cd2823472
Node: Generating version 5 UUIDs2824463
Ref: libraries/uuid generating-version-5-uuids2824620
Ref: 12ce2824620
Node: Generating version 7 UUIDs2825722
Ref: libraries/uuid generating-version-7-uuids2825885
Ref: 12cf2825885
Node: Generating the Nil and Max UUIDs2826781
Ref: libraries/uuid generating-the-nil-and-max-uuids2826909
Ref: 12d02826909
Node: validations2827243
Ref: libraries/validations doc2827349
Ref: 12d12827349
Ref: libraries/validations library-validations2827349
Ref: 12d22827349
Ref: libraries/validations validations2827349
Ref: 12d32827349
Node: API documentation<226>2828338
Ref: libraries/validations api-documentation2828449
Ref: 12d42828449
Node: Loading<228>2828583
Ref: libraries/validations loading2828715
Ref: 12d52828715
Node: Testing<219>2828865
Ref: libraries/validations testing2828985
Ref: 12d62828985
Node: Usage<107>2829130
Ref: libraries/validations usage2829275
Ref: 12d72829275
Node: Comparison with the expecteds library2832092
Ref: libraries/validations comparison-with-the-expecteds-library2832236
Ref: 12d82832236
Node: Example form validation with error accumulation2833215
Ref: libraries/validations example-form-validation-with-error-accumulation2833356
Ref: 12d92833356
Node: See also<7>2835258
Ref: libraries/validations see-also2835383
Ref: 12da2835383
Node: wkt_wkb2835470
Ref: libraries/wkt_wkb doc2835576
Ref: 12db2835576
Ref: libraries/wkt_wkb library-wkt-wkb2835576
Ref: 12dc2835576
Ref: libraries/wkt_wkb wkt-wkb2835576
Ref: 12dd2835576
Node: API documentation<227>2836246
Ref: libraries/wkt_wkb api-documentation2836353
Ref: 12de2836353
Node: Loading<229>2836483
Ref: libraries/wkt_wkb loading2836611
Ref: 12df2836611
Node: Testing<220>2836757
Ref: libraries/wkt_wkb testing2836881
Ref: 12e02836881
Node: Representation<21>2837022
Ref: libraries/wkt_wkb representation2837151
Ref: 12e12837151
Node: Sources and sinks2838440
Ref: libraries/wkt_wkb sources-and-sinks2838570
Ref: 12e22838570
Node: Examples<179>2839233
Ref: libraries/wkt_wkb examples2839354
Ref: 12e32839354
Node: Notes<13>2840308
Ref: libraries/wkt_wkb notes2840403
Ref: 12e42840403
Node: yaml2841249
Ref: libraries/yaml doc2841368
Ref: 12e52841368
Ref: libraries/yaml library-yaml2841368
Ref: 12e62841368
Ref: libraries/yaml yaml2841368
Ref: 12e72841368
Node: API documentation<228>2842101
Ref: libraries/yaml api-documentation2842205
Ref: 12e82842205
Node: Loading<230>2842332
Ref: libraries/yaml loading2842457
Ref: 12e92842457
Node: Testing<221>2842600
Ref: libraries/yaml testing2842706
Ref: 12ea2842706
Node: API2842844
Ref: libraries/yaml api2842960
Ref: 12eb2842960
Node: Parsing<3>2843104
Ref: libraries/yaml parsing2843196
Ref: 12ec2843196
Node: Generating<3>2843764
Ref: libraries/yaml generating2843887
Ref: 12ed2843887
Node: Multi-Document Parsing2844451
Ref: libraries/yaml multi-document-parsing2844589
Ref: 12ee2844589
Node: Multi-Document Generation2844934
Ref: libraries/yaml multi-document-generation2845050
Ref: 12ef2845050
Node: Data Representation<2>2845381
Ref: libraries/yaml data-representation2845498
Ref: 12f02845498
Node: Examples<180>2846165
Ref: libraries/yaml examples2846291
Ref: 12f12846291
Node: Parsing a Simple YAML String2846514
Ref: libraries/yaml parsing-a-simple-yaml-string2846640
Ref: 12f22846640
Node: Parsing a YAML List2846811
Ref: libraries/yaml parsing-a-yaml-list2846965
Ref: 12f32846965
Node: Parsing a YAML File2847120
Ref: libraries/yaml parsing-a-yaml-file2847273
Ref: 12f42847273
Node: Generating YAML from a Term2847413
Ref: libraries/yaml generating-yaml-from-a-term2847572
Ref: 12f52847572
Node: Generating YAML to a File2847761
Ref: libraries/yaml generating-yaml-to-a-file2847931
Ref: 12f62847931
Node: Working with Nested Structures2848136
Ref: libraries/yaml working-with-nested-structures2848270
Ref: 12f72848270
Node: Features<80>2848609
Ref: libraries/yaml features2848736
Ref: 12f82848736
Node: Supported YAML Features2849305
Ref: libraries/yaml supported-yaml-features2849433
Ref: 12f92849433
Node: Limitations<6>2852500
Ref: libraries/yaml limitations2852633
Ref: 12fa2852633
Node: Error Handling<4>2853193
Ref: libraries/yaml error-handling2853320
Ref: 12fb2853320
Node: File Organization2853736
Ref: libraries/yaml file-organization2853859
Ref: 12fc2853859
Node: Test Files2854222
Ref: libraries/yaml test-files2854357
Ref: 12fd2854357
Node: Performance Considerations<2>2854751
Ref: libraries/yaml performance-considerations2854901
Ref: 12fe2854901
Node: Integration with Other Libraries2855192
Ref: libraries/yaml integration-with-other-libraries2855351
Ref: 12ff2855351
Node: Future Enhancements2855682
Ref: libraries/yaml future-enhancements2855820
Ref: 13002855820
Node: See Also2856234
Ref: libraries/yaml see-also2856331
Ref: 13012856331
Node: z_score_anomaly_detector2856547
Ref: libraries/z_score_anomaly_detector doc2856666
Ref: 13022856666
Ref: libraries/z_score_anomaly_detector library-z-score-anomaly-detector2856666
Ref: 13032856666
Ref: libraries/z_score_anomaly_detector z-score-anomaly-detector2856666
Ref: 13042856666
Node: API documentation<229>2857950
Ref: libraries/z_score_anomaly_detector api-documentation2858074
Ref: 13052858074
Node: Loading<231>2858204
Ref: libraries/z_score_anomaly_detector loading2858349
Ref: 13062858349
Node: Testing<222>2858496
Ref: libraries/z_score_anomaly_detector testing2858631
Ref: 13072858631
Node: Features<81>2858789
Ref: libraries/z_score_anomaly_detector features2858923
Ref: 13082858923
Node: Options<74>2862301
Ref: libraries/z_score_anomaly_detector options2862449
Ref: 13092862449
Node: Detector representation<8>2863319
Ref: libraries/z_score_anomaly_detector detector-representation2863464
Ref: 130a2863464
Node: Notes<14>2864223
Ref: libraries/z_score_anomaly_detector notes2864348
Ref: 130b2864348
Node: zippers2866280
Ref: libraries/zippers doc2866386
Ref: 130c2866386
Ref: libraries/zippers library-zippers2866386
Ref: 130d2866386
Ref: libraries/zippers zippers2866386
Ref: 130e2866386
Node: API documentation<230>2866573
Ref: libraries/zippers api-documentation2866680
Ref: 130f2866680
Node: Loading<232>2866810
Ref: libraries/zippers loading2866938
Ref: 13102866938
Node: Testing<223>2867084
Ref: libraries/zippers testing2867181
Ref: 13112867181
Node: Ports2867322
Ref: ports/index doc2867427
Ref: 13122867427
Ref: ports/index ports2867427
Ref: 13132867427
Node: fcube2867587
Ref: ports/fcube doc2867670
Ref: 13142867670
Ref: ports/fcube fcube2867670
Ref: 13152867670
Ref: ports/fcube library-fcube2867670
Ref: 13162867670
Node: API documentation<231>2868978
Ref: ports/fcube api-documentation2869083
Ref: 13172869083
Node: Loading<233>2869207
Ref: ports/fcube loading2869333
Ref: 13182869333
Node: Testing<224>2869470
Ref: ports/fcube testing2869565
Ref: 13192869565
Node: metagol2869697
Ref: ports/metagol doc2869795
Ref: 131a2869795
Ref: ports/metagol library-metagol2869795
Ref: 131b2869795
Ref: ports/metagol metagol2869795
Ref: 131c2869795
Node: API documentation<232>2871687
Ref: ports/metagol api-documentation2871794
Ref: 131d2871794
Node: Loading<234>2871920
Ref: ports/metagol loading2872048
Ref: 131e2872048
Node: Testing<225>2872187
Ref: ports/metagol testing2872284
Ref: 131f2872284
Node: toychr2872527
Ref: ports/toychr doc2872611
Ref: 13202872611
Ref: ports/toychr library-toychr2872611
Ref: 13212872611
Ref: ports/toychr toychr2872611
Ref: 13222872611
Node: API documentation<233>2873599
Ref: ports/toychr api-documentation2873705
Ref: 13232873705
Node: Loading<235>2873830
Ref: ports/toychr loading2873957
Ref: 13242873957
Node: Testing<226>2874095
Ref: ports/toychr testing2874191
Ref: 13252874191
Node: Contributions2874324
Ref: contributions/index doc2874428
Ref: 13262874428
Ref: contributions/index contributions2874428
Ref: 13272874428
Node: flags2874652
Ref: contributions/flags doc2874743
Ref: 13282874743
Ref: contributions/flags flags2874743
Ref: 13292874743
Ref: contributions/flags library-flags2874743
Ref: 132a2874743
Node: API documentation<234>2875169
Ref: contributions/flags api-documentation2875274
Ref: 132b2875274
Node: Loading<236>2875398
Ref: contributions/flags loading2875524
Ref: 132c2875524
Node: Testing<227>2875662
Ref: contributions/flags testing2875757
Ref: 132d2875757
Node: iso86012875892
Ref: contributions/iso8601 doc2876003
Ref: 132e2876003
Ref: contributions/iso8601 iso86012876003
Ref: 132f2876003
Ref: contributions/iso8601 library-iso86012876003
Ref: 13302876003
Node: API documentation<235>2878587
Ref: contributions/iso8601 api-documentation2878694
Ref: 13312878694
Node: Loading<237>2878820
Ref: contributions/iso8601 loading2878948
Ref: 13322878948
Node: Testing<228>2879090
Ref: contributions/iso8601 testing2879187
Ref: 13332879187
Node: pddl_parser2879324
Ref: contributions/pddl_parser doc2879442
Ref: 13342879442
Ref: contributions/pddl_parser library-pddl-parser2879442
Ref: 13352879442
Ref: contributions/pddl_parser pddl-parser2879442
Ref: 13362879442
Node: API documentation<236>2880146
Ref: contributions/pddl_parser api-documentation2880257
Ref: 13372880257
Node: Loading<238>2880387
Ref: contributions/pddl_parser loading2880519
Ref: 13382880519
Node: Testing<229>2880663
Ref: contributions/pddl_parser testing2880764
Ref: 13392880764
Node: verdi_neruda2881193
Ref: contributions/verdi_neruda doc2881314
Ref: 133a2881314
Ref: contributions/verdi_neruda library-verdi-neruda2881314
Ref: 133b2881314
Ref: contributions/verdi_neruda verdi-neruda2881314
Ref: 133c2881314
Node: xml_parser2888582
Ref: contributions/xml_parser doc2888683
Ref: 133d2888683
Ref: contributions/xml_parser library-xml-parser2888683
Ref: 133e2888683
Ref: contributions/xml_parser xml-parser2888683
Ref: 133f2888683
Node: API documentation<237>2889349
Ref: contributions/xml_parser api-documentation2889459
Ref: 13402889459
Node: Loading<239>2889588
Ref: contributions/xml_parser loading2889719
Ref: 13412889719
Node: Testing<230>2889864
Ref: contributions/xml_parser testing2889989
Ref: 13422889989
Node: Known issues<22>2890129
Ref: contributions/xml_parser known-issues2890233
Ref: 13432890233
Node: Glossary2890457
Ref: glossary doc2890564
Ref: 13442890564
Ref: glossary glossary2890564
Ref: 13452890564
Ref: glossary id12890587
Ref: 3f2890587
Ref: glossary term-abstract-class2890587
Ref: 13462890587
Ref: glossary term-abstract-method2890771
Ref: 13482890771
Ref: glossary term-adapter-file2890978
Ref: 1542890978
Ref: glossary term-after-method2891153
Ref: 134b2891153
Ref: glossary term-ancestor2891251
Ref: 134c2891251
Ref: glossary term-around-method2891652
Ref: 134e2891652
Ref: glossary term-backend-Prolog-compiler2891815
Ref: 342891815
Ref: glossary term-before-method2892038
Ref: 134f2892038
Ref: glossary term-built-in-method2892137
Ref: 13502892137
Ref: glossary term-built-in-predicate2892383
Ref: 13512892383
Ref: glossary term-category2892569
Ref: 134a2892569
Ref: glossary term-class2892919
Ref: 13472892919
Ref: glossary term-clause-reference2893198
Ref: 1b82893198
Ref: glossary term-closed-world-assumption2893350
Ref: 6a2893350
Ref: glossary term-closure2893680
Ref: 14f2893680
Ref: glossary term-coinductive-predicate2893891
Ref: 1702893891
Ref: glossary term-complementing-category2894115
Ref: 13532894115
Ref: glossary term-component2894237
Ref: 3532894237
Ref: glossary term-debug-handler2894550
Ref: 3382894550
Ref: glossary term-directive2894718
Ref: 13542894718
Ref: glossary term-discontiguous-predicate2894867
Ref: 4b82894867
Ref: glossary term-doclet-file2895060
Ref: 13552895060
Ref: glossary term-doclet-object2895202
Ref: 63c2895202
Ref: glossary term-dynamic-binding2895397
Ref: 362895397
Ref: glossary term-dynamic-entity2895773
Ref: 13562895773
Ref: glossary term-dynamic-predicate2895819
Ref: 4be2895819
Ref: glossary term-early-binding2895925
Ref: 13582895925
Ref: glossary term-encapsulation2895976
Ref: 13592895976
Ref: glossary term-entity2896233
Ref: 13572896233
Ref: glossary term-entity-alias2896713
Ref: c92896713
Ref: glossary term-entity-directive2897145
Ref: 135b2897145
Ref: glossary term-event2897255
Ref: 135c2897255
Ref: glossary term-expansion-workflow2897566
Ref: 135d2897566
Ref: glossary term-flaky-test2897782
Ref: 13602897782
Ref: glossary term-goal-expansion2898055
Ref: 135f2898055
Ref: glossary term-grammar-rule2898513
Ref: 13612898513
Ref: glossary term-grammar-rule-non-terminal2898936
Ref: 13622898936
Ref: glossary term-grammar-rule-terminal2899164
Ref: 13632899164
Ref: glossary term-homoiconic2899231
Ref: 72899231
Ref: glossary term-hook-object2899574
Ref: 39e2899574
Ref: glossary term-hook-predicate2899997
Ref: 16d2899997
Ref: glossary term-hot-patching2900204
Ref: 10b2900204
Ref: glossary term-identity2900549
Ref: 135a2900549
Ref: glossary term-inheritance2900964
Ref: 442900964
Ref: glossary term-instance2901432
Ref: 13672901432
Ref: glossary term-instantiation2901636
Ref: 13682901636
Ref: glossary term-interface2901899
Ref: 13692901899
Ref: glossary term-lambda-expression2901940
Ref: 1822901940
Ref: glossary term-lambda-free-variable2902289
Ref: 2702902289
Ref: glossary term-lambda-parameter2902492
Ref: 2712902492
Ref: glossary term-late-binding2902742
Ref: 136a2902742
Ref: glossary term-library2902793
Ref: 6e2902793
Ref: glossary term-library-alias2902920
Ref: 136b2902920
Ref: glossary term-library-notation2903186
Ref: 2a82903186
Ref: glossary term-loader-file2903548
Ref: 4f2903548
Ref: glossary term-local-predicate2903725
Ref: 562903725
Ref: glossary term-message2904123
Ref: 432904123
Ref: glossary term-message-lookup2904323
Ref: 372904323
Ref: glossary term-message-to-self2904699
Ref: 17d2904699
Ref: glossary term-meta-argument2904913
Ref: 136c2904913
Ref: glossary term-meta-interpreter2905153
Ref: 136d2905153
Ref: glossary term-meta-predicate2905256
Ref: 522905256
Ref: glossary term-meta-variable2905436
Ref: 1832905436
Ref: glossary term-metaclass2905582
Ref: 722905582
Ref: glossary term-method2905830
Ref: 13492905830
Ref: glossary term-mocking2906118
Ref: 136e2906118
Ref: glossary term-module2906364
Ref: 136f2906364
Ref: glossary term-monitor2906680
Ref: 31e2906680
Ref: glossary term-multifile-predicate2906919
Ref: 16b2906919
Ref: glossary term-naked-meta-variable2907336
Ref: 7b82907336
Ref: glossary term-object2907643
Ref: 5332907643
Ref: glossary term-object-database2908002
Ref: 1b02908002
Ref: glossary term-parameter2908081
Ref: 13702908081
Ref: glossary term-parameter-variable2908286
Ref: a12908286
Ref: glossary term-parametric-category2908738
Ref: 13712908738
Ref: glossary term-parametric-entity2908799
Ref: 6a02908799
Ref: glossary term-parametric-object2909362
Ref: 4252909362
Ref: glossary term-parametric-object-proxy2909421
Ref: 3fa2909421
Ref: glossary term-parent2909608
Ref: 13722909608
Ref: glossary term-polymorphism2909686
Ref: 13732909686
Ref: glossary term-predicate2910492
Ref: 612910492
Ref: glossary term-predicate-alias2910789
Ref: ca2910789
Ref: glossary term-predicate-calling-context2911310
Ref: 1502911310
Ref: glossary term-predicate-declaration2911502
Ref: 572911502
Ref: glossary term-predicate-definition2911682
Ref: 582911682
Ref: glossary term-predicate-definition-context2911872
Ref: 1512911872
Ref: glossary term-predicate-directive2911998
Ref: 13522911998
Ref: glossary term-predicate-execution-context2912130
Ref: 35e2912130
Ref: glossary term-predicate-scope-container2912322
Ref: 3f92912322
Ref: glossary term-predicate-scope-directive2912502
Ref: 1e42912502
Ref: glossary term-predicate-shorthand2912647
Ref: 1612912647
Ref: glossary term-primary-predicate-declaration2913187
Ref: 3922913187
Ref: glossary term-private-inheritance2913260
Ref: 13662913260
Ref: glossary term-private-predicate2913451
Ref: 552913451
Ref: glossary term-profiler2913579
Ref: 13742913579
Ref: glossary term-protected-inheritance2913657
Ref: 13652913657
Ref: glossary term-protected-predicate2913879
Ref: 542913879
Ref: glossary term-protocol2914058
Ref: 592914058
Ref: glossary term-prototype2914559
Ref: 134d2914559
Ref: glossary term-public-inheritance2914898
Ref: 13642914898
Ref: glossary term-public-predicate2915072
Ref: 532915072
Ref: glossary term-scratch-directory2915144
Ref: 2932915144
Ref: glossary term-self2915297
Ref: 692915297
Ref: glossary term-sender2915375
Ref: 3992915375
Ref: glossary term-settings-file2915611
Ref: 492915611
Ref: glossary term-singleton-method2915878
Ref: 13752915878
Ref: glossary term-source-file2916091
Ref: 61c2916091
Ref: glossary term-source-file-directive2916505
Ref: 13762916505
Ref: glossary term-specialization2916620
Ref: 13772916620
Ref: glossary term-static-binding2916764
Ref: 352916764
Ref: glossary term-static-entity2917225
Ref: 13782917225
Ref: glossary term-steadfastness2917270
Ref: 2c42917270
Ref: glossary term-subclass2917605
Ref: 632917605
Ref: glossary term-super-call2917757
Ref: 1152917757
Ref: glossary term-superclass2918101
Ref: 602918101
Ref: glossary term-synchronized-predicate2918280
Ref: 1752918280
Ref: glossary term-template-method2918469
Ref: 13792918469
Ref: glossary term-term-expansion2918525
Ref: 135e2918525
Ref: glossary term-test-dialect2918989
Ref: 137a2918989
Ref: glossary term-test-outcome2919191
Ref: 137b2919191
Ref: glossary term-tester-file2919386
Ref: 137c2919386
Ref: glossary term-this2919497
Ref: 1142919497
Ref: glossary term-threaded-engine2919795
Ref: 2ba2919795
Ref: glossary term-top-level-interpreter-shorthand2920112
Ref: 137d2920112
Ref: glossary term-visible-predicate2920388
Ref: 137e2920388
Ref: bibliography alexiev932920581
Ref: 137f2920581
Ref: bibliography belli-et-al-922920765
Ref: 13802920765
Ref: bibliography block892921052
Ref: 13812921052
Ref: bibliography bobrow-et-al-882921156
Ref: 1fd2921156
Ref: bibliography bratko902921326
Ref: 13822921326
Ref: bibliography champaux922921430
Ref: 28d2921430
Ref: bibliography clocksin872921583
Ref: 13832921583
Ref: bibliography cointe872921681
Ref: 9c2921681
Ref: bibliography cordes912921792
Ref: 13842921792
Ref: bibliography covington942921891
Ref: 13852921891
Ref: bibliography cox862922025
Ref: 1d2922025
Ref: bibliography davison892922155
Ref: 13862922155
Ref: bibliography davison922922266
Ref: 13872922266
Ref: bibliography davison932922489
Ref: 13882922489
Ref: bibliography delzanno972922703
Ref: 13892922703
Ref: bibliography dony902922901
Ref: 138a2922901
Ref: bibliography fornarino-et-al-892923028
Ref: 122923028
Ref: bibliography fromherz932923293
Ref: 292923293
Ref: bibliography fukunaga862923398
Ref: 138b2923398
Ref: bibliography goldberg832923540
Ref: 1c2923540
Ref: bibliography joy-et-al-002923670
Ref: 1e2923670
Ref: bibliography iso952923800
Ref: 312923800
Ref: bibliography knuth842923971
Ref: 138c2923971
Ref: bibliography lieberman862924055
Ref: 192924055
Ref: bibliography maes872924204
Ref: 142924204
Ref: bibliography mccabe922924304
Ref: 282924304
Ref: bibliography moon862924389
Ref: 10a2924389
Ref: bibliography moss942924479
Ref: 1fc2924479
Ref: bibliography moura942924621
Ref: 9d2924621
Ref: bibliography moura992924812
Ref: 138d2924812
Ref: bibliography moura002924987
Ref: 138e2924987
Ref: bibliography razek922925101
Ref: 132925101
Ref: bibliography rumbaugh872925194
Ref: 102925194
Ref: bibliography rumbaugh882925321
Ref: 112925321
Ref: bibliography schachte952925452
Ref: 138f2925452
Ref: bibliography sicstus952925710
Ref: 2a2925710
Ref: bibliography shan-et-al-932925788
Ref: 1ff2925788
Ref: bibliography stefik-et-al-862925951
Ref: 2022925951
Ref: bibliography stroustrup862926119
Ref: 232926119
Ref: bibliography taenzer892926221
Ref: 1fe2926221
Ref: bibliography tanzer952926404
Ref: 13902926404
Ref: bibliography tanenbaum872926552
Ref: 2032926552
Ref: bibliography welsch892926663
Ref: 13912926663
Ref: Glossary-Footnote-12926929
Ref: Glossary-Footnote-22926974
Ref: Glossary-Footnote-32927019
Ref: Glossary-Footnote-42927066
Node: Index<2>2927111
Ref: genindex doc2927210
Ref: 13922927210
Ref: genindex index2927210
Ref: 13932927210
Node: Index2927229

End Tag Table


Local Variables:
coding: utf-8
End:
