BasicLibrary (prolobjectlink-jpi-jtrolog 1.2-SNAPSHOT API)

java.lang.Object
- jTrolog.lib.Library
- - jTrolog.lib.BasicLibrary

All Implemented Interfaces:

Serializable
```
public class BasicLibrary
extends Library
```
This class defines a set of basic built-in predicates for the tuProlog engine Library/Theory dependency: none

See Also:

Serialized Form

Field Summary
- Fields inherited from class jTrolog.lib.Library
  engine

Constructor Summary

Constructors
Constructor and Description

BasicLibrary()

Constructors
Constructor and Description
`BasicLibrary()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`$all_dynamic_predicate_indicators_1(BindingsTable bt, Term iterator)`
`boolean`	`$arg_3(BindingsTable bt, Int n, Struct term, Term arg)`
`boolean`	`$current_pred_impl_3(BindingsTable bt, Term name, Term arity, IteratorAsTerm allDynamicPIs)`
`boolean`	`$functor_3(BindingsTable bt, Term term, Term name, Term arity)`
`boolean`	`$has_next_1(BindingsTable bt, IteratorAsTerm iterator)`
`boolean`	`$list_diff_3(BindingsTable bt, Struct main, Struct retract, Var diff)`
`boolean`	`$stripBagList_5(BindingsTable bt, Struct witnessIn, Struct a_and_bSet, Term aSet, Term bSet, Term variant)`
`boolean`	`$tofromlist_2(BindingsTable bt, Term structIn, Term listIn)`
`boolean`	`add_theory_1(BindingsTable bt, Term th)` adds a new theory provided as a text
`static boolean`	`atom_1(BindingsTable bt, Term t)`
`static boolean`	`atomic_1(BindingsTable bt, Term t)`
`static boolean`	`compound_1(BindingsTable bt, Term t)`
`static boolean`	`constant_1(BindingsTable bt, Term t)`
`boolean`	`current_time_1(BindingsTable bt, Term time)`
`boolean`	`erase_1(BindingsTable bt, Number key)`
`boolean`	`erase_2(BindingsTable bt, Number key, Term list)`
`Term`	`eval_1(BindingsTable bt, EvaluableTerm structIn)`
`Term`	`expression_bitwise_and_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_bitwise_not_1(BindingsTable bt, EvaluableTerm structIn)`
`Term`	`expression_bitwise_or_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_bitwise_shift_left_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_bitwise_shift_right_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_div_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`boolean`	`expression_equality_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`boolean`	`expression_greater_or_equal_than_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`boolean`	`expression_greater_than_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_integer_div_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`boolean`	`expression_less_or_equal_than_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`boolean`	`expression_less_than_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_minus_1(BindingsTable bt, EvaluableTerm listIn)`
`Term`	`expression_minus_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_multiply_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_plus_1(BindingsTable bt, EvaluableTerm structIn)`
`Term`	`expression_plus_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`Term`	`expression_pow_2(BindingsTable bt, EvaluableTerm structIn, EvaluableTerm listIn)`
`static boolean`	`float_1(BindingsTable bt, Term t)`
`boolean`	`get_operators_list_1(BindingsTable bt, Struct argument)`
`boolean`	`get_theory_1(BindingsTable bt, Term arg)` gets current theory text
`String[]`	`getSynonym(String primitive)` Defines a map for synonyms for primitives.
`String`	`getTheory()`
`static boolean`	`ground_1(BindingsTable bt, Term t)`
`static boolean`	`integer_1(BindingsTable bt, Term t)`
`boolean`	`is_2(BindingsTable bt, Term structIn, EvaluableTerm listIn)`
`static boolean`	`list_1(BindingsTable bt, Term t)`
`boolean`	`load_library_2(BindingsTable bt, Struct className, Term libName)`
`boolean`	`new_record_key_1(BindingsTable bt, Var key)`
`boolean`	`nonvar_1(BindingsTable bt, Term t)`
`boolean`	`nowarning_0(BindingsTable bt)`
`boolean`	`num_atom_2(BindingsTable bt, Term structIn, Term listIn)`
`static boolean`	`number_1(BindingsTable bt, Term t)`
`static boolean`	`number_equality_2(Number listIn, Number structIn)`
`boolean`	`record_2(BindingsTable bt, Number key, Term unit)`
`boolean`	`recorded_2(BindingsTable bt, Number key, Term list)`
`boolean`	`set_theory_1(BindingsTable bt, Term th)` sets a new theory provided as a text
`static boolean`	`term_equality_2(BindingsTable bt, Term structIn, Term listIn)`
`static boolean`	`term_greater_than_2(BindingsTable bt, Term structIn, Term listIn)`
`static boolean`	`term_less_than_2(BindingsTable bt, Term structIn, Term listIn)`
`boolean`	`text_concat_3(BindingsTable bt, Term source1, Term source2, Term dest)`
`boolean`	`text_term_2(BindingsTable bt, Term structIn, Term listIn)` bidirectional text/term conversion.
`boolean`	`var_1(BindingsTable bt, Term t)`
`boolean`	`variable_set_2(BindingsTable bt, Term withVars, Term varList)`
`boolean`	`warning_0(BindingsTable bt)`

Methods inherited from class jTrolog.lib.Library
dismiss, getName, onSolveBegin, onSolveEnd, setEngine

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- BasicLibrary
```
public BasicLibrary()
```

Method Detail

set_theory_1

public boolean set_theory_1(BindingsTable bt,
                            Term th)

sets a new theory provided as a text

add_theory_1

public boolean add_theory_1(BindingsTable bt,
                            Term th)
                     throws PrologException

adds a new theory provided as a text

Throws:: PrologException

get_theory_1

public boolean get_theory_1(BindingsTable bt,
                            Term arg)

gets current theory text

load_library_2

public boolean load_library_2(BindingsTable bt,
                              Struct className,
                              Term libName)
                       throws InvalidLibraryException

Throws:: InvalidLibraryException

get_operators_list_1

public boolean get_operators_list_1(BindingsTable bt,
                                    Struct argument)

warning_0

public boolean warning_0(BindingsTable bt)

nowarning_0

public boolean nowarning_0(BindingsTable bt)

constant_1

public static boolean constant_1(BindingsTable bt,
                                 Term t)

number_1

public static boolean number_1(BindingsTable bt,
                               Term t)

integer_1

public static boolean integer_1(BindingsTable bt,
                                Term t)

float_1

public static boolean float_1(BindingsTable bt,
                              Term t)

atom_1

public static boolean atom_1(BindingsTable bt,
                             Term t)

compound_1

public static boolean compound_1(BindingsTable bt,
                                 Term t)

list_1

public static boolean list_1(BindingsTable bt,
                             Term t)
                      throws PrologException

Throws:: PrologException

var_1

public boolean var_1(BindingsTable bt,
                     Term t)

nonvar_1

public boolean nonvar_1(BindingsTable bt,
                        Term t)

atomic_1

public static boolean atomic_1(BindingsTable bt,
                               Term t)

ground_1

public static boolean ground_1(BindingsTable bt,
                               Term t)

$arg_3

public boolean $arg_3(BindingsTable bt,
                      Int n,
                      Struct term,
                      Term arg)
               throws PrologException

Throws:: PrologException

$functor_3

public boolean $functor_3(BindingsTable bt,
                          Term term,
                          Term name,
                          Term arity)
                   throws PrologException

Throws:: PrologException

$tofromlist_2

public boolean $tofromlist_2(BindingsTable bt,
                             Term structIn,
                             Term listIn)
                      throws PrologException

Throws:: PrologException

current_time_1

public boolean current_time_1(BindingsTable bt,
                              Term time)
                       throws Throwable

Throws:: Throwable

eval_1

public Term eval_1(BindingsTable bt,
                   EvaluableTerm structIn)
            throws Throwable

Throws:: Throwable

is_2

public boolean is_2(BindingsTable bt,
                    Term structIn,
                    EvaluableTerm listIn)
             throws Throwable

Throws:: Throwable

expression_equality_2

public boolean expression_equality_2(BindingsTable bt,
                                     EvaluableTerm structIn,
                                     EvaluableTerm listIn)
                              throws Throwable

Throws:: Throwable

expression_greater_than_2

public boolean expression_greater_than_2(BindingsTable bt,
                                         EvaluableTerm structIn,
                                         EvaluableTerm listIn)
                                  throws Throwable

Throws:: Throwable

expression_less_or_equal_than_2

public boolean expression_less_or_equal_than_2(BindingsTable bt,
                                               EvaluableTerm structIn,
                                               EvaluableTerm listIn)
                                        throws Throwable

Throws:: Throwable

expression_less_than_2

public boolean expression_less_than_2(BindingsTable bt,
                                      EvaluableTerm structIn,
                                      EvaluableTerm listIn)
                               throws Throwable

Throws:: Throwable

expression_greater_or_equal_than_2

public boolean expression_greater_or_equal_than_2(BindingsTable bt,
                                                  EvaluableTerm structIn,
                                                  EvaluableTerm listIn)
                                           throws Throwable

Throws:: Throwable

term_equality_2

public static boolean term_equality_2(BindingsTable bt,
                                      Term structIn,
                                      Term listIn)

number_equality_2

public static boolean number_equality_2(Number listIn,
                                        Number structIn)

term_greater_than_2

public static boolean term_greater_than_2(BindingsTable bt,
                                          Term structIn,
                                          Term listIn)

term_less_than_2

public static boolean term_less_than_2(BindingsTable bt,
                                       Term structIn,
                                       Term listIn)

expression_plus_1

public Term expression_plus_1(BindingsTable bt,
                              EvaluableTerm structIn)
                       throws Throwable

Throws:: Throwable

expression_minus_1

public Term expression_minus_1(BindingsTable bt,
                               EvaluableTerm listIn)
                        throws Throwable

Throws:: Throwable

expression_bitwise_not_1

public Term expression_bitwise_not_1(BindingsTable bt,
                                     EvaluableTerm structIn)
                              throws Throwable

Throws:: Throwable

expression_plus_2

public Term expression_plus_2(BindingsTable bt,
                              EvaluableTerm structIn,
                              EvaluableTerm listIn)
                       throws Throwable

Throws:: Throwable

expression_minus_2

public Term expression_minus_2(BindingsTable bt,
                               EvaluableTerm structIn,
                               EvaluableTerm listIn)
                        throws Throwable

Throws:: Throwable

expression_multiply_2

public Term expression_multiply_2(BindingsTable bt,
                                  EvaluableTerm structIn,
                                  EvaluableTerm listIn)
                           throws Throwable

Throws:: Throwable

expression_div_2

public Term expression_div_2(BindingsTable bt,
                             EvaluableTerm structIn,
                             EvaluableTerm listIn)
                      throws Throwable

Throws:: Throwable

expression_integer_div_2

public Term expression_integer_div_2(BindingsTable bt,
                                     EvaluableTerm structIn,
                                     EvaluableTerm listIn)
                              throws Throwable

Throws:: Throwable

expression_pow_2

public Term expression_pow_2(BindingsTable bt,
                             EvaluableTerm structIn,
                             EvaluableTerm listIn)
                      throws Throwable

Throws:: Throwable

expression_bitwise_shift_right_2

public Term expression_bitwise_shift_right_2(BindingsTable bt,
                                             EvaluableTerm structIn,
                                             EvaluableTerm listIn)
                                      throws Throwable

Throws:: Throwable

expression_bitwise_shift_left_2

public Term expression_bitwise_shift_left_2(BindingsTable bt,
                                            EvaluableTerm structIn,
                                            EvaluableTerm listIn)
                                     throws Throwable

Throws:: Throwable

expression_bitwise_and_2

public Term expression_bitwise_and_2(BindingsTable bt,
                                     EvaluableTerm structIn,
                                     EvaluableTerm listIn)
                              throws Throwable

Throws:: Throwable

expression_bitwise_or_2

public Term expression_bitwise_or_2(BindingsTable bt,
                                    EvaluableTerm structIn,
                                    EvaluableTerm listIn)
                             throws Throwable

Throws:: Throwable

text_term_2

public boolean text_term_2(BindingsTable bt,
                           Term structIn,
                           Term listIn)

bidirectional text/term conversion.

text_concat_3

public boolean text_concat_3(BindingsTable bt,
                             Term source1,
                             Term source2,
                             Term dest)

num_atom_2

public boolean num_atom_2(BindingsTable bt,
                          Term structIn,
                          Term listIn)

getTheory
```
public String getTheory()
```
Overrides:

getTheory in class Library

Returns:

the theory provided with the library (an empty theory is default).

$has_next_1

public boolean $has_next_1(BindingsTable bt,
                           IteratorAsTerm iterator)

$all_dynamic_predicate_indicators_1

public boolean $all_dynamic_predicate_indicators_1(BindingsTable bt,
                                                   Term iterator)
                                            throws PrologException

Throws:: PrologException

$current_pred_impl_3

public boolean $current_pred_impl_3(BindingsTable bt,
                                    Term name,
                                    Term arity,
                                    IteratorAsTerm allDynamicPIs)

variable_set_2

public boolean variable_set_2(BindingsTable bt,
                              Term withVars,
                              Term varList)

new_record_key_1

public boolean new_record_key_1(BindingsTable bt,
                                Var key)

record_2

public boolean record_2(BindingsTable bt,
                        Number key,
                        Term unit)

erase_2

public boolean erase_2(BindingsTable bt,
                       Number key,
                       Term list)

recorded_2

public boolean recorded_2(BindingsTable bt,
                          Number key,
                          Term list)

erase_1

public boolean erase_1(BindingsTable bt,
                       Number key)

$stripBagList_5

public boolean $stripBagList_5(BindingsTable bt,
                               Struct witnessIn,
                               Struct a_and_bSet,
                               Term aSet,
                               Term bSet,
                               Term variant)
                        throws PrologException

Throws:: PrologException

$list_diff_3

public boolean $list_diff_3(BindingsTable bt,
                            Struct main,
                            Struct retract,
                            Var diff)
                     throws PrologException

Throws:: PrologException

getSynonym
```
public String[] getSynonym(String primitive)
```
Defines a map for synonyms for primitives. String primitive name = String[]{synonym name, another synonym name, ..}.

Overrides:

getSynonym in class Library

Class BasicLibrary

Field Summary

Fields inherited from class jTrolog.lib.Library

Constructor Summary

Method Summary

Methods inherited from class jTrolog.lib.Library

Methods inherited from class java.lang.Object

Constructor Detail

BasicLibrary

Method Detail

set_theory_1

add_theory_1

get_theory_1

load_library_2

get_operators_list_1

warning_0

nowarning_0

constant_1

number_1

integer_1

float_1

atom_1

compound_1

list_1

var_1

nonvar_1

atomic_1

ground_1

$arg_3

$functor_3

$tofromlist_2

current_time_1

eval_1

is_2

expression_equality_2

expression_greater_than_2

expression_less_or_equal_than_2

expression_less_than_2

expression_greater_or_equal_than_2

term_equality_2

number_equality_2

term_greater_than_2

term_less_than_2

expression_plus_1

expression_minus_1

expression_bitwise_not_1

expression_plus_2

expression_minus_2

expression_multiply_2

expression_div_2

expression_integer_div_2

expression_pow_2

expression_bitwise_shift_right_2

expression_bitwise_shift_left_2

expression_bitwise_and_2

expression_bitwise_or_2

text_term_2

text_concat_3

num_atom_2

getTheory

$has_next_1

$all_dynamic_predicate_indicators_1

$current_pred_impl_3

variable_set_2

new_record_key_1

record_2

erase_2

recorded_2

erase_1

$stripBagList_5

$list_diff_3

getSynonym