API on Arg2p Wiki

Engine predicates

Mon, 01 Jan 0001 00:00:00 +0000

Engine Interface

All the predicates below belong to the arg2p module, and the recommended way to call them is through the module prefix — arg2p::solve(Goal, Res), arg2p::buildLabelSets(...) and so on. The unqualified form works too where arg2p is a static library, as in the solvers of Arg2pSolver.default(), but the qualified one states where the predicate comes from and keeps working if your own theory defines a predicate with the same name.

Flags

Mon, 01 Jan 0001 00:00:00 +0000

Flags Reference

Flags are ordinary Prolog facts. The engine reads them from the knowledge base while it evaluates a theory, so a flag can be set in three ways:

in the theory itself, by writing the fact (e.g. queryMode.);
from the API, through Flags (in Kotlin, JavaScript and Python), each flag with a method taking a value of its enumeration (Semantics.PREFERRED, Profile.ABA, …);
from the playground and the extension of VS Code, through the Flags panel of the solver.

A flag stated in the theory replaces the value the solver was given for it: a theory stating graphExtension(bp). has only that extension, not the standardPref of Flags.defaults() as well. graphExtension(none). states no extension, and a switch is turned off by Switch(off). (e.g. autoTransposition(off).).

Kotlin

Mon, 01 Jan 0001 00:00:00 +0000

Kotlin API

There are two ways to use Arg2P from Kotlin or Java:

The API of arg2p — Arg2p, a solver for a theory: its answers, graphs and solutions as Kotlin objects, its flags as enumerations, and the causality tests. Start here: it is the same API in JavaScript and, in snake case, in Python, and nothing of 2P-Kt is needed.
The 2P-Kt integration — load Arg2P as a library into your own Solver and query it with Prolog goals. Use this when you need the full Prolog interface, custom libraries, or an existing 2P-Kt setup.

The API is in the aggregate artifact arg2p (arg2p-jvm on the JVM), with every module of Arg2P (the core, the causality and the parallel solver), package it.unibo.tuprolog.argumentation.

JavaScript

Mon, 01 Jan 0001 00:00:00 +0000

JavaScript API

The npm package @tuprolog/arg2p exposes the API of arg2p to JavaScript, as it is in Kotlin: a solver for a theory (Arg2p), its flags (Flags, with an enumeration for the values of each), its answers, graphs and solutions, the values of Prolog terms (Value), the causality tests, and the clusters of the parallel solver. Nothing of tuProlog is needed.

{
 "dependencies": {
 "@tuprolog/arg2p": "0.21.0"
 }
}

import { Arg2p, Flags, Value, Semantics, Profile, GraphExtension } from '@tuprolog/arg2p'

The package is an ES module (Node.js, bundlers, Deno, browsers), every declaration of the API exported by its name.

Python

Mon, 01 Jan 0001 00:00:00 +0000

Python API

The Python package arg2p is the API of arg2p in snake case: a solver for a theory (Arg2p), its flags (Flags, with an enumeration for the values of each), its answers, graphs and solutions, the causality tests, and the clusters of the parallel solver. It runs the library of the JVM through JPype, on the Java runtime its wheel bundles: no Java is needed.

pip install arg2p

The wheels of Windows (x86-64), Linux (x86-64, ARM64) and macOS (ARM64, x86-64) bundle a Java runtime; on another platform the package runs on the Java of the system (21 or later, JAVA_HOME). ARG2P_JVM names another library of the JVM to run on (arg2p mcp runs the java of its runtime), ARG2P_CLASSPATH other jars, put before those of the package: their classes are the ones loaded, and the package gives those they lack.

Kotlin & JS reference

Mon, 01 Jan 0001 00:00:00 +0000

Kotlin & JS reference

The reference of every public class and function of the core (core), of the causality solver and of the npm package @tuprolog/arg2p, generated by Dokka from their KDoc. The declarations usable from JavaScript are those of the js packages (see JavaScript).

Open the reference