solve/it.unibo.tuprolog.solve/SolveOptions

SolveOptions

Configuration for a single Solver.solve invocation: whether solutions are computed lazily or eagerly, how long resolution may run for, how many solutions to cap at, and any implementation-specific extra knob.

Instances are immutable; the set*/add* methods all return a new SolveOptions rather than mutating the receiver. Build one via the companion's factories -- allLazily, someLazily, allEagerly, someEagerly, their ...WithTimeout variants, or the general of -- or start from DEFAULT and tweak it, e.g. SolveOptions.DEFAULT.setLimit(1).

Types

Companion

object Companion

Properties

customOptions

abstract val customOptions: Map<String, Any>

Implementation-specific extra options, keyed by name, that a particular Solver strategy may interpret.

isEager

open val isEager: Boolean

The negation of isLazy: true if solutions are computed eagerly, ahead of consuming the sequence.

isLazy

abstract val isLazy: Boolean

Whether Solver.solve should stream solutions on demand as the returned Sequence is consumed (true), or compute the whole (bounded) solution set eagerly before returning (false, see isEager).

isLimited

open val isLimited: Boolean

Whether limit actually caps the number of produced solutions (i.e. limit is not ALL_SOLUTIONS).

limit

abstract val limit: Int

The maximum number of solutions to produce, or ALL_SOLUTIONS (i.e. -1) for no cap.

timeout

abstract val timeout: TimeDuration

The maximum duration resolution is allowed to run for, before being aborted; defaults to MAX_TIMEOUT.

Functions

addOption

open fun <X : Any> addOption(key: String, value: X): SolveOptions

Returns a copy of these options with a single custom option, key, added (or overridden) with value.

addOptions

open fun <X : Any> addOptions(options: Map<String, X>): SolveOptions

Returns a copy of these options with customOptions merged with (and overridden by) options.

setLazy

abstract fun setLazy(value: Boolean): SolveOptions

Returns a copy of these options with isLazy set to value.

setLimit

abstract fun setLimit(value: Int): SolveOptions

Returns a copy of these options with limit set to value.

setOption

open fun <X : Any> setOption(key: String, value: X): SolveOptions

Returns a copy of these options with a single custom option, key, replaced by value.

setOptions

abstract fun <X : Any> setOptions(options: Map<String, X>): SolveOptions

Returns a copy of these options with customOptions replaced entirely by options.

setTimeout

abstract fun setTimeout(value: TimeDuration): SolveOptions

Returns a copy of these options with timeout set to value.

SolveOptions

See also

Types

Properties

Functions