primitive
The primitives of the standard library, i.e. its predicates implemented in Kotlin.
Each constant is a primitive with a signature (its name and arity in Prolog, e.g.
atom_length/2), loaded by default in Prolog solvers; most are ISO Prolog's built-in predicates.
Their implementation is the tuprolog.solve.primitive.Primitive solving them.
Atom, Clause, Integer and Var are left out of __all__, as star-imports would shadow the
homonymous types of tuprolog.core: use them qualified (e.g. primitive.Atom).
Examples:
>>> AtomLength.signature
Signature(name=atom_length, arity=2, vararg=false)
module-attribute
¶
Abolish: Abolish = _primitive.Abolish.INSTANCE
The primitive abolish/1.
Removes all the clauses of a dynamic predicate, given its indicator.
module-attribute
¶
Arg: Arg = _primitive.Arg.INSTANCE
The primitive arg/3: the N-th argument of a compound term.
module-attribute
¶
ArithmeticEqual: ArithmeticEqual = (
_primitive.ArithmeticEqual.INSTANCE
)
The primitive =:=/2: two arithmetic expressions evaluate to equal numbers.
module-attribute
¶
ArithmeticGreaterThan: ArithmeticGreaterThan = (
_primitive.ArithmeticGreaterThan.INSTANCE
)
The primitive >/2: an arithmetic expression evaluates to more than another.
module-attribute
¶
ArithmeticGreaterThanOrEqualTo: ArithmeticGreaterThanOrEqualTo = _primitive.ArithmeticGreaterThanOrEqualTo.INSTANCE
The primitive >=/2: an expression evaluates to at least another.
module-attribute
¶
ArithmeticLowerThan: ArithmeticLowerThan = (
_primitive.ArithmeticLowerThan.INSTANCE
)
The primitive </2: an arithmetic expression evaluates to less than another.
module-attribute
¶
ArithmeticLowerThanOrEqualTo: ArithmeticLowerThanOrEqualTo = _primitive.ArithmeticLowerThanOrEqualTo.INSTANCE
The primitive =</2: an expression evaluates to at most another.
module-attribute
¶
ArithmeticNotEqual: ArithmeticNotEqual = (
_primitive.ArithmeticNotEqual.INSTANCE
)
The primitive =\=/2: two arithmetic expressions evaluate to different numbers.
module-attribute
¶
Assert: Assert = _primitive.Assert.INSTANCE
The primitive assert/1: adds a clause at the end of the dynamic knowledge base.
module-attribute
¶
AssertA: AssertA = _primitive.AssertA.INSTANCE
The primitive asserta/1: adds a clause at the beginning of the dynamic knowledge base.
module-attribute
¶
AssertZ: AssertZ = _primitive.AssertZ.INSTANCE
The primitive assertz/1: adds a clause at the end of the dynamic knowledge base.
module-attribute
¶
Atom: Atom = _primitive.Atom.INSTANCE
The primitive atom/1: a term is an atom.
module-attribute
¶
AtomChars: AtomChars = _primitive.AtomChars.INSTANCE
The primitive atom_chars/2: relates an atom to the list of its characters.
module-attribute
¶
AtomCodes: AtomCodes = _primitive.AtomCodes.INSTANCE
The primitive atom_codes/2: relates an atom to the list of its character codes.
module-attribute
¶
AtomConcat: AtomConcat = _primitive.AtomConcat.INSTANCE
The primitive atom_concat/3: an atom is the concatenation of two others.
module-attribute
¶
AtomLength: AtomLength = _primitive.AtomLength.INSTANCE
The primitive atom_length/2: the number of characters of an atom.
module-attribute
¶
Atomic: Atomic = _primitive.Atomic.INSTANCE
The primitive atomic/1: a term is atomic, i.e. an atom or a number.
module-attribute
¶
BagOf: BagOf = _primitive.BagOf.INSTANCE
The primitive bagof/3: the list of the instances of a template for the solutions of a goal.
module-attribute
¶
Between: Between = _primitive.Between.INSTANCE
The primitive between/3: an integer is between two others, inclusive.
module-attribute
¶
Callable: Callable = _primitive.Callable.INSTANCE
The primitive callable/1: a term is callable, i.e. an atom or a compound term.
module-attribute
¶
CharCode: CharCode = _primitive.CharCode.INSTANCE
The primitive char_code/2: relates a character to its code.
module-attribute
¶
Clause: Clause = _primitive.Clause.INSTANCE
The primitive clause/2: a clause of the knowledge base, by head and body.
module-attribute
¶
Compound: Compound = _primitive.Compound.INSTANCE
The primitive compound/1: a term is a compound term.
module-attribute
¶
CopyTerm: CopyTerm = _primitive.CopyTerm.INSTANCE
The primitive copy_term/2: a copy of a term, with fresh variables.
module-attribute
¶
CurrentFlag: CurrentFlag = _primitive.CurrentFlag.INSTANCE
The primitive current_flag/2: a flag and its value.
module-attribute
¶
CurrentOp: CurrentOp = _primitive.CurrentOp.INSTANCE
The primitive current_op/3: an operator, by priority, specifier and symbol.
module-attribute
¶
EnsureExecutable: EnsureExecutable = (
_primitive.EnsureExecutable.INSTANCE
)
The primitive ensure_executable/1: raises an error unless a term is callable.
module-attribute
¶
FindAll: FindAll = _primitive.FindAll.INSTANCE
The primitive findall/3.
The list of the instances of a template for all the solutions of a goal.
module-attribute
¶
Float: Float = _primitive.Float.INSTANCE
The primitive float/1: a term is a floating-point number.
module-attribute
¶
Functor: Functor = _primitive.Functor.INSTANCE
The primitive functor/3: relates a term to its name and arity.
module-attribute
¶
GetDurable: GetDurable = _primitive.GetDurable.INSTANCE
The primitive get_durable/2: a value of the durable custom data, by key.
module-attribute
¶
GetEphemeral: GetEphemeral = (
_primitive.GetEphemeral.INSTANCE
)
The primitive get_ephemeral/2: a value of the ephemeral custom data, by key.
module-attribute
¶
GetPersistent: GetPersistent = (
_primitive.GetPersistent.INSTANCE
)
The primitive get_persistent/2: a value of the persistent custom data, by key.
module-attribute
¶
Ground: Ground = _primitive.Ground.INSTANCE
The primitive ground/1: a term has no variables.
module-attribute
¶
Halt: Halt = _primitive.Halt.INSTANCE
The primitive halt/0: stops the resolution.
module-attribute
¶
Halt1: Halt1 = _primitive.Halt1.INSTANCE
The primitive halt/1: stops the resolution, with an exit code.
module-attribute
¶
Integer: Integer = _primitive.Integer.INSTANCE
The primitive integer/1: a term is an integer.
module-attribute
¶
InternalHelp: InternalHelp = (
_primitive.InternalHelp.INSTANCE
)
The primitive __help__/2: the help text of a subject, behind help/2.
module-attribute
¶
Is: Is = _primitive.Is.INSTANCE
The primitive is/2: the value of an arithmetic expression.
module-attribute
¶
Natural: Natural = _primitive.Natural.INSTANCE
The primitive natural/1: a term is a natural number, or generates them if a variable.
module-attribute
¶
NewLine: NewLine = _primitive.NewLine.INSTANCE
The primitive nl/0: writes a new line on the current output.
module-attribute
¶
NonVar: NonVar = _primitive.NonVar.INSTANCE
The primitive nonvar/1: a term is not a variable.
module-attribute
¶
NotUnifiableWith: NotUnifiableWith = (
_primitive.NotUnifiableWith.INSTANCE
)
The primitive \=/2: two terms do not unify.
module-attribute
¶
Number: Number = _primitive.Number.INSTANCE
The primitive number/1: a term is a number.
module-attribute
¶
NumberChars: NumberChars = _primitive.NumberChars.INSTANCE
The primitive number_chars/2: relates a number to the list of its characters.
module-attribute
¶
NumberCodes: NumberCodes = _primitive.NumberCodes.INSTANCE
The primitive number_codes/2: relates a number to the list of its character codes.
module-attribute
¶
Op: Op = _primitive.Op.INSTANCE
The primitive op/3: declares an operator, by priority, specifier and symbol.
module-attribute
¶
Repeat: Repeat = _primitive.Repeat.INSTANCE
The primitive repeat/0: succeeds infinitely many times.
module-attribute
¶
Retract: Retract = _primitive.Retract.INSTANCE
The primitive retract/1: removes a clause from the dynamic knowledge base.
module-attribute
¶
RetractAll: RetractAll = _primitive.RetractAll.INSTANCE
The primitive retractall/1: removes the dynamic clauses whose head unifies with a term.
module-attribute
¶
Reverse: Reverse = _primitive.Reverse.INSTANCE
The primitive reverse/2: a list in reverse order.
module-attribute
¶
SetDurable: SetDurable = _primitive.SetDurable.INSTANCE
The primitive set_durable/2: sets a value of the durable custom data, by key.
module-attribute
¶
SetEphemeral: SetEphemeral = (
_primitive.SetEphemeral.INSTANCE
)
The primitive set_ephemeral/2: sets a value of the ephemeral custom data, by key.
module-attribute
¶
SetFlag: SetFlag = _primitive.SetFlag.INSTANCE
The primitive set_flag/2: sets the value of a flag.
module-attribute
¶
SetOf: SetOf = _primitive.SetOf.INSTANCE
The primitive setof/3: the sorted list, without duplicates, of the instances of a template.
module-attribute
¶
SetPersistent: SetPersistent = (
_primitive.SetPersistent.INSTANCE
)
The primitive set_persistent/2: sets a value of the persistent custom data, by key.
module-attribute
¶
Sleep: Sleep = _primitive.Sleep.INSTANCE
The primitive sleep/1: waits for a number of milliseconds.
module-attribute
¶
SubAtom: SubAtom = _primitive.SubAtom.INSTANCE
The primitive sub_atom/5: a sub-atom of an atom, by position and length.
module-attribute
¶
TermGreaterThan: TermGreaterThan = (
_primitive.TermGreaterThan.INSTANCE
)
The primitive @>/2: a term follows another in the standard order of terms.
module-attribute
¶
TermGreaterThanOrEqualTo: TermGreaterThanOrEqualTo = (
_primitive.TermGreaterThanOrEqualTo.INSTANCE
)
The primitive @>=/2: a term does not precede another in the standard order.
module-attribute
¶
TermIdentical: TermIdentical = (
_primitive.TermIdentical.INSTANCE
)
The primitive ==/2: two terms are identical.
module-attribute
¶
TermLowerThan: TermLowerThan = (
_primitive.TermLowerThan.INSTANCE
)
The primitive @</2: a term precedes another in the standard order of terms.
module-attribute
¶
TermLowerThanOrEqualTo: TermLowerThanOrEqualTo = (
_primitive.TermLowerThanOrEqualTo.INSTANCE
)
The primitive @=</2: a term does not follow another in the standard order.
module-attribute
¶
TermNotIdentical: TermNotIdentical = (
_primitive.TermNotIdentical.INSTANCE
)
The primitive \==/2: two terms are not identical.
module-attribute
¶
TermNotSame: TermNotSame = _primitive.TermNotSame.INSTANCE
The primitive \=@=/2: two terms are not variants of each other.
module-attribute
¶
TermSame: TermSame = _primitive.TermSame.INSTANCE
The primitive =@=/2: two terms are variants, i.e. equal up to variable renaming.
module-attribute
¶
UnifiesWith: UnifiesWith = _primitive.UnifiesWith.INSTANCE
The primitive =/2: unifies two terms.
module-attribute
¶
Univ: Univ = _primitive.Univ.INSTANCE
The primitive =../2: relates a term to the list of its name and arguments.
module-attribute
¶
Var: Var = _primitive.Var.INSTANCE
The primitive var/1: a term is a variable.
module-attribute
¶
Write: Write = _primitive.Write.INSTANCE
The primitive write/1: writes a term on the current output.