The montezuma Reference Manual

This is the montezuma Reference Manual, version 0.1.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:10:23 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 montezuma

Montezuma is a port of the Lucene text search engine library.

Maintainer

Leslie P. Polzer <>

Author

John Wiseman <>

License

MIT/Expat

Long Description

Montezuma is a port of the Ferret text search engine library, which is itself a port of the Lucene engine.

Version

0.1.3

Dependencies
  • cl-ppcre (system).
  • cl-fad (system).
  • babel (system).
Source

montezuma.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 montezuma/src

Source

montezuma.asd.

Parent Component

montezuma (system).

Child Components

3.2 montezuma/src/util

Dependency

package.lisp (file).

Source

montezuma.asd.

Parent Component

src (module).

Child Components

3.3 montezuma/src/store

Dependencies
Source

montezuma.asd.

Parent Component

src (module).

Child Components

3.4 montezuma/src/document

Dependency

package.lisp (file).

Source

montezuma.asd.

Parent Component

src (module).

Child Components

3.5 montezuma/src/analysis

Dependencies
Source

montezuma.asd.

Parent Component

src (module).

Child Components

3.6 montezuma/src/query-parser

Dependencies
Source

montezuma.asd.

Parent Component

src (module).

Child Component

query-parser.lisp (file).


3.8 montezuma/src/index

Dependencies
Source

montezuma.asd.

Parent Component

src (module).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 montezuma/montezuma.asd

Source

montezuma.asd.

Parent Component

montezuma (system).

ASDF Systems

montezuma.


4.1.2 montezuma/src/package.lisp

Source

montezuma.asd.

Parent Component

src (module).

Packages

4.1.3 montezuma/src/util/while.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

4.1.4 montezuma/src/util/porter-stemmer.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

4.1.5 montezuma/src/util/streams.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

stream-contents (function).


4.1.6 montezuma/src/util/pipes.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

4.1.7 montezuma/src/util/mop.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

4.1.8 montezuma/src/util/priority-queue.lisp

Dependency

while.lisp (file).

Source

montezuma.asd.

Parent Component

util (module).

Public Interface
Internals

4.1.9 montezuma/src/util/strings.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

4.1.10 montezuma/src/util/tables.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

4.1.11 montezuma/src/util/bit-vector.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

4.1.12 montezuma/src/util/files.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

add-file-extension (function).


4.1.13 montezuma/src/util/comparable.lisp

Source

montezuma.asd.

Parent Component

util (module).

Internals

<=> (generic function).


4.1.14 montezuma/src/util/parser.lisp

Source

montezuma.asd.

Parent Component

util (module).

Public Interface
Internals

4.1.15 montezuma/src/util/utilities.lisp

Source

montezuma.asd.

Parent Component

util (module).

Public Interface

each (generic function).

Internals

4.1.16 montezuma/src/store/api.lisp

Source

montezuma.asd.

Parent Component

store (module).

Public Interface
  • close (generic function).
  • flush (generic function).
Internals

4.1.17 montezuma/src/store/directory.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

store (module).

Internals

4.1.18 montezuma/src/store/index-io.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

store (module).

Internals

4.1.19 montezuma/src/store/buffered-index-io.lisp

Dependency

index-io.lisp (file).

Source

montezuma.asd.

Parent Component

store (module).

Public Interface
Internals

4.1.20 montezuma/src/store/ram-store.lisp

Dependencies
Source

montezuma.asd.

Parent Component

store (module).

Public Interface
Internals

4.1.21 montezuma/src/store/fs-store.lisp

Dependencies
Source

montezuma.asd.

Parent Component

store (module).

Public Interface
Internals

4.1.22 montezuma/src/document/field.lisp

Source

montezuma.asd.

Parent Component

document (module).

Public Interface
Internals

4.1.23 montezuma/src/document/document.lisp

Source

montezuma.asd.

Parent Component

document (module).

Public Interface
Internals

4.1.24 montezuma/src/analysis/token.lisp

Source

montezuma.asd.

Parent Component

analysis (module).

Public Interface
Internals

4.1.25 montezuma/src/analysis/token-stream.lisp

Source

montezuma.asd.

Parent Component

analysis (module).

Internals

4.1.26 montezuma/src/analysis/token-filters.lisp

Dependencies
Source

montezuma.asd.

Parent Component

analysis (module).

Public Interface
Internals

4.1.27 montezuma/src/analysis/tokenizers.lisp

Dependencies
Source

montezuma.asd.

Parent Component

analysis (module).

Public Interface
Internals

4.1.28 montezuma/src/analysis/standard-tokenizer.lisp

Dependency

tokenizers.lisp (file).

Source

montezuma.asd.

Parent Component

analysis (module).

Internals

4.1.29 montezuma/src/analysis/analyzers.lisp

Dependency

standard-tokenizer.lisp (file).

Source

montezuma.asd.

Parent Component

analysis (module).

Public Interface
Internals

4.1.30 montezuma/src/query-parser/query-parser.lisp

Source

montezuma.asd.

Parent Component

query-parser (module).

Public Interface
Internals

4.1.31 montezuma/src/search/api.lisp

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.32 montezuma/src/search/similarity.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Internals

4.1.33 montezuma/src/search/boolean-clause.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.34 montezuma/src/search/scorer.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.35 montezuma/src/search/score-doc.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.36 montezuma/src/search/score-doc-comparator.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface

index (reader method).

Internals

4.1.37 montezuma/src/search/filter.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Internals

4.1.38 montezuma/src/search/weight.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface

weight (class).


4.1.39 montezuma/src/search/hit-queue.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Internals

4.1.40 montezuma/src/search/query.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface

weight (method).

Internals

4.1.41 montezuma/src/search/term-query.lisp

Dependency

query.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.42 montezuma/src/search/boolean-query.lisp

Dependency

query.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.43 montezuma/src/search/term-scorer.lisp

Dependency

scorer.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.44 montezuma/src/search/disjunction-sum-scorer.lisp

Dependency

scorer.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.45 montezuma/src/search/conjunction-scorer.lisp

Dependency

scorer.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.46 montezuma/src/search/req-opt-sum-scorer.lisp

Dependency

scorer.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.47 montezuma/src/search/req-excl-scorer.lisp

Dependency

scorer.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.48 montezuma/src/search/non-matching-scorer.lisp

Source

montezuma.asd.

Parent Component

search (module).

Internals

4.1.49 montezuma/src/search/boolean-scorer.lisp

Dependencies
Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.50 montezuma/src/search/filtered-term-enum.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface

close (method).

Internals

4.1.51 montezuma/src/search/multi-term-query.lisp

Dependency

query.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface

print-object (method).

Internals

4.1.52 montezuma/src/search/wildcard-query.lisp

Dependency

multi-term-query.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Internals

4.1.53 montezuma/src/search/wildcard-term-enum.lisp

Dependency

filtered-term-enum.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.54 montezuma/src/search/phrase-query.lisp

Dependency

query.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.55 montezuma/src/search/range-query.lisp

Dependency

query.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.56 montezuma/src/search/match-all-query.lisp

Dependency

query.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.57 montezuma/src/search/top-docs.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.58 montezuma/src/search/index-searcher.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.59 montezuma/src/search/sort.lisp

Dependencies
Source

montezuma.asd.

Parent Component

search (module).

Public Interface

initialize-instance (method).

Internals

4.1.60 montezuma/src/search/sort-field.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface

initialize-instance (method).

Internals

4.1.61 montezuma/src/search/phrase-positions.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.62 montezuma/src/search/phrase-scorer.lisp

Dependencies
Source

montezuma.asd.

Parent Component

search (module).

Public Interface
Internals

4.1.63 montezuma/src/search/sloppy-phrase-scorer.lisp

Dependency

phrase-scorer.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Internals

4.1.64 montezuma/src/search/exact-phrase-scorer.lisp

Dependency

phrase-scorer.lisp (file).

Source

montezuma.asd.

Parent Component

search (module).

Internals

4.1.65 montezuma/src/index/api.lisp

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.66 montezuma/src/index/index-filenames.lisp

Source

montezuma.asd.

Parent Component

index (module).

Internals

4.1.67 montezuma/src/index/term.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface

make-term (function).

Internals

4.1.68 montezuma/src/index/term-info.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface

print-object (method).

Internals

4.1.69 montezuma/src/index/term-buffer.lisp

Dependency

term.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.70 montezuma/src/index/field-infos.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.71 montezuma/src/index/term-enum.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Internals

4.1.72 montezuma/src/index/term-doc-enum.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.73 montezuma/src/index/term-infos-io.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.74 montezuma/src/index/multiple-term-doc-pos-enum.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.75 montezuma/src/index/term-vector-offset-info.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.76 montezuma/src/index/segment-term-vector.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.77 montezuma/src/index/term-vectors-io.lisp

Dependency

segment-term-vector.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.78 montezuma/src/index/segment-term-enum.lisp

Dependency

term-infos-io.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.79 montezuma/src/index/fields-io.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.80 montezuma/src/index/compound-file-io.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.81 montezuma/src/index/segment-merge-info.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.82 montezuma/src/index/segment-merge-queue.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface

close (method).

Internals

4.1.83 montezuma/src/index/segment-infos.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.84 montezuma/src/index/segment-reader.lisp

Dependencies
Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.85 montezuma/src/index/multi-reader.lisp

Dependency

index-reader.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.86 montezuma/src/index/index-writer.lisp

Dependency

segment-reader.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.87 montezuma/src/index/document-writer.lisp

Dependency

index-writer.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.88 montezuma/src/index/segment-merger.lisp

Dependencies
Source

montezuma.asd.

Parent Component

index (module).

Internals

4.1.89 montezuma/src/index/index-reader.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

4.1.90 montezuma/src/index/index.lisp

Dependency

api.lisp (file).

Source

montezuma.asd.

Parent Component

index (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 montezuma.parser

Source

package.lisp.

Use List

common-lisp.

Used By List

montezuma.

Public Interface
Internals

5.2 montezuma

Source

package.lisp.

Use List
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Macros

Macro: defchartype (name &body typespec)

Define a character-type production. The body should be a typespec that defines a type whose extension is a subset of characters, e.g. ’(member #a #b #c)

Package

montezuma.parser.

Source

parser.lisp.

Macro: deflexer (name spec (&rest meta))

Define a parser that collects a vector of tokens.

Package

montezuma.parser.

Source

parser.lisp.

Macro: defparser (name spec &key type)

Define a parser function in the PARSER grammar language.

Package

montezuma.parser.

Source

parser.lisp.

Macro: defprod (name (&rest vars) &body spec)

Define an arbitrary production in the PARSER grammar language.

Package

montezuma.parser.

Source

parser.lisp.

Macro: parselet ((&rest bindings) &body forms)

Define local parsers. Parslet is to defparser as flet is to defun.

Package

montezuma.parser.

Source

parser.lisp.


6.1.2 Ordinary functions

Function: make-field (name value &key stored index store-term-vector binary-p boost)
Package

montezuma.

Source

field.lisp.

Function: make-fs-directory (path &key create-p)
Package

montezuma.

Source

fs-store.lisp.

Function: make-term (field text)
Package

montezuma.

Source

term.lisp.

Reader: token-image (instance)
Writer: (setf token-image) (instance)
Package

montezuma.

Source

token.lisp.

Target Slot

image.


6.1.3 Generic functions

Generic Function: add-document (fields-writer document)
Package

montezuma.

Source

fields-io.lisp.

Methods
Method: add-document ((fields-writer fields-writer) document)
Generic Function: add-document-to-index (index doc &optional analyzer)
Package

montezuma.

Source

index.lisp.

Methods
Method: add-document-to-index ((self index) doc &optional analyzer)
Generic Function: add-document-to-index-writer (index-writer document &optional analyzer)
Package

montezuma.

Source

index-writer.lisp.

Methods
Method: add-document-to-index-writer ((self index-writer) document &optional analyzer)
Generic Function: add-field (document field)
Package

montezuma.

Source

document.lisp.

Methods
Method: add-field ((self document) (field field))
Generic Function: add-query (boolean-query query occur)
Package

montezuma.

Source

boolean-query.lisp.

Methods
Method: add-query ((self boolean-query) (query query) occur)
Generic Function: all-tokens (analyzer field string)
Package

montezuma.

Source

analyzers.lisp.

Methods
Method: all-tokens ((self analyzer) field string)
Generic Reader: analyzer (object)
Package

montezuma.

Methods
Reader Method: analyzer ((query-parser query-parser))

automatically generated reader method

Source

query-parser.lisp.

Target Slot

analyzer.

Reader Method: analyzer ((index index))

automatically generated reader method

Source

index.lisp.

Target Slot

analyzer.

Reader Method: analyzer ((index-writer index-writer))

automatically generated reader method

Source

index-writer.lisp.

Target Slot

analyzer.

Generic Function: close (index-output)
Package

montezuma.

Source

api.lisp.

Methods
Method: close ((self index-searcher))
Source

index-searcher.lisp.

Method: close :after ((self wildcard-term-enum))
Source

wildcard-term-enum.lisp.

Method: close ((self filtered-term-enum))
Source

filtered-term-enum.lisp.

Method: close ((self index))
Source

index.lisp.

Method: close ((self index-writer))
Source

index-writer.lisp.

Method: close ((self multi-term-doc-enum))
Source

multi-reader.lisp.

Method: close ((self multi-term-enum))
Source

multi-reader.lisp.

Method: close ((self index-reader))
Source

index-reader.lisp.

Method: close ((self segment-merge-queue))
Source

segment-merge-queue.lisp.

Method: close ((self segment-merge-info))
Source

segment-merge-info.lisp.

Method: close ((self compound-file-writer))
Source

compound-file-io.lisp.

Method: close ((self cs-index-input))
Source

compound-file-io.lisp.

Method: close ((self compound-file-reader))
Source

compound-file-io.lisp.

Method: close ((self fields-writer))
Source

fields-io.lisp.

Method: close ((self fields-reader))
Source

fields-io.lisp.

Method: close ((self segment-term-enum))
Source

segment-term-enum.lisp.

Method: close ((self term-vectors-reader))
Source

term-vectors-io.lisp.

Method: close ((self term-vectors-writer))
Source

term-vectors-io.lisp.

Method: close ((self multiple-term-doc-pos-enum))
Source

multiple-term-doc-pos-enum.lisp.

Method: close ((self term-infos-reader))
Source

term-infos-io.lisp.

Method: close ((self term-infos-writer))
Source

term-infos-io.lisp.

Method: close :after ((self segment-term-doc-pos-enum))
Source

term-doc-enum.lisp.

Method: close ((self segment-term-doc-enum))
Source

term-doc-enum.lisp.

Method: close ((self tokenizer))
Source

tokenizers.lisp.

Method: close ((self token-filter))
Source

token-filters.lisp.

Method: close ((self fs-index-input))
Source

fs-store.lisp.

Method: close :after ((self fs-index-output))
Source

fs-store.lisp.

Method: close ((self fs-directory))
Source

fs-store.lisp.

Method: close ((self ram-index-input))
Source

ram-store.lisp.

Method: close :after ((self ram-index-output))
Source

ram-store.lisp.

Method: close ((self ram-directory))
Source

ram-store.lisp.

Method: close ((self buffered-index-output))
Source

buffered-index-io.lisp.

Generic Function: commit (index-reader)
Package

montezuma.

Source

index-reader.lisp.

Methods
Method: commit ((self index-reader))
Generic Function: delete-document (index-reader doc-number)
Package

montezuma.

Source

index-reader.lisp.

Methods
Method: delete-document ((self index) id)
Source

index.lisp.

Method: delete-document ((self index-reader) doc-num)
Generic Function: doc (term-doc-enum)

Returns the current document number matching the query. Initially invalid, until #next?() is called the first time.

Package

montezuma.

Source

api.lisp.

Methods
Reader Method: doc ((score-doc score-doc))

automatically generated reader method

Source

score-doc.lisp.

Target Slot

doc.

Method: doc ((self multi-term-doc-enum))
Source

multi-reader.lisp.

Reader Method: doc ((multiple-term-doc-pos-enum multiple-term-doc-pos-enum))

automatically generated reader method

Source

multiple-term-doc-pos-enum.lisp.

Target Slot

doc.

Reader Method: doc ((segment-term-doc-enum segment-term-doc-enum))

automatically generated reader method

Source

term-doc-enum.lisp.

Target Slot

doc.

Generic Writer: (setf doc) (object)
Package

montezuma.

Methods
Writer Method: (setf doc) ((score-doc score-doc))

automatically generated writer method

Source

score-doc.lisp.

Target Slot

doc.

Generic Function: document (disjunction-sum-scorer)
Package

montezuma.

Source

api.lisp.

Methods
Method: document ((self phrase-scorer))
Source

phrase-scorer.lisp.

Reader Method: document ((phrase-positions phrase-positions))

automatically generated reader method

Source

phrase-positions.lisp.

Target Slot

document.

Method: document ((self match-all-scorer))
Source

match-all-query.lisp.

Method: document ((self boolean-scorer))
Source

boolean-scorer.lisp.

Method: document ((self single-match-scorer))
Source

boolean-scorer.lisp.

Method: document ((self req-excl-scorer))
Source

req-excl-scorer.lisp.

Method: document ((self req-opt-sum-scorer))
Source

req-opt-sum-scorer.lisp.

Method: document ((self conjunction-scorer))
Source

conjunction-scorer.lisp.

Method: document ((self disjunction-sum-scorer))
Source

disjunction-sum-scorer.lisp.

Reader Method: document ((term-scorer term-scorer))

automatically generated reader method

Source

term-scorer.lisp.

Target Slot

document.

Generic Function: document-field (document name)
Package

montezuma.

Source

document.lisp.

Methods
Method: document-field ((self document) name)
Generic Function: document-value (document field-name)
Package

montezuma.

Source

document.lisp.

Methods
Method: document-value ((document document) field-name)
Generic Function: (setf document-value) (document field-name)
Package

montezuma.

Source

document.lisp.

Methods
Method: (setf document-value) ((document document) field-name)
Generic Function: each (sequence function)
Package

montezuma.

Source

utilities.lisp.

Methods
Method: each ((self phrase-scorer) fn)
Source

phrase-scorer.lisp.

Method: each ((self top-docs) block)
Source

top-docs.lisp.

Method: each ((self list) block)
Generic Function: each-hit (scorer fn)
Package

montezuma.

Source

api.lisp.

Methods
Method: each-hit ((self boolean-scorer) fn)
Source

boolean-scorer.lisp.

Method: each-hit ((self term-scorer) fn)
Source

term-scorer.lisp.

Method: each-hit ((self scorer) fn)
Source

scorer.lisp.

Generic Reader: field (object)
Package

montezuma.

Methods
Reader Method: field ((range-query range-query))

automatically generated reader method

Source

range-query.lisp.

Target Slot

field.

Reader Method: field ((phrase-query phrase-query))

automatically generated reader method

Source

phrase-query.lisp.

Target Slot

field.

Reader Method: field ((segment-term-vector segment-term-vector))

automatically generated reader method

Source

segment-term-vector.lisp.

Target Slot

field.

Reader Method: field ((term-buffer term-buffer))

automatically generated reader method

Source

term-buffer.lisp.

Target Slot

field.

Generic Reader: field-data (object)
Package

montezuma.

Methods
Reader Method: field-data ((field field))

automatically generated reader method

Source

field.lisp.

Target Slot

data.

Generic Writer: (setf field-data) (object)
Package

montezuma.

Methods
Writer Method: (setf field-data) ((field field))

automatically generated writer method

Source

field.lisp.

Target Slot

data.

Generic Function: flush (index-output)
Package

montezuma.

Source

api.lisp.

Methods
Method: flush ((self index))
Source

index.lisp.

Method: flush ((self buffered-index-output))
Source

buffered-index-io.lisp.

Generic Function: get-document (index doc-number)
Package

montezuma.

Source

api.lisp.

Methods
Method: get-document ((self index-searcher) index)
Source

index-searcher.lisp.

Method: get-document ((self index) id)
Source

index.lisp.

Method: get-document ((self multi-reader) n)
Source

multi-reader.lisp.

Method: get-document ((self segment-reader) n)
Source

segment-reader.lisp.

Method: get-document ((self fields-reader) n)
Source

fields-io.lisp.

Generic Reader: index (object)
Package

montezuma.

Methods
Reader Method: index ((simple-field-comparator simple-field-comparator))

automatically generated reader method

Source

score-doc-comparator.lisp.

Target Slot

index.

Generic Function: max-doc (index-reader)
Package

montezuma.

Source

index-reader.lisp.

Methods
Method: max-doc ((self index-searcher))
Source

index-searcher.lisp.

Reader Method: max-doc ((multi-reader multi-reader))

automatically generated reader method

Source

multi-reader.lisp.

Target Slot

max-doc.

Method: max-doc ((self segment-reader))
Source

segment-reader.lisp.

Generic Function: optimize (index-writer)
Package

montezuma.

Source

api.lisp.

Methods
Method: optimize ((self index))
Source

index.lisp.

Method: optimize ((self index-writer))
Source

index-writer.lisp.

Generic Function: query-delete (index query)
Package

montezuma.

Source

index.lisp.

Methods
Method: query-delete ((self index) query)
Generic Function: query-update (index query new-val)
Package

montezuma.

Source

index.lisp.

Methods
Method: query-update ((self index) query new-val)
Generic Function: reader (index)
Package

montezuma.

Source

index.lisp.

Methods
Reader Method: reader ((index-searcher index-searcher))

automatically generated reader method

Source

index-searcher.lisp.

Target Slot

reader.

Method: reader ((self index))
Generic Writer: (setf reader) (object)
Package

montezuma.

Methods
Writer Method: (setf reader) ((index-searcher index-searcher))

automatically generated writer method

Source

index-searcher.lisp.

Target Slot

reader.

Generic Function: score (similarity)

Returns the score for the current document matching the query. Initially invalid, until #next?() is called the first time.

Package

montezuma.

Source

api.lisp.

Methods
Method: score ((self phrase-scorer))
Source

phrase-scorer.lisp.

Method: score ((self match-all-scorer))
Source

match-all-query.lisp.

Method: score ((self boolean-scorer))
Source

boolean-scorer.lisp.

Method: score :around ((self counting-conjunction-scorer))
Source

boolean-scorer.lisp.

Method: score :around ((self counting-disjunction-sum-scorer))
Source

boolean-scorer.lisp.

Method: score ((self single-match-scorer))
Source

boolean-scorer.lisp.

Method: score ((self req-excl-scorer))
Source

req-excl-scorer.lisp.

Method: score ((self req-opt-sum-scorer))
Source

req-opt-sum-scorer.lisp.

Method: score ((self conjunction-scorer))
Source

conjunction-scorer.lisp.

Method: score ((self disjunction-sum-scorer))
Source

disjunction-sum-scorer.lisp.

Method: score ((self term-scorer))
Source

term-scorer.lisp.

Reader Method: score ((score-doc score-doc))

automatically generated reader method

Source

score-doc.lisp.

Target Slot

score.

Generic Writer: (setf score) (object)
Package

montezuma.

Methods
Writer Method: (setf score) ((score-doc score-doc))

automatically generated writer method

Source

score-doc.lisp.

Target Slot

score.

Generic Function: scorer (weight reader)

Constructs a scorer for this.

Package

montezuma.

Source

api.lisp.

Methods
Method: scorer ((self match-all-weight) reader)
Source

match-all-query.lisp.

Method: scorer ((self phrase-weight) reader)
Source

phrase-query.lisp.

Method: scorer ((self boolean-weight) reader)
Source

boolean-query.lisp.

Method: scorer ((self term-weight) reader)
Source

term-query.lisp.

Package

montezuma.

Source

index.lisp.

Methods
Method: search ((self index-searcher) query &rest options)
Source

index-searcher.lisp.

Method: search ((self index) query &rest options)
Generic Function: search-each (index query fn &optional options)
Package

montezuma.

Source

index.lisp.

Methods
Method: search-each ((self index-searcher) (query query) fn &optional filter)
Source

index-searcher.lisp.

Method: search-each ((self index) query fn &optional options)
Generic Function: size (container)
Package

montezuma.

Source

priority-queue.lisp.

Methods
Method: size ((self top-docs))
Source

top-docs.lisp.

Method: size ((self index))
Source

index.lisp.

Method: size ((self segment-infos))
Source

segment-infos.lisp.

Reader Method: size ((cs-index-input cs-index-input))

automatically generated reader method

Source

compound-file-io.lisp.

Target Slot

size.

Reader Method: size ((compound-file-reader-file-entry compound-file-reader-file-entry))

automatically generated reader method

Source

compound-file-io.lisp.

Target Slot

size.

Reader Method: size ((fields-reader fields-reader))

automatically generated reader method

Source

fields-io.lisp.

Target Slot

size.

Reader Method: size ((segment-term-enum segment-term-enum))

automatically generated reader method

Source

segment-term-enum.lisp.

Target Slot

size.

Reader Method: size ((term-vectors-reader term-vectors-reader))

automatically generated reader method

Source

term-vectors-io.lisp.

Target Slot

size.

Method: size ((self segment-term-vector))
Source

segment-term-vector.lisp.

Reader Method: size ((term-infos-reader term-infos-reader))

automatically generated reader method

Source

term-infos-io.lisp.

Target Slot

size.

Reader Method: size ((term-infos-writer term-infos-writer))

automatically generated reader method

Source

term-infos-io.lisp.

Target Slot

size.

Method: size ((self field-infos))
Source

field-infos.lisp.

Reader Method: size ((fs-index-input fs-index-input))

automatically generated reader method

Source

fs-store.lisp.

Target Slot

size.

Reader Method: size ((ram-file ram-file))

automatically generated reader method

Source

ram-store.lisp.

Target Slot

size.

Method: size ((self ram-index-input))
Source

ram-store.lisp.

Method: size ((self ram-index-output))
Source

ram-store.lisp.

Method: size ((queue priority-queue))
Generic Writer: (setf size) (object)
Package

montezuma.

Methods
Writer Method: (setf size) ((compound-file-reader-file-entry compound-file-reader-file-entry))

automatically generated writer method

Source

compound-file-io.lisp.

Target Slot

size.

Writer Method: (setf size) ((ram-file ram-file))

automatically generated writer method

Source

ram-store.lisp.

Target Slot

size.

Generic Function: update (index id new-val)
Package

montezuma.

Source

index.lisp.

Methods
Method: update ((self index) id new-val)
Generic Function: weight (query searcher)

Expert: Constructs and initializes a Weight for a top-level query.

Package

montezuma.

Source

api.lisp.

Methods
Method: weight ((self query) searcher)
Source

query.lisp.

Generic Function: writer (index)
Package

montezuma.

Source

index.lisp.

Methods
Method: writer ((self index))

6.1.4 Standalone methods

Method: initialize-instance :after ((self index) &rest args &key &allow-other-keys)
Source

index.lisp.

Method: initialize-instance :after ((self index-writer) &key create-p create-if-missing-p &allow-other-keys)
Source

index-writer.lisp.

Method: initialize-instance :after ((self index-searcher) &key directory reader)
Source

index-searcher.lisp.

Method: initialize-instance :after ((self boolean-clause) &key)
Source

boolean-clause.lisp.

Method: initialize-instance :after ((queue priority-queue) &key)
Source

priority-queue.lisp.

Method: initialize-instance :after ((self index-reader) &key)
Source

index-reader.lisp.

Method: initialize-instance :after ((self disjunction-sum-scorer) &key)
Source

disjunction-sum-scorer.lisp.

Method: initialize-instance :after ((self sort) &key)
Source

sort.lisp.

Method: initialize-instance :after ((self regexp-tokenizer) &key)
Source

tokenizers.lisp.

Method: initialize-instance :after ((self buffered-index-output) &key)
Source

buffered-index-io.lisp.

Method: initialize-instance :after ((self boolean-scorer) &key)
Source

boolean-scorer.lisp.

Method: initialize-instance :after ((self field-infos) &key directory name)
Source

field-infos.lisp.

Method: initialize-instance :after ((self phrase-weight) &key searcher)
Source

phrase-query.lisp.

Method: initialize-instance :after ((self segment-term-doc-enum) &key)
Source

term-doc-enum.lisp.

Method: initialize-instance :after ((self segment-term-doc-pos-enum) &key)
Source

term-doc-enum.lisp.

Method: initialize-instance :after ((self multiple-term-doc-pos-enum) &key reader terms)
Source

multiple-term-doc-pos-enum.lisp.

Method: initialize-instance :after ((self term-infos-reader) &key)
Source

term-infos-io.lisp.

Method: initialize-instance :after ((self term-infos-writer) &key directory segment)
Source

term-infos-io.lisp.

Method: initialize-instance :after ((self counting-conjunction-scorer) &key)
Source

boolean-scorer.lisp.

Method: initialize-instance :after ((self multi-term-enum) &key readers starts term)
Source

multi-reader.lisp.

Method: initialize-instance :after ((self fs-index-input) &key path)
Source

fs-store.lisp.

Method: initialize-instance :after ((self phrase-scorer) &key term-positions positions)
Source

phrase-scorer.lisp.

Method: initialize-instance :after ((self stop-filter) &key file)
Source

token-filters.lisp.

Method: initialize-instance :after ((self boolean-weight) &key)
Source

boolean-query.lisp.

Method: initialize-instance :after ((self segment-reader) &key info)
Source

segment-reader.lisp.

Method: initialize-instance :after ((self match-all-scorer) &key)
Source

match-all-query.lisp.

Method: initialize-instance :after ((self fs-index-output) &key path)
Source

fs-store.lisp.

Method: initialize-instance :after ((self segment-merge-info) &key)
Source

segment-merge-info.lisp.

Method: initialize-instance :after ((self fields-writer) &key directory segment)
Source

fields-io.lisp.

Method: initialize-instance :after ((self compound-file-reader) &key)
Source

compound-file-io.lisp.

Method: initialize-instance :after ((self term-vectors-writer) &key directory segment)
Source

term-vectors-io.lisp.

Method: initialize-instance :after ((self segment-term-enum) &key)
Source

segment-term-enum.lisp.

Method: initialize-instance :after ((self term-vectors-reader) &key directory segment)
Source

term-vectors-io.lisp.

Method: initialize-instance :after ((self query-parser) &key)
Source

query-parser.lisp.

Method: initialize-instance :after ((self sort-field) &key)
Source

sort-field.lisp.

Method: initialize-instance :after ((self wildcard-term-enum) &key reader)
Source

wildcard-term-enum.lisp.

Method: initialize-instance :after ((self fields-reader) &key directory segment)
Source

fields-io.lisp.

Method: initialize-instance :after ((self term-scorer) &key)
Source

term-scorer.lisp.

Method: initialize-instance :after ((self buffered-index-input) &key)
Source

buffered-index-io.lisp.

Method: initialize-instance :after ((self term-weight) &key query searcher)
Source

term-query.lisp.

Method: initialize-instance :around ((self multi-reader) &key directory sub-readers)
Source

multi-reader.lisp.

Method: initialize-instance :after ((self fs-directory) &key)
Source

fs-store.lisp.

Method: initialize-instance :after ((self multi-term-doc-enum) &key)
Source

multi-reader.lisp.

Method: initialize-instance :after ((self cs-index-input) &key)
Source

compound-file-io.lisp.

Method: initialize-instance :after ((self single-match-scorer) &key)
Source

boolean-scorer.lisp.

Method: initialize-instance :after ((self term-vector-offset-info) &key)
Source

term-vector-offset-info.lisp.

Method: initialize-instance :after ((self ram-directory) &key close-dir-p)
Source

ram-store.lisp.

Method: initialize-instance :after ((self term-positions-queue) &key term-positions)
Source

multiple-term-doc-pos-enum.lisp.

Method: initialize-instance :after ((self posting) &key position offset)
Source

document-writer.lisp.

Method: initialize-instance :after ((self range-query) &key)
Source

range-query.lisp.

Method: print-object ((self token) stream)
Source

parser.lisp.

Method: print-object ((self document) stream)
Source

document.lisp.

Method: print-object ((self boolean-query) stream)
Source

boolean-query.lisp.

Method: print-object ((self boolean-clause) stream)
Source

boolean-clause.lisp.

Method: print-object ((self term-query) stream)
Source

term-query.lisp.

Method: print-object ((self field) stream)
Source

field.lisp.

Method: print-object ((self segment-infos) stream)
Source

segment-infos.lisp.

Method: print-object ((self phrase-weight) stream)
Source

phrase-query.lisp.

Method: print-object ((self ram-index-input) stream)
Source

ram-store.lisp.

Method: print-object ((self term-info) stream)
Source

term-info.lisp.

Method: print-object ((self segment-term-vector) stream)
Source

segment-term-vector.lisp.

Method: print-object ((self top-docs) stream)
Source

top-docs.lisp.

Method: print-object ((self segment-info) stream)
Source

segment-infos.lisp.

Method: print-object ((self phrase-scorer) stream)
Source

phrase-scorer.lisp.

Method: print-object ((self multi-term-query) stream)
Source

multi-term-query.lisp.

Method: print-object ((self ram-file) stream)
Source

ram-store.lisp.

Method: print-object ((self segment-reader) stream)
Source

segment-reader.lisp.

Method: print-object ((self ram-index-output) stream)
Source

ram-store.lisp.

Method: print-object ((self segment-merge-info) stream)
Source

segment-merge-info.lisp.

Method: print-object ((self field-info) stream)
Source

field-infos.lisp.

Method: print-object ((self phrase-query) stream)
Source

phrase-query.lisp.

Method: print-object ((self term-scorer) stream)
Source

term-scorer.lisp.

Method: print-object ((self term-weight) stream)
Source

term-query.lisp.

Method: print-object ((self term-buffer) stream)
Source

term-buffer.lisp.

Method: print-object ((self fs-directory) stream)
Source

fs-store.lisp.

Method: print-object ((self phrase-positions) stream)
Source

phrase-positions.lisp.

Method: print-object ((self multi-term-doc-enum) stream)
Source

multi-reader.lisp.

Method: print-object ((self term-vector-offset-info) stream)
Source

term-vector-offset-info.lisp.

Method: print-object ((self score-doc) stream)
Source

score-doc.lisp.

Method: print-object ((self posting) stream)
Source

document-writer.lisp.


6.1.5 Classes

Class: analyzer
Package

montezuma.

Source

analyzers.lisp.

Direct subclasses
Direct methods
Class: boolean-clause
Package

montezuma.

Source

boolean-clause.lisp.

Direct methods
Direct slots
Slot: query

The query whose matching documents are combined by the boolean query.

Initargs

:query

Readers

query.

Writers

(setf query).

Slot: required

If true, documents documents which _do not_ match this sub-query will _not_ match the boolean query.

Readers

required?.

Writers

required.

Slot: prohibited

If true, documents documents which _do_ match this sub-query will _not_ match the boolean query.

Readers

prohibited?.

Writers

prohibited.

Slot: occur

See BooleanQuery::Occur for values for this attribute.

Initform

:should-occur

Initargs

:occur

Readers

occur.

Writers

(setf occur).

Class: boolean-query
Package

montezuma.

Source

boolean-query.lisp.

Direct superclasses

query.

Direct methods
Direct Default Initargs
InitargValue
:max-clause-count+default-max-clause-count+
Direct slots
Slot: clauses
Initform

(make-array 10 :adjustable t :fill-pointer 0)

Readers

clauses.

Writers

(setf clauses).

Slot: coord-disabled
Initform

t

Initargs

:coord-disabled

Readers

coord-disabled?.

Writers

This slot is read-only.

Slot: max-clause-count
Allocation

:class

Initargs

:max-clause-count

Readers

max-clause-count.

Writers

(setf max-clause-count).

Class: document
Package

montezuma.

Source

document.lisp.

Direct methods
Direct slots
Slot: boost
Initform

1.0

Initargs

:boost

Readers

boost.

Writers

(setf boost).

Slot: fields
Initform

(montezuma::make-table :test (function equal))

Class: field
Package

montezuma.

Source

field.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

field-name.

Writers

This slot is read-only.

Slot: data
Initargs

:data

Readers

field-data.

Writers

(setf field-data).

Slot: boost
Initform

1.0

Initargs

:boost

Readers

boost.

Writers

(setf boost).

Slot: stored-p
Initargs

:stored-p

Readers

field-stored-p.

Writers

(setf field-stored-p).

Slot: indexed-p
Initform

t

Initargs

:indexed-p

Readers

field-indexed-p.

Writers

(setf field-indexed-p).

Slot: tokenized-p
Initform

t

Initargs

:tokenized-p

Readers

field-tokenized-p.

Writers

(setf field-tokenized-p).

Slot: binary-p
Initargs

:binary-p

Readers

field-binary-p.

Writers

(setf field-binary-p).

Slot: compressed-p
Initargs

:compressed-p

Readers

field-compressed-p.

Writers

(setf field-compressed-p).

Slot: store-term-vector-p
Initargs

:store-term-vector-p

Readers

field-store-term-vector-p.

Writers

(setf field-store-term-vector-p).

Slot: store-positions-p
Initargs

:store-positions-p

Readers

field-store-positions-p.

Writers

(setf field-store-positions-p).

Slot: store-offsets-p
Initargs

:store-offsets-p

Readers

field-store-offsets-p.

Writers

(setf field-store-offsets-p).

Slot: omit-norms-p
Initargs

:omit-norms-p

Readers

field-omit-norms-p.

Writers

(setf field-omit-norms-p).

Class: index
Package

montezuma.

Source

index.lisp.

Direct methods
Direct slots
Slot: key
Slot: dir
Slot: has-writes-p
Slot: reader
Slot: writer
Slot: close-dir-p
Slot: auto-flush-p
Slot: default-search-field
Slot: default-field
Slot: analyzer
Readers

analyzer.

Writers

This slot is read-only.

Slot: searcher
Slot: open-p
Initform

t

Slot: options
Slot: qp
Class: index-searcher
Package

montezuma.

Source

index-searcher.lisp.

Direct methods
Direct Default Initargs
InitargValue
:similarity(make-default-similarity)
Direct slots
Slot: similarity
Initargs

:similarity

Readers

similarity.

Writers

(setf similarity).

Slot: reader
Readers

reader.

Writers

(setf reader).

Slot: directory
Readers

directory.

Writers

(setf directory).

Class: index-writer
Package

montezuma.

Source

index-writer.lisp.

Direct methods
Direct Default Initargs
InitargValue
:close-dir-pnil
:use-compound-file-pt
:analyzer(make-instance (quote standard-analyzer))
:merge-factor*index-writer-default-merge-factor*
:min-merge-docs*index-writer-default-min-merge-docs*
:max-merge-docs*index-writer-default-max-merge-docs*
:max-field-length*index-writer-default-max-field-length*
:term-index-interval*index-writer-default-term-index-interval*
Direct slots
Slot: directory
Initargs

:directory

Slot: close-dir-p
Initargs

:close-dir-p

Slot: use-compound-file-p
Initargs

:use-compound-file-p

Slot: analyzer
Initargs

:analyzer

Readers

analyzer.

Writers

This slot is read-only.

Slot: merge-factor
Initargs

:merge-factor

Readers

merge-factor.

Writers

(setf merge-factor).

Slot: min-merge-docs
Initargs

:min-merge-docs

Readers

min-merge-docs.

Writers

(setf min-merge-docs).

Slot: max-merge-docs
Initargs

:max-merge-docs

Readers

max-merge-docs.

Writers

(setf max-merge-docs).

Slot: max-field-length
Initargs

:max-field-length

Slot: term-index-interval
Initargs

:term-index-interval

Slot: similarity
Initform

(montezuma::make-default-similarity)

Slot: segment-infos
Initform

(make-instance (quote montezuma::segment-infos))

Slot: ram-directory
Slot: info-stream
Initargs

:info-stream

Readers

info-stream.

Writers

(setf info-stream).

Class: match-all-query
Package

montezuma.

Source

match-all-query.lisp.

Direct superclasses

query.

Direct methods

create-weight.

Class: scorer
Package

montezuma.

Source

scorer.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: similarity
Initargs

:similarity

Readers

similarity.

Writers

This slot is read-only.

Class: standard-analyzer

The STANDARD-ANALYZER skips stop words, normalizes to lower case and also filter tokens through the STANDARD-TOKENIZER.

Package

montezuma.

Source

analyzers.lisp.

Direct superclasses

stop-analyzer.

Direct methods

token-stream.

Class: term-query
Package

montezuma.

Source

term-query.lisp.

Direct superclasses

query.

Direct methods
Direct slots
Slot: term
Initargs

:term

Readers

term.

Writers

This slot is read-only.

Class: weight
Package

montezuma.

Source

weight.lisp.

Direct subclasses
Class: whitespace-analyzer
Package

montezuma.

Source

analyzers.lisp.

Direct superclasses

analyzer.

Direct methods

token-stream.


6.2 Internals


6.2.1 Constants

Constant: empty-pipe
Package

montezuma.

Source

pipes.lisp.


6.2.2 Special variables

Special Variable: *acronym-word-regexp*
Package

montezuma.

Source

standard-tokenizer.lisp.

Special Variable: *apostrophe-s-regexp*
Package

montezuma.

Source

standard-tokenizer.lisp.

Special Variable: *apostrophe-word-regexp*
Package

montezuma.

Source

standard-tokenizer.lisp.

Special Variable: *auto-sorter*
Package

montezuma.

Source

sort-field.lisp.

Special Variable: *default-buffer-size*
Package

montezuma.

Source

buffered-index-io.lisp.

Special Variable: *directory-cache*
Package

montezuma.

Source

fs-store.lisp.

Special Variable: *doc-sorter*
Package

montezuma.

Source

sort-field.lisp.

Special Variable: *dot-regexp*
Package

montezuma.

Source

standard-tokenizer.lisp.

Special Variable: *english-stop-words*
Package

montezuma.

Source

analyzers.lisp.

Special Variable: *fdt-extension*
Package

montezuma.

Source

fields-io.lisp.

Special Variable: *fdx-extension*
Package

montezuma.

Source

fields-io.lisp.

Special Variable: *field-doc*
Package

montezuma.

Source

sort-field.lisp.

Special Variable: *field-score*
Package

montezuma.

Source

sort-field.lisp.

Special Variable: *float-sorter*
Package

montezuma.

Source

sort-field.lisp.

Special Variable: *fnm-extension*
Package

montezuma.

Source

document-writer.lisp.

Special Variable: *frq-extension*
Package

montezuma.

Source

document-writer.lisp.

Special Variable: *index-compound-extensions*
Package

montezuma.

Source

index-filenames.lisp.

Special Variable: *index-deletable-filename*
Package

montezuma.

Source

index-filenames.lisp.

Special Variable: *index-filename-extensions*
Package

montezuma.

Source

index-filenames.lisp.

Special Variable: *index-order*
Package

montezuma.

Source

sort.lisp.

Special Variable: *index-reader-filename-extensions*
Package

montezuma.

Source

index-reader.lisp.

Special Variable: *index-segments-filename*
Package

montezuma.

Source

index-filenames.lisp.

Special Variable: *index-vector-extensions*
Package

montezuma.

Source

index-filenames.lisp.

Special Variable: *index-writer-commit-lock-name*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *index-writer-commit-lock-timeout*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *index-writer-default-max-field-length*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *index-writer-default-max-merge-docs*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *index-writer-default-merge-factor*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *index-writer-default-min-merge-docs*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *index-writer-default-term-index-interval*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *index-writer-write-lock-name*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *index-writer-write-lock-timeout*
Package

montezuma.

Source

index-writer.lisp.

Special Variable: *int-sorter*
Package

montezuma.

Source

sort-field.lisp.

Special Variable: *norm-table*
Package

montezuma.

Source

similarity.lisp.

Special Variable: *productions*
Package

montezuma.parser.

Source

parser.lisp.

Special Variable: *prx-extension*
Package

montezuma.

Source

document-writer.lisp.

Special Variable: *relevance*
Package

montezuma.

Source

sort.lisp.

Special Variable: *score-sorter*
Package

montezuma.

Source

sort-field.lisp.

Special Variable: *segment-filename*
Package

montezuma.

Source

segment-infos.lisp.

Special Variable: *segment-format*
Package

montezuma.

Source

segment-infos.lisp.

Special Variable: *string-sorter*
Package

montezuma.

Source

sort-field.lisp.

Special Variable: *temporary-segment-filename*
Package

montezuma.

Source

segment-infos.lisp.

Special Variable: *term-vectors-format-size*
Package

montezuma.

Source

term-vectors-io.lisp.

Special Variable: *term-vectors-format-version*
Package

montezuma.

Source

term-vectors-io.lisp.

Special Variable: *tvd-extension*
Package

montezuma.

Source

term-vectors-io.lisp.

Special Variable: *tvf-extension*
Package

montezuma.

Source

term-vectors-io.lisp.

Special Variable: *tvx-extension*
Package

montezuma.

Source

term-vectors-io.lisp.

Special Variable: *valid-index-options*
Package

montezuma.

Source

index.lisp.

Special Variable: +default-max-clause-count+
Package

montezuma.

Source

boolean-query.lisp.

Special Variable: +field-is-binary-bit+
Package

montezuma.

Source

fields-io.lisp.

Special Variable: +field-is-compressed-bit+
Package

montezuma.

Source

fields-io.lisp.

Special Variable: +field-is-tokenized-bit+
Package

montezuma.

Source

fields-io.lisp.

Special Variable: +int-max+
Package

montezuma.

Source

segment-term-enum.lisp.

Special Variable: +is-indexed+
Package

montezuma.

Source

field-infos.lisp.

Special Variable: +max-docs+
Package

montezuma.

Source

scorer.lisp.

Special Variable: +not-a-field+
Package

montezuma.

Source

field-infos.lisp.

Special Variable: +omit-norms+
Package

montezuma.

Source

field-infos.lisp.

Special Variable: +score-cache-size+
Package

montezuma.

Source

term-scorer.lisp.

Special Variable: +store-offset+
Package

montezuma.

Source

field-infos.lisp.

Special Variable: +store-offset-with-term-vector+
Package

montezuma.

Source

term-vectors-io.lisp.

Special Variable: +store-position+
Package

montezuma.

Source

field-infos.lisp.

Special Variable: +store-positions-with-term-vector+
Package

montezuma.

Source

term-vectors-io.lisp.

Special Variable: +store-term-vector+
Package

montezuma.

Source

field-infos.lisp.

Special Variable: +term-infos-format+
Package

montezuma.

Source

term-infos-io.lisp.

Special Variable: +wildcard-char+
Package

montezuma.

Source

wildcard-term-enum.lisp.

Special Variable: +wildcard-string+
Package

montezuma.

Source

wildcard-term-enum.lisp.


6.2.3 Macros

Macro: do-files ((file-var directory) &body body)
Package

montezuma.

Source

directory.lisp.

Macro: do-multiple-fields ((field-var parser field-spec) &body body)
Package

montezuma.

Source

query-parser.lisp.

Macro: do-range ((var start-form end-form &optional result-form) &body body)

Iterates VAR through the range of integers in [START-FORM, END-FORM). Returns the value of END-FORM (at the time END-FORM is evaluated, VAR is bound to the value of END-FORM.

(do-range (i 10 (length s))
(print (elt s i)))

Package

montezuma.

Source

while.lisp.

Macro: dosequence ((var sequence &key result index) &body body)
Package

montezuma.

Source

while.lisp.

Macro: make-pipe (head tail)

create a pipe by eval’ing head and delaying tail.

Package

montezuma.

Source

pipes.lisp.

Macro: once-only ((&rest names) &body body)
Package

montezuma.

Source

while.lisp.

Macro: while (expr &body body)
Package

montezuma.

Source

while.lisp.

Macro: with-gensyms ((&rest names) &body body)
Package

montezuma.

Source

while.lisp.

Macro: with-lock ((lock) &body body)
Package

montezuma.

Source

directory.lisp.

Macro: with-sub-reader ((sub-reader-var start-var) multi-reader n &body body)
Package

montezuma.

Source

multi-reader.lisp.


6.2.4 Ordinary functions

Reader: %term-field (instance)
Writer: (setf %term-field) (instance)
Package

montezuma.

Source

term.lisp.

Target Slot

field.

Reader: %term-text (instance)
Writer: (setf %term-text) (instance)
Package

montezuma.

Source

term.lisp.

Target Slot

text.

Function: add-file-extension (file extension)
Package

montezuma.

Source

files.lisp.

Function: append-pipes (pipex pipey)

return a pipe that appends two pipes

Package

montezuma.

Source

pipes.lisp.

Function: bit-set-p (bit-vector index)
Package

montezuma.

Source

bit-vector.lisp.

Function: bit-vector-count (bit-vector)
Package

montezuma.

Source

bit-vector.lisp.

Function: byte315-to-float (b)
Package

montezuma.

Source

similarity.lisp.

Function: bytes-to-string (sequence &key start end)

Converts a sequence of octets to a string using the implementation’s default character encoding.

Package

montezuma.

Source

strings.lisp.

Function: class-slots (class)
Package

montezuma.

Source

mop.lisp.

Function: clear-bit (bit-vector index)
Package

montezuma.

Source

bit-vector.lisp.

Function: clear-fs-directory-cache ()
Package

montezuma.

Source

fs-store.lisp.

Function: clone (object)
Package

montezuma.

Source

mop.lisp.

Function: combine-multiple-fields (queries)
Package

montezuma.

Source

query-parser.lisp.

Function: compress (input)
Package

montezuma.

Source

fields-io.lisp.

Function: consonantp (str i)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: convert-alist-to-table (alist &key test)
Package

montezuma.

Source

tables.lisp.

Function: coord-disabled-function (similarity overlap max-overlap)
Package

montezuma.

Source

boolean-query.lisp.

Function: coord-function-not-implemented (similarity overlap max-overlap)
Package

montezuma.

Source

similarity.lisp.

Function: copy-table (instance)
Package

montezuma.

Source

tables.lisp.

Function: copy-term (instance)
Package

montezuma.

Source

term.lisp.

Function: copy-token (instance)
Package

montezuma.

Source

token.lisp.

Function: copy-tv-field (instance)
Package

montezuma.

Source

term-vectors-io.lisp.

Function: create-fake-norms (size)
Package

montezuma.

Source

segment-reader.lisp.

Function: cvc (str lim)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: default-coord-function (similarity overlap max-overlap)
Package

montezuma.

Source

similarity.lisp.

Function: disallowed-punctuation-p (char)
Package

montezuma.

Source

query-parser.lisp.

Function: doublec (str i)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: dump-tokens (filename lexer-fn)
Package

montezuma.parser.

Source

parser.lisp.

Function: ends (str ending)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: enumerate (pipe &key count key result)

go through all or count elements of pipe, possibly applying the key function.

Package

montezuma.

Source

pipes.lisp.

Function: filter-pipe (predicate pipe)

keep only items in (non-null) pipe satisfying predicate

Package

montezuma.

Source

pipes.lisp.

Function: float-to-byte315 (f)
Package

montezuma.

Source

similarity.lisp.

Function: float-to-raw-int-bits (f)
Package

montezuma.

Source

similarity.lisp.

Function: force (pipe)
Package

montezuma.

Source

pipes.lisp.

Function: get-index-option (options option &optional default)
Setf Expander: (setf get-index-option) (place option)
Package

montezuma.

Source

index.lisp.

Function: get-segment-reader (segment-info &key infos close-directory-p)
Package

montezuma.

Source

segment-reader.lisp.

Function: heap-extract (heap i &key key test)
Package

montezuma.

Source

priority-queue.lisp.

Function: heap-extract-maximum (heap &key key test)
Package

montezuma.

Source

priority-queue.lisp.

Function: heap-insert (heap new-item &key key test)
Package

montezuma.

Source

priority-queue.lisp.

Function: heap-left (i)
Package

montezuma.

Source

priority-queue.lisp.

Function: heap-maximum (heap)
Package

montezuma.

Source

priority-queue.lisp.

Function: heap-parent (i)
Package

montezuma.

Source

priority-queue.lisp.

Function: heap-right (i)
Package

montezuma.

Source

priority-queue.lisp.

Function: heap-size (heap)
Package

montezuma.

Source

priority-queue.lisp.

Function: heapify (heap start &key key test)
Package

montezuma.

Source

priority-queue.lisp.

Function: index-options-list-p (list)
Package

montezuma.

Source

index.lisp.

Function: inject (sequence base function &key key)
Package

montezuma.

Source

while.lisp.

Function: int-bits-to-float (bits)
Package

montezuma.

Source

similarity.lisp.

Function: length-1-list-p (x)

Is x a list of length 1? Note that this is better than the naive (= (length x) 1) because we don’t need to traverse the entire list...

Package

montezuma.

Source

utilities.lisp.

Function: load-word-list (path)
Package

montezuma.

Source

token-filters.lisp.

Function: m (str lim)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: make-adjustable-string (length &optional s)
Package

montezuma.

Source

strings.lisp.

Function: make-binary-field (name value stored)
Package

montezuma.

Source

field.lisp.

Function: make-bit-vector ()
Package

montezuma.

Source

bit-vector.lisp.

Function: make-default-similarity ()
Package

montezuma.

Source

similarity.lisp.

Function: make-document ()
Package

montezuma.

Source

document.lisp.

Function: make-scorers-array ()
Package

montezuma.

Source

conjunction-scorer.lisp.

Function: make-sort-type (name &optional parser)
Package

montezuma.

Source

sort-field.lisp.

Function: make-table (&key entries test)
Package

montezuma.

Source

tables.lisp.

Function: make-term-scorer-array ()
Package

montezuma.

Source

term-scorer.lisp.

Function: make-token (image start end &key increment type)
Package

montezuma.

Source

token.lisp.

Function: make-tv-field (&key tvf-pointer number store-positions store-offsets)
Package

montezuma.

Source

term-vectors-io.lisp.

Function: map-pipe (fn pipe)

Map fn over pipe, delaying all but the first fn call, collecting results

Package

montezuma.

Source

pipes.lisp.

Function: map-pipe-filtering (fn pipe &optional filter-test)

Map fn over pipe, delaying all but the first fn call, collecting results

Package

montezuma.

Source

pipes.lisp.

Function: mappend-pipe (fn pipe)

lazily map fn over pipe, appending results

Package

montezuma.

Source

pipes.lisp.

Function: mappend-pipe-filtering (fn pipe &optional filter-test)

Map fn over pipe, delaying all but the first fn call, appending results, filtering along the way

Package

montezuma.

Source

pipes.lisp.

Function: normalize-file-name (name)
Package

montezuma.

Source

ram-store.lisp.

Function: not-wildcard-char-p (char)
Package

montezuma.

Source

query-parser.lisp.

Function: open-index-reader (directory &key close-directory-p infos)
Package

montezuma.

Source

index-reader.lisp.

Function: open-segment-file (directory segment extension direction)
Package

montezuma.

Source

fields-io.lisp.

Function: parse-float (string)
Package

montezuma.

Source

utilities.lisp.

Function: pipe-elt (pipe i)

ith element of pipe, 0 based.

Package

montezuma.

Source

pipes.lisp.

Function: pipe-head (pipe)
Package

montezuma.

Source

pipes.lisp.

Function: pipe-tail (pipe)

return tail of pipe or list, and destructively update the tail if it is a function.

Package

montezuma.

Source

pipes.lisp.

Function: posting-key (term)
Package

montezuma.

Source

document-writer.lisp.

Function: r (str s sfp)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: read-bit-vector (directory filename)
Package

montezuma.

Source

bit-vector.lisp.

Function: segment-infos-read-current-version (directory)
Package

montezuma.

Source

segment-infos.lisp.

Function: set-bit (bit-vector index)
Package

montezuma.

Source

bit-vector.lisp.

Function: setto (str suffix)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: similarity-byte-to-float (b)
Package

montezuma.

Source

similarity.lisp.

Function: similarity-decode-norm (b)
Package

montezuma.

Source

similarity.lisp.

Function: similarity-encode-norm (f)
Package

montezuma.

Source

similarity.lisp.

Function: similarity-float-to-byte (f)
Package

montezuma.

Source

similarity.lisp.

Function: slot-definition-name (slot-defn)
Package

montezuma.

Source

mop.lisp.

Function: stem (str)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: step1ab (str)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: step1c (str)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: step2 (str)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: step3 (str)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: step4 (str)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: step5 (str)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: stream-contents (stream)

Returns a string with the entire contents of the specified stream.

Package

montezuma.

Source

streams.lisp.

Function: string-begins (string pattern)
Package

montezuma.

Source

strings.lisp.

Function: string-compare (s1 s2 &key start1 end1 start2 end2)
Package

montezuma.

Source

strings.lisp.

Function: string-scanner (regexp string)
Package

montezuma.

Source

tokenizers.lisp.

Function: string-to-bytes (string &key start end)

Converts a string to a sequence of octets using the implementation’s default character encoding.

NB: START and END denote bounds for the final octet vector,
not for STRING.

Package

montezuma.

Source

strings.lisp.

Function: stringify (x)
Package

montezuma.

Source

index.lisp.

Reader: table-entries (instance)
Writer: (setf table-entries) (instance)
Package

montezuma.

Source

tables.lisp.

Target Slot

entries.

Function: table-p (object)
Package

montezuma.

Source

tables.lisp.

Reader: table-test (instance)
Writer: (setf table-test) (instance)
Package

montezuma.

Source

tables.lisp.

Target Slot

test.

Function: term-buffer-compare (tb1 tb2)
Package

montezuma.

Source

term-buffer.lisp.

Function: term-buffer< (tb1 tb2)
Package

montezuma.

Source

term-buffer.lisp.

Function: term-buffer= (tb1 tb2)
Package

montezuma.

Source

term-buffer.lisp.

Function: term-buffer> (tb1 tb2)
Package

montezuma.

Source

term-buffer.lisp.

Function: term-info= (ti1 ti2)
Package

montezuma.

Source

term-info.lisp.

Function: term-p (object)
Package

montezuma.

Source

term.lisp.

Function: term-vector-offset-info= (a b)
Package

montezuma.

Source

term-vector-offset-info.lisp.

Function: term< (t1 t2)
Package

montezuma.

Source

term.lisp.

Function: term> (t1 t2)
Package

montezuma.

Source

term.lisp.

Function: token-compare (t1 t2)
Package

montezuma.

Source

token.lisp.

Reader: token-end (instance)
Writer: (setf token-end) (instance)
Package

montezuma.

Source

token.lisp.

Target Slot

end.

Reader: token-increment (instance)
Writer: (setf token-increment) (instance)
Package

montezuma.

Source

token.lisp.

Target Slot

increment.

Function: token-p (object)
Package

montezuma.

Source

token.lisp.

Reader: token-start (instance)
Writer: (setf token-start) (instance)
Package

montezuma.

Source

token.lisp.

Target Slot

start.

Reader: token-type (instance)
Writer: (setf token-type) (instance)
Package

montezuma.

Source

token.lisp.

Target Slot

type.

Function: token= (t1 t2)
Package

montezuma.

Source

token.lisp.

Function: tokenize-file (filename lexer-fn)

Tokenize the given file with the given lexer function.

Package

montezuma.parser.

Source

parser.lisp.

Reader: tv-field-number (instance)
Writer: (setf tv-field-number) (instance)
Package

montezuma.

Source

term-vectors-io.lisp.

Target Slot

number.

Function: tv-field-p (object)
Package

montezuma.

Source

term-vectors-io.lisp.

Reader: tv-field-store-offsets (instance)
Writer: (setf tv-field-store-offsets) (instance)
Package

montezuma.

Source

term-vectors-io.lisp.

Target Slot

store-offsets.

Reader: tv-field-store-positions (instance)
Writer: (setf tv-field-store-positions) (instance)
Package

montezuma.

Source

term-vectors-io.lisp.

Target Slot

store-positions.

Reader: tv-field-tvf-pointer (instance)
Writer: (setf tv-field-tvf-pointer) (instance)
Package

montezuma.

Source

term-vectors-io.lisp.

Target Slot

tvf-pointer.

Function: uncompress (input)
Package

montezuma.

Source

fields-io.lisp.

Function: vowelinstem (str)
Package

montezuma.

Source

porter-stemmer.lisp.

Function: white-space-p (char)
Package

montezuma.

Source

query-parser.lisp.

Function: wildcard-char-p (char)
Package

montezuma.

Source

query-parser.lisp.

Function: write-bit-vector (bit-vector directory filename)
Package

montezuma.

Source

bit-vector.lisp.


6.2.5 Generic functions

Generic Function: $add-and-clause (parser clauses clause)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $add-and-clause ((parser query-parser) clauses clause)
Generic Function: $add-default-clause (parser clauses clause)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $add-default-clause ((parser query-parser) clauses clause)
Generic Function: $add-or-clause (parser clauses clause)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $add-or-clause ((parser query-parser) clauses clause)
Generic Function: $add-word-to-phrase (parser phrase word)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $add-word-to-phrase ((parser query-parser) phrase word)
Generic Function: $get-boolean-clause (parser query occur)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $get-boolean-clause ((parser query-parser) query occur)
Generic Function: $get-boolean-query (parser clauses)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $get-boolean-query ((parser query-parser) clauses)
Generic Function: $get-phrase-query (parser words)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $get-phrase-query ((parser query-parser) words)
Generic Function: $get-term-query (parser word)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $get-term-query ((parser query-parser) word)
Generic Function: $get-wild-query (parser word)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $get-wild-query ((parser query-parser) word)
Generic Function: $set-query-field (parser field)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: $set-query-field ((parser query-parser) field)
Generic Function: <=> (a b)

Ruby three way comparison operator. Returns -1, 0, or 1.

Package

montezuma.

Source

comparable.lisp.

Methods
Method: <=> ((self score-doc) (other score-doc))
Source

score-doc.lisp.

Method: <=> ((a number) (b number))
Generic Function: add (conjunction-scorer scorer)
Package

montezuma.

Source

conjunction-scorer.lisp.

Methods
Method: add ((self conjunction-scorer) scorer)
Generic Function: add-all-doc-vectors (term-vectors-writer vectors)
Package

montezuma.

Source

term-vectors-io.lisp.

Methods
Method: add-all-doc-vectors ((self term-vectors-writer) vectors)
Generic Function: add-clause (boolean-query clause)
Package

montezuma.

Source

boolean-query.lisp.

Methods
Method: add-clause ((self boolean-query) clause)
Generic Function: add-doc-fields (field-infos doc)
Package

montezuma.

Source

field-infos.lisp.

Methods
Method: add-doc-fields ((self field-infos) doc)
Generic Function: add-document-to-writer (document-writer segment document)
Package

montezuma.

Source

document-writer.lisp.

Methods
Method: add-document-to-writer ((self document-writer) segment document)
Generic Function: add-field-info (field-infos name &key indexed-p store-term-vector store-position store-offset omit-norms)
Package

montezuma.

Source

field-infos.lisp.

Methods
Method: add-field-info ((self field-infos) name &key indexed-p store-term-vector store-position store-offset omit-norms)
Generic Function: add-field-internal (field-infos name indexed store-term-vector store-position store-offset omit-norms)
Package

montezuma.

Source

field-infos.lisp.

Methods
Method: add-field-internal ((self field-infos) name indexed store-term-vector store-position store-offset omit-norms)
Generic Function: add-fields (field-infos names &key indexed-p store-term-vector store-position store-offset omit-norms)
Package

montezuma.

Source

field-infos.lisp.

Methods
Method: add-fields ((self field-infos) names &key indexed-p store-term-vector store-position store-offset omit-norms)
Generic Function: add-file (compound-file-writer file-name)
Package

montezuma.

Source

compound-file-io.lisp.

Methods
Method: add-file ((self compound-file-writer) file-name)
Generic Function: add-indexed (segment-merger reader field-infos field-names store-term-vectors store-position-with-term-vector store-offset-with-term-vector)
Package

montezuma.

Source

segment-merger.lisp.

Methods
Method: add-indexed ((self segment-merger) reader field-infos field-names store-term-vectors store-position-with-term-vector store-offset-with-term-vector)
Generic Function: add-indexes (index-writer &rest dirs)
Package

montezuma.

Source

api.lisp.

Methods
Method: add-indexes ((self index) &rest indexes)
Source

index.lisp.

Method: add-indexes ((self index-writer) &rest dirs)
Source

index-writer.lisp.

Generic Function: add-indexes-readers (index-writer readers)
Package

montezuma.

Source

api.lisp.

Methods
Method: add-indexes-readers ((self index-writer) readers)
Source

index-writer.lisp.

Generic Function: add-position (document-writer field text position tv-offset-info)
Package

montezuma.

Source

document-writer.lisp.

Methods
Method: add-position ((self document-writer) field text position tv-offset-info)
Generic Function: add-reader (segment-merger reader)
Package

montezuma.

Source

segment-merger.lisp.

Methods
Method: add-reader ((self segment-merger) reader)
Generic Function: add-scorer (boolean-scorer scorer occur)
Package

montezuma.

Source

boolean-scorer.lisp.

Methods
Method: add-scorer ((self boolean-scorer) scorer occur)
Generic Function: add-segment-info (segment-infos si)
Package

montezuma.

Source

segment-infos.lisp.

Methods
Method: add-segment-info ((self segment-infos) si)
Generic Function: add-term (term-infos-writer term term-info)
Package

montezuma.

Source

term-infos-io.lisp.

Methods
Method: add-term ((self term-infos-writer) term term-info)
Generic Function: add-term-internal (term-vectors-writer term-text freq positions offsets)
Package

montezuma.

Source

term-vectors-io.lisp.

Methods
Method: add-term-internal ((self term-vectors-writer) term-text freq positions offsets)
Generic Function: add-term-to-query (phrase-query term &optional position pos-inc)
Package

montezuma.

Source

phrase-query.lisp.

Methods
Method: add-term-to-query ((self phrase-query) term &optional position pos-inc)
Generic Function: add-term-to-term-vectors-writer (term-vectors-writer term-text freq &key positions offsets)
Package

montezuma.

Source

term-vectors-io.lisp.

Methods
Method: add-term-to-term-vectors-writer ((self term-vectors-writer) term-text freq &key positions offsets)
Generic Function: adjust-top (queue)
Package

montezuma.

Source

priority-queue.lisp.

Methods
Method: adjust-top ((queue priority-queue))
Generic Function: advance-after-current (disjunction-sum-scorer)
Package

montezuma.

Source

disjunction-sum-scorer.lisp.

Methods
Method: advance-after-current ((self disjunction-sum-scorer))
Generic Function: all-fields (document)
Package

montezuma.

Source

document.lisp.

Methods
Method: all-fields ((self document))
Generic Function: append-postings (segment-merger smis n)
Package

montezuma.

Source

segment-merger.lisp.

Methods
Method: append-postings ((self segment-merger) smis n)
Generic Reader: base (object)
Package

montezuma.

Methods
Reader Method: base ((multi-term-doc-enum multi-term-doc-enum))

automatically generated reader method

Source

multi-reader.lisp.

Target Slot

base.

Reader Method: base ((segment-merge-info segment-merge-info))

automatically generated reader method

Source

segment-merge-info.lisp.

Target Slot

base.

Generic Function: binary-value (field)
Package

montezuma.

Source

field.lisp.

Methods
Method: binary-value ((field field))
Generic Function: bits (filter reader)

Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.

Package

montezuma.

Source

filter.lisp.

Generic Reader: boost (object)
Package

montezuma.

Methods
Reader Method: boost ((query query))

automatically generated reader method

Source

query.lisp.

Target Slot

boost.

Reader Method: boost ((document document))

automatically generated reader method

Source

document.lisp.

Target Slot

boost.

Reader Method: boost ((field field))

automatically generated reader method

Source

field.lisp.

Target Slot

boost.

Generic Writer: (setf boost) (object)
Package

montezuma.

Methods
Writer Method: (setf boost) ((query query))

automatically generated writer method

Source

query.lisp.

Target Slot

boost.

Writer Method: (setf boost) ((document document))

automatically generated writer method

Source

document.lisp.

Target Slot

boost.

Writer Method: (setf boost) ((field field))

automatically generated writer method

Source

field.lisp.

Target Slot

boost.

Generic Reader: buffer-size (object)
Package

montezuma.

Methods
Reader Method: buffer-size ((buffered-index-input buffered-index-input))

automatically generated reader method

Source

buffered-index-io.lisp.

Target Slot

buffer-size.

Reader Method: buffer-size ((buffered-index-output buffered-index-output))

automatically generated reader method

Source

buffered-index-io.lisp.

Target Slot

buffer-size.

Generic Function: buffer-skip (segment-merger doc)
Package

montezuma.

Source

segment-merger.lisp.

Methods
Method: buffer-skip ((self segment-merger) doc)
Generic Reader: buffers (object)
Package

montezuma.

Methods
Reader Method: buffers ((ram-file ram-file))

automatically generated reader method

Source

ram-store.lisp.

Target Slot

buffers.

Generic Writer: (setf buffers) (object)
Package

montezuma.

Methods
Writer Method: (setf buffers) ((ram-file ram-file))

automatically generated writer method

Source

ram-store.lisp.

Target Slot

buffers.

Generic Reader: bytes (object)
Package

montezuma.

Methods
Reader Method: bytes ((norm norm))

automatically generated reader method

Source

segment-reader.lisp.

Target Slot

bytes.

Generic Writer: (setf bytes) (object)
Package

montezuma.

Methods
Writer Method: (setf bytes) ((norm norm))

automatically generated writer method

Source

segment-reader.lisp.

Target Slot

bytes.

Generic Function: check-valid-format (term-vectors-reader input-stream)
Package

montezuma.

Source

term-vectors-io.lisp.

Methods
Method: check-valid-format ((self term-vectors-reader) input-stream)
Generic Reader: clauses (object)
Package

montezuma.

Methods
Reader Method: clauses ((boolean-query boolean-query))

automatically generated reader method

Source

boolean-query.lisp.

Target Slot

clauses.

Generic Writer: (setf clauses) (object)
Package

montezuma.

Methods
Writer Method: (setf clauses) ((boolean-query boolean-query))

automatically generated writer method

Source

boolean-query.lisp.

Target Slot

clauses.

Generic Function: clear (segment-infos)
Package

montezuma.

Source

segment-infos.lisp.

Methods
Method: clear ((self segment-infos))
Generic Function: clone-object (object)
Package

montezuma.

Source

mop.lisp.

Methods
Method: clone-object ((array array))
Method: clone-object (object)
Generic Function: close-document (term-vectors-writer)
Package

montezuma.

Source

term-vectors-io.lisp.

Methods
Method: close-document ((self term-vectors-writer))
Generic Function: close-field (term-vectors-writer)
Package

montezuma.

Source

term-vectors-io.lisp.

Methods
Method: close-field ((self term-vectors-writer))
Generic Function: close-norms (reader)
Package

montezuma.

Source

segment-reader.lisp.

Methods
Method: close-norms ((self segment-reader))
Generic Function: close-readers (segment-merger)
Package

montezuma.

Source

segment-merger.lisp.

Methods
Method: close-readers ((self segment-merger))
Generic Function: clrtable (table)
Package

montezuma.

Source

tables.lisp.

Methods
Method: clrtable ((table table))
Method: clrtable ((table hash-table))
Generic Function: code (grammar parser &key save-p)

Emit the code to match the gramar

Package

montezuma.parser.

Source

parser.lisp.

Methods
Method: code ((grammar token-match-grammar) (parser parser) &key save-p)
Method: code ((grammar build-grammar) (parser parser) &key save-p)
Method: code ((grammar not-match-grammar) (parser parser) &key save-p)

Matches only if the sub-grammar fails to match or, if it does match, if index hasn’t moved up to end-match. (I.e. this can only be used inside a conjuctive grammar.

Method: code ((grammar negative-grammar) (parser parser) &key save-p)
Method: code ((grammar plus-grammar) (parser parser) &key save-p)
Method: code ((grammar star-grammar) (parser parser) &key save-p)
Method: code ((grammar optional-grammar) (parser parser) &key save-p)
Method: code ((grammar conjunctive-grammar) (parser parser) &key save-p)
Method: code ((grammar alternative-grammar) (parser parser) &key save-p)
Method: code ((grammar sequence-grammar) (parser parser) &key save-p)
Method: code ((grammar production-call-grammar) (parser parser) &key save-p)
Method: code ((grammar string-grammar) (parser token-parser) &key save-p)
Method: code ((grammar string-grammar) (parser character-parser) &key save-p)
Method: code ((grammar character-grammar) (parser token-parser) &key save-p)
Method: code ((grammar character-grammar) (parser character-parser) &key save-p)
Generic Function: combine (boolean-query queries)
Package

montezuma.

Source

boolean-query.lisp.

Generic Reader: comparator (object)
Package

montezuma.

Methods
Reader Method: comparator ((sort-type sort-type))

automatically generated reader method

Source

sort-field.lisp.

Target Slot

comparator.

Reader Method: comparator ((special-field-comparator special-field-comparator))

automatically generated reader method

Source

score-doc-comparator.lisp.

Target Slot

comparator.

Generic Function: compare (query queries)

Expert: called when re-writing queries under MultiSearcher. Only implemented by derived queries, with no #create_weight() implementatation.

Compares two ScoreDoc objects and returns a result indicating their sort order.

returns:: +-1+ if +i+ should come before +j+
+1+ if +i+ should come after +j+
+0+ if they are equal

Package

montezuma.

Source

api.lisp.

Methods
Method: compare ((a string-field-comparator) (b string-field-comparator))
Source

score-doc-comparator.lisp.

Method: compare ((a special-field-comparator) (b special-field-comparator))
Source

score-doc-comparator.lisp.

Method: compare ((a simple-field-comparator) (b simple-field-comparator))
Source

score-doc-comparator.lisp.

Generic Function: compute-multiple-fields (parser field-spec)
Package

montezuma.

Source

query-parser.lisp.

Methods
Method: compute-multiple-fields ((parser query-parser) field-spec)
Generic Function: coord (similarity overlap max-overlap)
Package

montezuma.

Source

api.lisp.

Methods
Method: coord ((self similarity) overlap max-overlap)
Source

similarity.lisp.

Generic Reader: coord-disabled? (object)
Package

montezuma.

Methods
Reader Method: coord-disabled? ((boolean-query boolean-query))

automatically generated reader method

Source

boolean-query.lisp.

Target Slot

coord-disabled.

Generic Function: coord-factor (coordinator)
Package

montezuma.

Source

boolean-scorer.lisp.

Methods
Method: coord-factor ((self coordinator))
Generic Reader: coord-function (object)
Package

montezuma.

Methods
Reader Method: coord-function ((similarity similarity))

automatically generated reader method

Source

similarity.lisp.

Target Slot

coord-function.

Generic Writer: (setf coord-function) (object)
Package

montezuma.

Methods
Writer Method: (setf coord-function) ((similarity similarity))

automatically generated writer method

Source

similarity.lisp.

Target Slot

coord-function.

Generic Reader: coordinator (object)
Package

montezuma.

Methods
Reader Method: coordinator ((boolean-scorer boolean-scorer))

automatically generated reader method

Source

boolean-scorer.lisp.

Target Slot

coordinator.

Generic Function: copy-file (compound-file-writer source os)
Package

montezuma.

Source

compound-file-io.lisp.

Methods
Method: copy-file ((self compound-file-writer) source os)
Generic Reader: count (object)
Package

montezuma.

Methods
Reader Method: count ((segment-term-doc-enum segment-term-doc-enum))

automatically generated reader method

Source

term-doc-enum.lisp.

Target Slot

count.

Generic Reader: counter (object)
Package

montezuma.

Methods
Reader Method: counter ((segment-infos segment-infos))

automatically generated reader method

Source

segment-infos.lisp.

Target Slot

counter.

Generic Writer: (setf counter) (object)
Package

montezuma.

Methods
Writer Method: (setf counter) ((segment-infos segment-infos))

automatically generated writer method

Source

segment-infos.lisp.

Target Slot

counter.

Generic Function: counting-conjunction-sum-scorer (boolean-scorer required-scorers)
Package

montezuma.

Source

boolean-scorer.lisp.

Methods
Method: counting-conjunction-sum-scorer ((self boolean-scorer) required-scorers)
Generic Function: counting-disjunction-sum-scorer (boolean-scorer scorers)
Package

montezuma.

Source

boolean-scorer.lisp.

Methods
Method: counting-disjunction-sum-scorer ((self boolean-scorer) scorers)
Generic Function: create-compound-file (segment-merger filename)
Package

montezuma.

Source

segment-merger.lisp.

Methods
Method: create-compound-file ((self segment-merger) filename)
Generic Function: create-field (term-vectors-writer field-number store-position store-offset)
Package

montezuma.

Source

term-vectors-io.lisp.

Methods
Method: create-field ((self term-vectors-writer) field-number store-position store-offset)
Generic Function: create-output (directory filename)
Package

montezuma.

Source

api.lisp.

Methods
Method: create-output ((self compound-file-reader) name)
Source

compound-file-io.lisp.

Method: create-output ((self fs-directory) file)
Source

fs-store.lisp.

Method: create-output ((self ram-directory) name)
Source

ram-store.lisp.

Generic Function: create-weight (query searcher)
Package

montezuma.

Source

api.lisp.

Methods
Method: create-weight ((self index-searcher) (query query))
Source

index-searcher.lisp.

Method: create-weight ((self match-all-query) searcher)
Source

match-all-query.lisp.

Method: create-weight ((self phrase-query) searcher)
Source

phrase-query.lisp.

Method: create-weight ((self boolean-query) searcher)
Source

boolean-query.lisp.

Method: create-weight ((self term-query) searcher)
Source

term-query.lisp.

Generic Reader: current (object)
Package

montezuma.

Methods
Reader Method: current ((multi-term-doc-enum multi-term-doc-enum))

automatically generated reader method

Source

multi-reader.lisp.

Target Slot

current.

Generic Reader: data-offset (object)
Package

montezuma.

Methods
Reader Method: data-offset ((compound-file-writer-file-entry compound-file-writer-file-entry))

automatically generated reader method

Source

compound-file-io.lisp.

Target Slot

data-offset.

Generic Writer: (setf data-offset) (object)
Package

montezuma.

Methods
Writer Method: (setf data-offset) ((compound-file-writer-file-entry compound-file-writer-file-entry))

automatically generated writer method

Source

compound-file-io.lisp.

Target Slot

data-offset.

Generic Reader: default-similarity-class (object)
Package

montezuma.

Methods
Reader Method: default-similarity-class ((similarity similarity))

automatically generated reader method

Source

similarity.lisp.

Target Slot

default-similarity-class.

Generic Writer: (setf default-similarity-class) (object)
Package

montezuma.

Methods
Writer Method: (setf default-similarity-class) ((similarity