MagicCut

object MagicCut: Atom, Any

Fields

Name Description
const FUNCTOR: String
val isConstant: Boolean
val isAtom: Boolean

Checks whether the current term is an atom. This method is guaranteed to return true if and only if the current term is an instance of Atom.

val isStruct: Boolean

Methods

asConstant

fun asConstant(): Constant

ReturnValue

Name Description
Constant

castToConstant

fun castToConstant(): Constant

ReturnValue

Name Description
Constant

toString

fun toString(): String

ReturnValue

Name Description
String

freshCopy

fun freshCopy(): Atom

Returns a fresh copy of this Term, that is, an instance of Term which is equal to the current one in any aspect, except variables directly or indirectly contained into this Term, which are refreshed. This means that it could return itself, if no variable is present (ground term), or a new Term with freshly generated variables.

Variables are refreshed consistently, meaning that, if more variables exists within this Term having the same name, all fresh copies of such variables will have the same complete name.

Example: "f(X, g(X))".freshCopy() returns something like "f(X_1, g(X_1))" instead of "f(X_1, g(X_2))"

Notice that, if the current term is ground, the same object may be returned as a result by this method.

ReturnValue

Name Description
Atom

a fresh copy of the current term which is different because variables are consistently renamed

freshCopy

fun freshCopy(scope: Scope): Atom

Returns a fresh copy of this Term, similarly to freshCopy, possibly reusing variables from the provided scope, if any

Parameters

Name Description
scope: Scope

the Scope containing variables to be used in copying

ReturnValue

Name Description
Atom

a fresh copy of the current term which is different because variables are consistently renamed

apply

fun apply(substitution: Substitution): Term

Parameters

Name Description
substitution: Substitution

ReturnValue

Name Description
Term

apply

fun apply(substitution: Substitution, vararg substitutions: Substitution): Term

Parameters

Name Description
substitution: Substitution
vararg substitutions: Substitution

ReturnValue

Name Description
Term

get

fun get(substitution: Substitution, vararg substitutions: Substitution): Term

Parameters

Name Description
substitution: Substitution
vararg substitutions: Substitution

ReturnValue

Name Description
Term

accept

fun <T> accept(visitor: TermVisitor<T>): T

Parameters

Name Description
visitor: TermVisitor<T>

ReturnValue

Name Description
T

asAtom

fun asAtom(): Atom

Casts the current Term to Atom, if possible, or returns null otherwise

ReturnValue

Name Description
Atom

the current Term, casted to Atom, or null, if the current term is not an instance of Atom

asStruct

fun asStruct(): Struct

ReturnValue

Name Description
Struct

castToAtom

fun castToAtom(): Atom

ReturnValue

Name Description
Atom

castToStruct

fun castToStruct(): Struct

ReturnValue

Name Description
Struct

Extensions

toClause

fun Term.toClause(source: Any?, line: Int, column: Int): Clause

Receiver

Name Description
Term

Parameters

Name Description
source: Any?
line: Int
column: Int

ReturnValue

Name Description
Clause

unfoldGoals

fun Term.unfoldGoals(): Sequence<Term>

Receiver

Name Description
Term

ReturnValue

Name Description
Sequence<Term>

toGoals

fun Term.toGoals(): Cursor<Term>

Receiver

Name Description
Term

ReturnValue

Name Description
Cursor<Term>

isWellFormed

fun Term.isWellFormed(): Boolean

Check whether the receiver term is a well-formed predication

Receiver

Name Description
Term

ReturnValue

Name Description
Boolean

prepareForExecutionAsGoal

fun Term.prepareForExecutionAsGoal(): Struct

Prepares the receiver Goal for execution

For example, the goal A is transformed, after preparation for execution, as the Term: call(A)

Receiver

Name Description
Term

ReturnValue

Name Description
Struct

extractSignature

fun Struct.extractSignature(): Signature

Extracts this Struct indicator and converts it to Signature

Receiver

Name Description
Struct

ReturnValue

Name Description
Signature

evalAsExpression

fun Term.evalAsExpression(request: Request<*>, index: Int?): Term

Receiver

Name Description
Term

Parameters

Name Description
request: Request<*>
index: Int?

ReturnValue

Name Description
Term

evalAsArithmeticExpression

fun Term.evalAsArithmeticExpression(request: Request<*>, index: Int?): Numeric

Receiver

Name Description
Term

Parameters

Name Description
request: Request<*>
index: Int?

ReturnValue

Name Description
Numeric

eq

infix fun Term.eq(that: Term): Equation

Creates an equation with this and that terms

Receiver

Name Description
Term

Parameters

Name Description
that: Term

ReturnValue

Name Description
Equation