solve/it.unibo.tuprolog.solve.sideffects/SideEffect

SideEffect

abstract class SideEffect

A state change to be applied to an ExecutionContext after a it.unibo.tuprolog.solve.primitive.Primitive has run, rather than mutated directly by the primitive itself. Primitives attach zero or more SideEffects to their it.unibo.tuprolog.solve.primitive.Solve.Response (see it.unibo.tuprolog.solve.primitive.Solve.Request.replyWith), and the resolution strategy folds them, in order, over the context via ExecutionContext.apply -- each applyTo call producing a new, immutable ExecutionContext rather than mutating the one it receives.

Every concrete SideEffect subtype nested here covers one specific piece of mutable state a solver carries (clauses in either knowledge base, flags, libraries, operators, I/O channels, custom data), typically in both a "reset to" and "alter by adding/removing" flavour. SideEffectFactory/SideEffectsBuilder are the ergonomic way to construct these without naming each subtype explicitly.

See also

Solve.Response.sideEffects

Inheritors

AlterCustomData

Constructors

constructor()

Types

abstract class AddClausesToKb(clauses: Iterable<Clause>, val onTop: Boolean) : SideEffect.SetClausesOfKb

Base class for side effects adding clauses to a knowledge base, either at the front (onTop) or the back.

AddDynamicClauses

data class AddDynamicClauses(val clauses: Iterable<Clause>, val onTop: Boolean = false) : SideEffect.AddClausesToKb

Adds clauses to the dynamic knowledge base, at the front if onTop, at the back otherwise.

data class AddLibraries(val libraries: Runtime) : SideEffect.AlterAliasedRuntime

Adds every library in libraries to the loaded Runtime.

AddStaticClauses

data class AddStaticClauses(val clauses: Iterable<Clause>, val onTop: Boolean = false) : SideEffect.AddClausesToKb

Adds clauses to the static knowledge base, at the front if onTop, at the back otherwise.

AlterAliasedRuntime

abstract class AlterAliasedRuntime : SideEffect.AlterRuntime

Base class for AlterRuntime side effects expressible as a Runtime (a set of aliased Librarys).

abstract class AlterChannels : SideEffect

Base class for side effects altering the I/O channel stores.

AlterChannelsByName

abstract class AlterChannelsByName(val names: Iterable<String>) : SideEffect.AlterChannels

Base class for AlterChannels side effects addressing channels by names only (e.g. to close them).

AlterCustomData

abstract class AlterCustomData(val data: Map<String, Any>, val reset: Boolean = false) : SideEffect

Base class for side effects altering one it.unibo.tuprolog.solve.data.CustomDataStore tier with data, either merging it in, or replacing the tier outright if reset.

abstract class AlterFlags : SideEffect

Base class for side effects altering the FlagStore.

AlterFlagsByEntries

abstract class AlterFlagsByEntries(val flags: Map<String, Term>) : SideEffect.AlterFlags

Base class for AlterFlags side effects carrying explicit name-value flags entries.

AlterFlagsByName

abstract class AlterFlagsByName(val names: Iterable<String>) : SideEffect.AlterFlags

Base class for AlterFlags side effects addressing flags by names only (e.g. to clear them).

AlterInputChannels

abstract class AlterInputChannels(val inputChannels: Map<String, InputChannel<String>>) : SideEffect.AlterChannels

Base class for AlterChannels side effects carrying named inputChannels to add/set.

AlterLibrariesByName

abstract class AlterLibrariesByName(val aliases: Iterable<String>) : SideEffect.AlterRuntime

Base class for AlterRuntime side effects addressing libraries by aliases only.

abstract class AlterLibrary(val library: Library) : SideEffect.AlterAliasedRuntime

Base class for AlterRuntime side effects concerning a single library.

abstract class AlterOperators(val operators: Iterable<Operator>) : SideEffect

Base class for side effects altering the declared OperatorSet.

AlterOutputChannels

abstract class AlterOutputChannels(val outputChannels: Map<String, OutputChannel<String>>) : SideEffect.AlterChannels

Base class for AlterChannels side effects carrying named outputChannels to add/set.

abstract class AlterRuntime : SideEffect

Base class for side effects altering the loaded Runtime of libraries.

data class ClearFlags(val names: Iterable<String>) : SideEffect.AlterFlagsByName

Removes the flags named in names from the FlagStore.

CloseInputChannels

data class CloseInputChannels(val names: Iterable<String>) : SideEffect.AlterChannelsByName

Closes/removes the input channels named in names.

CloseOutputChannels

data class CloseOutputChannels(val names: Iterable<String>) : SideEffect.AlterChannelsByName

Closes/removes the output channels named in names.

data class LoadLibrary(val library: Library) : SideEffect.AlterLibrary

Adds library to the loaded Runtime.

OpenInputChannels

data class OpenInputChannels(val inputChannels: Map<String, InputChannel<String>>) : SideEffect.AlterInputChannels

Adds inputChannels to the input channel store (see it.unibo.tuprolog.solve.channel.InputStore).

OpenOutputChannels

data class OpenOutputChannels(val outputChannels: Map<String, OutputChannel<String>>) : SideEffect.AlterOutputChannels

Adds outputChannels to the output channel store (see it.unibo.tuprolog.solve.channel.OutputStore).

RemoveClausesFromKb

abstract class RemoveClausesFromKb(clauses: Iterable<Clause>) : SideEffect.SetClausesOfKb

Base class for side effects removing clauses from a knowledge base.

RemoveDynamicClauses

data class RemoveDynamicClauses(val clauses: Iterable<Clause>) : SideEffect.RemoveClausesFromKb

Removes clauses from the dynamic knowledge base.

RemoveOperators

data class RemoveOperators(val operators: Iterable<Operator>) : SideEffect.AlterOperators

Removes operators from the current OperatorSet.

RemoveStaticClauses

data class RemoveStaticClauses(val clauses: Iterable<Clause>) : SideEffect.RemoveClausesFromKb

Removes clauses from the static knowledge base.

data class ResetDynamicKb(val clauses: Iterable<Clause>) : SideEffect.SetClausesOfKb

Replaces the dynamic knowledge base with a MutableTheory built out of clauses.

data class ResetFlags(val flags: Map<String, Term>) : SideEffect.AlterFlagsByEntries

Replaces the whole FlagStore with one built out of flags.

ResetInputChannels

data class ResetInputChannels(val inputChannels: Map<String, InputChannel<String>>) : SideEffect.AlterInputChannels

Replaces the whole input channel store with inputChannels.

data class ResetOperators(val operators: Iterable<Operator>) : SideEffect.AlterOperators

Nominally replaces the whole OperatorSet with operators.

ResetOutputChannels

data class ResetOutputChannels(val outputChannels: Map<String, OutputChannel<String>>) : SideEffect.AlterOutputChannels

Replaces the whole output channel store with outputChannels.

data class ResetRuntime(val libraries: Runtime) : SideEffect.AlterAliasedRuntime

Replaces the whole loaded Runtime with libraries.

data class ResetStaticKb(val clauses: Iterable<Clause>) : SideEffect.SetClausesOfKb

Replaces the static knowledge base with a Theory built out of clauses.

abstract class SetClausesOfKb(val clauses: Iterable<Clause>) : SideEffect

Base class for side effects computing a Theory (or MutableTheory) out of clauses, for either knowledge base.

data class SetDurableData(val data: Map<String, Any>, val reset: Boolean = false) : SideEffect.AlterCustomData

Alters the it.unibo.tuprolog.solve.data.CustomDataStore.durable tier with data.

SetEphemeralData

data class SetEphemeralData(val data: Map<String, Any>, val reset: Boolean = false) : SideEffect.AlterCustomData

Alters the it.unibo.tuprolog.solve.data.CustomDataStore.ephemeral tier with data.

data class SetFlags(val flags: Map<String, Term>) : SideEffect.AlterFlagsByEntries

Merges flags into the current FlagStore, overriding any existing entry with the same name.

data class SetOperators(val operators: Iterable<Operator>) : SideEffect.AlterOperators

Merges operators into the current OperatorSet.

SetPersistentData

data class SetPersistentData(val data: Map<String, Any>, val reset: Boolean = false) : SideEffect.AlterCustomData

Alters the it.unibo.tuprolog.solve.data.CustomDataStore.persistent tier with data.

UnloadLibraries

data class UnloadLibraries(val aliases: Iterable<String>) : SideEffect.AlterLibrariesByName

Removes the libraries named in aliases from the loaded Runtime.

data class UpdateLibrary(val library: Library) : SideEffect.AlterLibrary

Replaces, within the loaded Runtime, the library sharing library's alias with library itself.

Functions

abstract fun applyTo(context: ExecutionContext): ExecutionContext

Produces the ExecutionContext resulting from applying this side effect to context.