Integer

interface Integer: Numeric, Any

Fields

Name Description
open isInteger: Boolean

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

abstract value: BigInteger
open decimalValue: BigDecimal
open intValue: BigInteger

Methods

freshCopy

abstract fun freshCopy(): Integer

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
Integer

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

freshCopy

abstract fun freshCopy(scope: Scope): Integer

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
Integer

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

asInteger

open fun asInteger(): Integer

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

ReturnValue

Name Description
Integer

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

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

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

CompanionObject

Integer

interface Integer: Numeric, Any

Fields

Name Description
val PATTERN: @JvmField
val ZERO: Integer
val ONE: Integer
val MINUS_ONE: Integer

Methods

of

fun of(integer: BigInteger): Integer

Parameters

Name Description
integer: BigInteger

ReturnValue

Name Description
Integer

of

fun of(integer: Long): Integer

Parameters

Name Description
integer: Long

ReturnValue

Name Description
Integer

of

fun of(integer: Int): Integer

Parameters

Name Description
integer: Int

ReturnValue

Name Description
Integer

of

fun of(integer: Short): Integer

Parameters

Name Description
integer: Short

ReturnValue

Name Description
Integer

of

fun of(integer: Byte): Integer

Parameters

Name Description
integer: Byte

ReturnValue

Name Description
Integer

of

fun of(integer: String): Integer

Parameters

Name Description
integer: String

ReturnValue

Name Description
Integer

of

fun of(integer: String, radix: Int): Integer

Parameters

Name Description
integer: String
radix: Int

ReturnValue

Name Description
Integer

Extensions

parse

fun Integer.Companion.parse(input: String, operators: OperatorSet): Integer

Receiver

Name Description
Integer.Companion

Parameters

Name Description
input: String
operators: OperatorSet

ReturnValue

Name Description
Integer

parse

fun Integer.Companion.parse(input: String): Integer

Receiver

Name Description
Integer.Companion

Parameters

Name Description
input: String

ReturnValue

Name Description
Integer