com.cyc.cycjava.cycl
Class kb_indexing_datastructures

java.lang.Object
  com.cyc.tool.subl.util.SubLTrampolineFile
      com.cyc.tool.subl.util.SubLTranslatedFile
          com.cyc.cycjava.cycl.kb_indexing_datastructures

All Implemented Interfaces:

CommonSymbols, SubLFile

public final class kb_indexing_datastructures
extends SubLTranslatedFile

Nested Class Summary

static class	kb_indexing_datastructures.$fully_indexed_term_p$UnaryFunction
static class	kb_indexing_datastructures.$indexed_term_p$UnaryFunction
static class	kb_indexing_datastructures.$invalid_indexed_termP$UnaryFunction

Nested classes/interfaces inherited from class com.cyc.tool.subl.util.SubLTranslatedFile

SubLTranslatedFile.SubL

Field Summary

static SubLFloat	$float1$0_015
static SubLInteger	$int2$64
static SubLSymbol	$kw14$PROGRESS_MESSAGE
static SubLSymbol	$kw26$ALLOW_OTHER_KEYS
static SubLSymbol	$kw27$DONE
static SubLList	$list24
static SubLList	$list25
static SubLList	$list3
static SubLList	$list36
static SubLList	$list38
static SubLList	$list5
static SubLList	$list7
static SubLList	$list8
static SubLString	$str15$_S_is_not_indexed
static SubLString	$str22$_s_is_not_a_SUBINDEX_P
static SubLString	$str6$Returns_T_iff_OBJECT_is_an_indexe
static SubLString	$str9$mapping_Cyc_indexed_terms
static SubLSymbol	$sym0$_ASSERTION_INDEXING_STORE_
static SubLSymbol	$sym10$PROGN
static SubLSymbol	$sym11$DO_FORTS
static SubLSymbol	$sym12$DO_ASSERTIONS
static SubLSymbol	$sym13$DO_KB_UNREPRESENTED_TERMS
static SubLSymbol	$sym16$INDEXING_LEAF_INSTALLED_P
static SubLSymbol	$sym17$SIMPLE_INDEXED_TERM_P
static SubLSymbol	$sym18$DO_SIMPLE_INDEX_TERM_ASSERTION_LIST
static SubLSymbol	$sym19$DO_SIMPLE_INDEX
static SubLSymbol	$sym20$SIMPLE_INDEX_P
static SubLSymbol	$sym21$COMPLEX_INDEX_P
static SubLSymbol	$sym23$INTERMEDIATE_INDEX_P
static SubLSymbol	$sym28$INDEX
static SubLSymbol	$sym29$CLET
static SubLSymbol	$sym30$PWHEN
static SubLSymbol	$sym31$DO_INTERMEDIATE_INDEX_VALID_INDEX_P
static SubLSymbol	$sym32$DO_DICTIONARY
static SubLSymbol	$sym33$INTERMEDIATE_INDEX_DICTIONARY
static SubLSymbol	$sym34$DO_INTERMEDIATE_INDEX
static SubLSymbol	$sym35$SUBINDEX_P
static SubLSymbol	$sym37$FINAL_INDEX_P
static SubLSymbol	$sym39$INDEX
static SubLSymbol	$sym4$INDEXED_TERM_P
static SubLSymbol	$sym40$DO_FINAL_INDEX_VALID_INDEX_P
static SubLSymbol	$sym41$DO_SET
static SubLSymbol	$sym42$FINAL_INDEX_SET
static SubLSymbol	$sym43$DO_FINAL_INDEX
static SubLFile	me
static java.lang.String	myName

Fields inherited from class com.cyc.tool.subl.util.SubLTranslatedFile

EMPTY_SUBL_OBJECT_ARRAY

Fields inherited from interface com.cyc.tool.subl.jrtl.nativeCode.subLisp.CommonSymbols

ANSWER_TAG, APPEND_KEYWORD, APPEND_STACK_TRACES_TO_ERROR_MESSAGES, AREF, ASSEMBLE_FIXNUMS_TO_INTEGER, ATOM, BIGNUMP, BINARY_KEYWORD, BINDING_TYPE, BOOLEANP, CAAR, CADR, CAND, CAR, CCATCH, CDEC, CDESTRUCTURING_BIND, CDO, CDO_ALL_SYMBOLS, CDO_EXTERNAL_SYMBOLS, CDO_SYMBOLS, CDOHASH, CDOLIST, CDOTIMES, CDR, CHAR, CHAR_E_SYMBOL, CHAR_EQUAL_SYMBOL, CHAR_GREATER_THAN_OR_EQUAL_SYMBOL, CHAR_GREATER_THAN_SYMBOL, CHAR_GT_SYMBOL, CHAR_GTE_SYMBOL, CHAR_LESS_THAN_OR_EQUAL_SYMBOL, CHAR_LESS_THAN_SYMBOL, CHAR_LT_SYMBOL, CHAR_LTE_SYMBOL, CHAR_NE_SYMBOL, CHAR_NOT_EQUAL_SYMBOL, CHARACTERP, CHECK_TYPE, CINC, CLET, CMULTIPLE_VALUE_BIND, CNOT, CONS, CONSP, CONSTANT, COR, CPOP, CPROGV, CPUSH, CPUSHNEW, CREATE_KEYWORD, CSETF, CSETQ, CSOME, CTIME, CUNWIND_PROTECT, CVS_ID, DEBUG_IO, DECLAIM, DECLARE, DEFCONSTANT, DEFINE, DEFLEXICAL, DEFMACRO, DEFPARAMETER, DEFVAR, DIRECTION_KEYWORD, DYNAMIC, EIGHT_INTEGER, EIGHTEEN_INTEGER, ELEMENT_TYPE_KEYWORD, ELEVEN_INTEGER, END_KEYWORD, ENFORCE_MUST, ENFORCE_TYPE, EQ, EQL, EQUAL, EQUALP, ERROR, ERROR_KEYWORD, ERROR_OUTPUT, EVAL, EXTERNAL_FORMAT_KEYWORD, EXTERNAL_KEYWORD, FIF, FIFTEEN_INTEGER, FIRST, FIVE_INTEGER, FIXNUMP, FLOATP, FOUR_INTEGER, FOURTEEN_INTEGER, FUNCTION, FUNCTION_SPEC_P, FUNCTIONP, FUNLESS, FWHEN, GET, GETHASH, GETHASH_WITHOUT_VALUES, GUID_P, HASH_TABLE_ITERATOR_P, HASH_TABLE_P, IDENTITY, IF_DOES_NOT_EXIST_KEYWORD, IF_EXISTS_KEYWORD, IGNORE, INITIALIZATION_TYPE, INITIALIZER, INPUT_KEYWORD, INPUT_STREAM_P, INTEGERP, INTERNAL_KEYWORD, IO_KEYWORD, KEYWORDP, KILL_KEYWORD, LAMBDA_SYMBOL, LEXICAL, LIST, LISTP, LISTS, LOCK_P, LONG_BIGNUM_P, MACRO_ENV, MACRO_FORM, MEDIUM_BIGNUM_P, MEMBER, MINUS_ONE_INTEGER, MULTIPLE_VALUE_LIST, MUST, NCONC, NEW_VERSION_KEYWORD, NIL, NINE_INTEGER, NINETEEN_INTEGER, NREVERSE, NTH, NTH_VALUE, NULL, NULL_INPUT, NULL_OUTPUT, NUM_E_SYMBOL, NUM_GT_SYMBOL, NUM_GTE_SYMBOL, NUM_LT_SYMBOL, NUM_LTE_SYMBOL, NUM_NE_SYMBOL, NUMBERP, ONE_HUNDRED_THIRTY_SEVEN_INTEGER, ONE_HUNDRED_TWENTY_SEVEN_INTEGER, ONE_INTEGER, ONE_THOUSAND_INTEGER, OPTIONAL_SYMBOL, OTHERWISE, OUTPUT_KEYWORD, OUTPUT_STREAM_P, OVERWRITE_KEYWORD, PACKAGEP, PCASE, PCOND, PIF, PROBE_KEYWORD, PROCESS_TO_END, PROCESSP, PROCLAIM, PROGN, PUNLESS, PWHEN, QUERY_IO, QUIT, QUOTE, RENAME_AND_DELETE_KEYWORD, REST_SYMBOL, RET, RET_NIL, RET_T, RETURN_TAG, REVERSE, RW_LOCK_P, SECOND, SEQUENCEP, SEVEN_INTEGER, SEVENTEEN_INTEGER, SHORT_BIGNUM_P, SHOW_STACK_TRACES, SIX_INTEGER, SIXTEEN_INTEGER, SIXTY_FOUR_INTEGER, SORT, SSS, STANDARD_INPUT, STANDARD_OUTPUT, START_KEYWORD, STREAMP, STRING_E_SYMBOL, STRING_EQUAL_SYMBOL, STRING_GREATER_THAN_OR_EQUAL_SYMBOL, STRING_GREATER_THAN_SYMBOL, STRING_GT_SYMBOL, STRING_GTE_SYMBOL, STRING_LESS_THAN_OR_EQUAL_SYMBOL, STRING_LESS_THAN_SYMBOL, STRING_LT_SYMBOL, STRING_LTE_SYMBOL, STRING_NE_SYMBOL, STRING_NOT_EQUAL_SYMBOL, STRINGP, STRUCTURE_P, SUPERSEDE_KEYWORD, SUSPEND_TYPE_CHECKING, SYMBOL_FUNCTION, SYMBOL_VALUE, SYMBOLP, T, TEN_INTEGER, TERMINAL_IO, TEXT_KEYWORD, THIRTEEN_INTEGER, THIRTY_FOUR_INTEGER, THIRTY_THREE_INTEGER, THIRTY_TWO_INTEGER, THREE_INTEGER, TRACE_OUTPUT, TRUE, TWELVE_INTEGER, TWENTY_INTEGER, TWO_HUNDRED_FIFTY_FOUR_INTEGER, TWO_HUNDRED_FORTY_FOUR_INTEGER, TWO_INTEGER, UNDECLARED, UNPROVIDED, VALUES, VECTOR, VECTORP, WITH_ERROR_HANDLER, WITH_STATIC_AREA, WITH_THREAD_PRIVATE_AREA, WITH_WORKING_AREA, WORLD, ZERO_DOUBLE, ZERO_INTEGER

Method Summary

static SubLObject	assertion_indexing_store_get(SubLObject assertion)
static SubLObject	assertion_indexing_store_initial_size(SubLObject estimated_assertion_count)
static SubLObject	assertion_indexing_store_initialize(SubLObject estimated_assertion_count)
static SubLObject	assertion_indexing_store_reset(SubLObject store)
static SubLObject	assertion_indexing_store_set(SubLObject assertion, SubLObject index)
static SubLObject	complex_index_leaf_count(SubLObject complex_index)
static SubLObject	complex_index_lookup(SubLObject complex_index, SubLObject key)
static SubLObject	complex_index_p(SubLObject object)
static SubLObject	declare_kb_indexing_datastructures_file()
void	declareFunctions() Declares the mapping between functions and symbols for all named functions defined in the file.
static SubLObject	do_intermediate_index_valid_index_p(SubLObject object)
static SubLObject	do_simple_index_term_assertion_list(SubLObject v_term)
static SubLObject	final_index_delete(SubLObject final_index, SubLObject leaf) Is not required to check for multiple elements to delete
static SubLObject	final_index_insert(SubLObject final_index, SubLObject leaf) Is not required to check for membership before insertion
static SubLObject	final_index_leaf_count(SubLObject final_index)
static SubLObject	final_index_p(SubLObject object)
static SubLObject	final_index_set(SubLObject final_index) returns the set datastructure in FINAL-INDEX.
static SubLObject	free_complex_index(SubLObject complex_index) Frees all resources consumed by COMPLEX-INDEX
static SubLObject	free_index(SubLObject index) Frees all resources consumed by INDEX
static SubLObject	free_intermediate_index(SubLObject intermediate_index) Frees all resources consumed by INTERMEDIATE-INDEX
static SubLObject	free_subindex(SubLObject subindex) Frees all resources consumed by SUBINDEX
static SubLObject	free_term_index(SubLObject v_term) Frees all resources consumed by the index for TERM
static SubLObject	fully_indexed_term_p(SubLObject object) Return T iff OBJECT is the type which will be indexed in the other index, if necessary.
static SubLObject	indexed_term_p(SubLObject object) Returns T iff OBJECT is an indexed CycL term, e.g.
static SubLObject	indexed_unrepresented_term_p(SubLObject object) Returns T iff OBJECT is an indexed unrepresented CycL term, e.g., a string or number.
static SubLObject	init_kb_indexing_datastructures_file()
static SubLObject	initialize_term_complex_index(SubLObject v_term) Initializes a complex index for TERM.
static SubLObject	initialize_term_intermediate_index(SubLObject v_term) Initializes a top-level intermediate index for TERM.
static SubLObject	initialize_term_subindex(SubLObject v_term) Initializes a subindex for TERM.
void	initializeVariables() Initializes all global variables and private internal variables for constants defined in the file.
static SubLObject	intermediate_index_delete_key(SubLObject intermediate_index, SubLObject key) Delete any mapping from KEY to a subindex in INTERMEDIATE-INDEX.
static SubLObject	intermediate_index_delete(SubLObject intermediate_index, SubLObject keys, SubLObject leaf)
static SubLObject	intermediate_index_dictionary_delete_key(SubLObject intermediate_index, SubLObject key)
static SubLObject	intermediate_index_dictionary_set(SubLObject intermediate_index, SubLObject key, SubLObject value)
static SubLObject	intermediate_index_dictionary(SubLObject intermediate_index) assumes INTERMEDIATE-INDEX is dictionary-style
static SubLObject	intermediate_index_insert_int(SubLObject intermediate_index, SubLObject keys, SubLObject leaf, SubLObject key_history) Insert LEAF at KEYS, having already gone down the keys in KEY-HISTORY
static SubLObject	intermediate_index_insert(SubLObject intermediate_index, SubLObject keys, SubLObject leaf)
static SubLObject	intermediate_index_keys(SubLObject intermediate_index)
static SubLObject	intermediate_index_leaf_count_inc(SubLObject intermediate_index, SubLObject delta)
static SubLObject	intermediate_index_leaf_count_reset(SubLObject intermediate_index, SubLObject new_count)
static SubLObject	intermediate_index_leaf_count(SubLObject intermediate_index)
static SubLObject	intermediate_index_lookup_or_create_final(SubLObject intermediate_index, SubLObject key)
static SubLObject	intermediate_index_lookup_or_create_intermediate(SubLObject intermediate_index, SubLObject key, SubLObject key_history) Having already gone down the keys in KEY-HISTORY, look up KEY in INTERMEDIATE-INDEX.
static SubLObject	intermediate_index_lookup(SubLObject intermediate_index, SubLObject key)
static SubLObject	intermediate_index_p(SubLObject object)
static SubLObject	intermediate_index_set(SubLObject intermediate_index, SubLObject key, SubLObject value) does not reset the counts
static SubLObject	new_final_index()
static SubLObject	new_intermediate_index(SubLObject test_function)
static SubLObject	new_simple_index() Returns a new empty simple index.
static SubLObject	reset_term_index(SubLObject v_term, SubLObject index) Primitively replaces TERM's index with INDEX.
static SubLObject	reset_term_simple_index(SubLObject v_term, SubLObject simple_index)
void	runTopLevelForms() Runs all top-level forms in order.
static SubLObject	setup_indexing_tables(SubLObject estimated_size) sets up all tables needed for the KB indexing
static SubLObject	setup_kb_indexing_datastructures_file()
static SubLObject	simple_index_p(SubLObject object) Return T iff OBJECT is a simple index.
static SubLObject	simple_indexed_term_p(SubLObject v_term)
static SubLObject	simple_num_index(SubLObject v_term)
static SubLObject	simple_term_assertion_list(SubLObject v_term)
static SubLObject	subindex_leaf_count(SubLObject subindex)
static SubLObject	subindex_lookup(SubLObject subindex, SubLObject key)
static SubLObject	subindex_p(SubLObject object)
static SubLObject	term_complex_index_lookup(SubLObject v_term, SubLObject key)
static SubLObject	term_index(SubLObject v_term)
static SubLObject	unindexed_syntax_constant_p(SubLObject object) Return T iff OBJECT is a constants which is part of the syntax and therefore not fully indexed.
static SubLObject	valid_fully_indexed_term_p(SubLObject object) Return T iff OBJECT is the type which will be indexed in the other index, if necessary, and is valid.
static SubLObject	valid_indexed_termP(SubLObject object) Returns T iff OBJECT is a valid indexed CycL term, i.e.

Methods inherited from class com.cyc.tool.subl.util.SubLTranslatedFile

extractFunctionNamed

Methods inherited from class com.cyc.tool.subl.util.SubLTrampolineFile

checkType, enforceType, extractBinaryFunc, extractCount, extractEnd, extractEndUsingSize, extractPackage, extractStart, extractUnaryFunc, main

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

me

public static final SubLFile me

myName

public static final java.lang.String myName

See Also:

Constant Field Values

$sym0$_ASSERTION_INDEXING_STORE_

public static final SubLSymbol $sym0$_ASSERTION_INDEXING_STORE_

$float1$0_015

public static final SubLFloat $float1$0_015

$int2$64

public static final SubLInteger $int2$64

$list3

public static final SubLList $list3

$sym4$INDEXED_TERM_P

public static final SubLSymbol $sym4$INDEXED_TERM_P

$list5

public static final SubLList $list5

$str6$Returns_T_iff_OBJECT_is_an_indexe

public static final SubLString $str6$Returns_T_iff_OBJECT_is_an_indexe

$list7

public static final SubLList $list7

$list8

public static final SubLList $list8

$str9$mapping_Cyc_indexed_terms

public static final SubLString $str9$mapping_Cyc_indexed_terms

$sym10$PROGN

public static final SubLSymbol $sym10$PROGN

$sym11$DO_FORTS

public static final SubLSymbol $sym11$DO_FORTS

$sym12$DO_ASSERTIONS

public static final SubLSymbol $sym12$DO_ASSERTIONS

$sym13$DO_KB_UNREPRESENTED_TERMS

public static final SubLSymbol $sym13$DO_KB_UNREPRESENTED_TERMS

$kw14$PROGRESS_MESSAGE

public static final SubLSymbol $kw14$PROGRESS_MESSAGE

$str15$_S_is_not_indexed

public static final SubLString $str15$_S_is_not_indexed

$sym16$INDEXING_LEAF_INSTALLED_P

public static final SubLSymbol $sym16$INDEXING_LEAF_INSTALLED_P

$sym17$SIMPLE_INDEXED_TERM_P

public static final SubLSymbol $sym17$SIMPLE_INDEXED_TERM_P

$sym18$DO_SIMPLE_INDEX_TERM_ASSERTION_LIST

public static final SubLSymbol $sym18$DO_SIMPLE_INDEX_TERM_ASSERTION_LIST

$sym19$DO_SIMPLE_INDEX

public static final SubLSymbol $sym19$DO_SIMPLE_INDEX

$sym20$SIMPLE_INDEX_P

public static final SubLSymbol $sym20$SIMPLE_INDEX_P

$sym21$COMPLEX_INDEX_P

public static final SubLSymbol $sym21$COMPLEX_INDEX_P

$str22$_s_is_not_a_SUBINDEX_P

public static final SubLString $str22$_s_is_not_a_SUBINDEX_P

$sym23$INTERMEDIATE_INDEX_P

public static final SubLSymbol $sym23$INTERMEDIATE_INDEX_P

$list24

public static final SubLList $list24

$list25

public static final SubLList $list25

$kw26$ALLOW_OTHER_KEYS

public static final SubLSymbol $kw26$ALLOW_OTHER_KEYS

$kw27$DONE

public static final SubLSymbol $kw27$DONE

$sym28$INDEX

public static final SubLSymbol $sym28$INDEX

$sym29$CLET

public static final SubLSymbol $sym29$CLET

$sym30$PWHEN

public static final SubLSymbol $sym30$PWHEN

$sym31$DO_INTERMEDIATE_INDEX_VALID_INDEX_P

public static final SubLSymbol $sym31$DO_INTERMEDIATE_INDEX_VALID_INDEX_P

$sym32$DO_DICTIONARY

public static final SubLSymbol $sym32$DO_DICTIONARY

$sym33$INTERMEDIATE_INDEX_DICTIONARY

public static final SubLSymbol $sym33$INTERMEDIATE_INDEX_DICTIONARY

$sym34$DO_INTERMEDIATE_INDEX

public static final SubLSymbol $sym34$DO_INTERMEDIATE_INDEX

$sym35$SUBINDEX_P

public static final SubLSymbol $sym35$SUBINDEX_P

$list36

public static final SubLList $list36

$sym37$FINAL_INDEX_P

public static final SubLSymbol $sym37$FINAL_INDEX_P

$list38

public static final SubLList $list38

$sym39$INDEX

public static final SubLSymbol $sym39$INDEX

$sym40$DO_FINAL_INDEX_VALID_INDEX_P

public static final SubLSymbol $sym40$DO_FINAL_INDEX_VALID_INDEX_P

$sym41$DO_SET

public static final SubLSymbol $sym41$DO_SET

$sym42$FINAL_INDEX_SET

public static final SubLSymbol $sym42$FINAL_INDEX_SET

$sym43$DO_FINAL_INDEX

public static final SubLSymbol $sym43$DO_FINAL_INDEX

Method Detail

setup_indexing_tables

public static final SubLObject setup_indexing_tables(SubLObject estimated_size)

sets up all tables needed for the KB indexing

Parameters:

estimated-size; - estimated # of constants

assertion_indexing_store_reset

public static final SubLObject assertion_indexing_store_reset(SubLObject store)

assertion_indexing_store_initial_size

public static final SubLObject assertion_indexing_store_initial_size(SubLObject estimated_assertion_count)

assertion_indexing_store_initialize

public static final SubLObject assertion_indexing_store_initialize(SubLObject estimated_assertion_count)

assertion_indexing_store_get

public static final SubLObject assertion_indexing_store_get(SubLObject assertion)

assertion_indexing_store_set

public static final SubLObject assertion_indexing_store_set(SubLObject assertion,
                                                            SubLObject index)

unindexed_syntax_constant_p

public static final SubLObject unindexed_syntax_constant_p(SubLObject object)

Return T iff OBJECT is a constants which is part of the syntax and therefore not fully indexed.

indexed_term_p

public static final SubLObject indexed_term_p(SubLObject object)

Returns T iff OBJECT is an indexed CycL term, e.g. a fort or assertion.

indexed_unrepresented_term_p

public static final SubLObject indexed_unrepresented_term_p(SubLObject object)

Returns T iff OBJECT is an indexed unrepresented CycL term, e.g., a string or number.

valid_indexed_termP

public static final SubLObject valid_indexed_termP(SubLObject object)

Returns T iff OBJECT is a valid indexed CycL term, i.e. a fort or an assertion.

fully_indexed_term_p

public static final SubLObject fully_indexed_term_p(SubLObject object)

Return T iff OBJECT is the type which will be indexed in the other index, if necessary.

valid_fully_indexed_term_p

public static final SubLObject valid_fully_indexed_term_p(SubLObject object)

Return T iff OBJECT is the type which will be indexed in the other index, if necessary, and is valid.

term_index

public static final SubLObject term_index(SubLObject v_term)

Returns:

index-p

reset_term_index

public static final SubLObject reset_term_index(SubLObject v_term,
                                                SubLObject index)

Primitively replaces TERM's index with INDEX.

Parameters:

INDEX - index-p

free_index

public static final SubLObject free_index(SubLObject index)

Frees all resources consumed by INDEX

free_term_index

public static final SubLObject free_term_index(SubLObject v_term)

Frees all resources consumed by the index for TERM

simple_index_p

public static final SubLObject simple_index_p(SubLObject object)

Return T iff OBJECT is a simple index.

simple_indexed_term_p

public static final SubLObject simple_indexed_term_p(SubLObject v_term)

new_simple_index

public static final SubLObject new_simple_index()

Returns a new empty simple index.

simple_num_index

public static final SubLObject simple_num_index(SubLObject v_term)

simple_term_assertion_list

public static final SubLObject simple_term_assertion_list(SubLObject v_term)

Returns:

listp; the list of all assertions referencing TERM.

do_simple_index_term_assertion_list

public static final SubLObject do_simple_index_term_assertion_list(SubLObject v_term)

reset_term_simple_index

public static final SubLObject reset_term_simple_index(SubLObject v_term,
                                                       SubLObject simple_index)

complex_index_p

public static final SubLObject complex_index_p(SubLObject object)

complex_index_leaf_count

public static final SubLObject complex_index_leaf_count(SubLObject complex_index)

complex_index_lookup

public static final SubLObject complex_index_lookup(SubLObject complex_index,
                                                    SubLObject key)

Returns:

nil or subindex-p or indexing-leaf-p

term_complex_index_lookup

public static final SubLObject term_complex_index_lookup(SubLObject v_term,
                                                         SubLObject key)

Returns:

nil or subindex-p

initialize_term_complex_index

public static final SubLObject initialize_term_complex_index(SubLObject v_term)

Initializes a complex index for TERM. Clobbers any existing indexing for TERM.

free_complex_index

public static final SubLObject free_complex_index(SubLObject complex_index)

Frees all resources consumed by COMPLEX-INDEX

subindex_p

public static final SubLObject subindex_p(SubLObject object)

subindex_lookup

public static final SubLObject subindex_lookup(SubLObject subindex,
                                               SubLObject key)

Returns:

nil or subindex-p or indexing-leaf-p

subindex_leaf_count

public static final SubLObject subindex_leaf_count(SubLObject subindex)

Returns:

integerp; the number of indexing leaves anywhere below SUBINDEX

initialize_term_subindex

public static final SubLObject initialize_term_subindex(SubLObject v_term)

Initializes a subindex for TERM. Clobbers any existing indexing for TERM.

free_subindex

public static final SubLObject free_subindex(SubLObject subindex)

Frees all resources consumed by SUBINDEX

intermediate_index_p

public static final SubLObject intermediate_index_p(SubLObject object)

new_intermediate_index

public static final SubLObject new_intermediate_index(SubLObject test_function)

do_intermediate_index_valid_index_p

public static final SubLObject do_intermediate_index_valid_index_p(SubLObject object)

intermediate_index_lookup

public static final SubLObject intermediate_index_lookup(SubLObject intermediate_index,
                                                         SubLObject key)

Returns:

nil or subindex-p

intermediate_index_keys

public static final SubLObject intermediate_index_keys(SubLObject intermediate_index)

Returns:

listp; a list of keys for INTERMEDIATE-INDEX

intermediate_index_leaf_count

public static final SubLObject intermediate_index_leaf_count(SubLObject intermediate_index)

Returns:

integerp; the number of indexing leaves anywhere below INTERMEDIATE-INDEX

intermediate_index_set

public static final SubLObject intermediate_index_set(SubLObject intermediate_index,
                                                      SubLObject key,
                                                      SubLObject value)

does not reset the counts

intermediate_index_insert

public static final SubLObject intermediate_index_insert(SubLObject intermediate_index,
                                                         SubLObject keys,
                                                         SubLObject leaf)

Returns:

boolean; whether it actually inserted (nil if it was already there)

intermediate_index_insert_int

public static final SubLObject intermediate_index_insert_int(SubLObject intermediate_index,
                                                             SubLObject keys,
                                                             SubLObject leaf,
                                                             SubLObject key_history)

Insert LEAF at KEYS, having already gone down the keys in KEY-HISTORY

intermediate_index_delete

public static final SubLObject intermediate_index_delete(SubLObject intermediate_index,
                                                         SubLObject keys,
                                                         SubLObject leaf)

Returns:

boolean; whether it actually deleted (nil if it was already gone)

intermediate_index_delete_key

public static final SubLObject intermediate_index_delete_key(SubLObject intermediate_index,
                                                             SubLObject key)

Delete any mapping from KEY to a subindex in INTERMEDIATE-INDEX.

initialize_term_intermediate_index

public static final SubLObject initialize_term_intermediate_index(SubLObject v_term)

Initializes a top-level intermediate index for TERM. Clobbers any existing indexing for TERM.

free_intermediate_index

public static final SubLObject free_intermediate_index(SubLObject intermediate_index)

Frees all resources consumed by INTERMEDIATE-INDEX

intermediate_index_leaf_count_reset

public static final SubLObject intermediate_index_leaf_count_reset(SubLObject intermediate_index,
                                                                   SubLObject new_count)

intermediate_index_leaf_count_inc

public static final SubLObject intermediate_index_leaf_count_inc(SubLObject intermediate_index,
                                                                 SubLObject delta)

intermediate_index_lookup_or_create_intermediate

public static final SubLObject intermediate_index_lookup_or_create_intermediate(SubLObject intermediate_index,
                                                                                SubLObject key,
                                                                                SubLObject key_history)

Having already gone down the keys in KEY-HISTORY, look up KEY in INTERMEDIATE-INDEX. If not found, create a new intermediate index for KEY, with an equality test determined from KEY-HISTORY.

intermediate_index_lookup_or_create_final

public static final SubLObject intermediate_index_lookup_or_create_final(SubLObject intermediate_index,
                                                                         SubLObject key)

intermediate_index_dictionary

public static final SubLObject intermediate_index_dictionary(SubLObject intermediate_index)

assumes INTERMEDIATE-INDEX is dictionary-style

intermediate_index_dictionary_set

public static final SubLObject intermediate_index_dictionary_set(SubLObject intermediate_index,
                                                                 SubLObject key,
                                                                 SubLObject value)

intermediate_index_dictionary_delete_key

public static final SubLObject intermediate_index_dictionary_delete_key(SubLObject intermediate_index,
                                                                        SubLObject key)

final_index_p

public static final SubLObject final_index_p(SubLObject object)

new_final_index

public static final SubLObject new_final_index()

final_index_leaf_count

public static final SubLObject final_index_leaf_count(SubLObject final_index)

Returns:

integerp; the number of indexing leaves in FINAL-INDEX

final_index_insert

public static final SubLObject final_index_insert(SubLObject final_index,
                                                  SubLObject leaf)

Is not required to check for membership before insertion

final_index_delete

public static final SubLObject final_index_delete(SubLObject final_index,
                                                  SubLObject leaf)

Is not required to check for multiple elements to delete

final_index_set

public static final SubLObject final_index_set(SubLObject final_index)

returns the set datastructure in FINAL-INDEX. Currently a final index _is_ a set, so this is the identity function.

declare_kb_indexing_datastructures_file

public static final SubLObject declare_kb_indexing_datastructures_file()

init_kb_indexing_datastructures_file

public static final SubLObject init_kb_indexing_datastructures_file()

setup_kb_indexing_datastructures_file

public static final SubLObject setup_kb_indexing_datastructures_file()

declareFunctions

public void declareFunctions()

Description copied from interface: SubLFile

Declares the mapping between functions and symbols for all named functions defined in the file. Like CRTL define.

initializeVariables

public void initializeVariables()

Description copied from interface: SubLFile

Initializes all global variables and private internal variables for constants defined in the file. Like CRTL init.

runTopLevelForms

public void runTopLevelForms()

Description copied from interface: SubLFile

Runs all top-level forms in order. Like CRTL setup.