The lassie Reference Manual

This is the lassie Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:43:07 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 lassie

Library for Latent Semantic Indexing.

Author

Gabor Melis

License

MIT

Version

0.0.1

Dependency

fsvd (system).

Source

lassie.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 lassie/lassie.asd

Source

lassie.asd.

Parent Component

lassie (system).

ASDF Systems

lassie.


3.1.2 lassie/package.lisp

Source

lassie.asd.

Parent Component

lassie (system).

Packages

3.1.3 lassie/indexer.lisp

Dependency

package.lisp (file).

Source

lassie.asd.

Parent Component

lassie (system).

Public Interface
Internals

3.1.4 lassie/normalizer.lisp

Dependency

indexer.lisp (file).

Source

lassie.asd.

Parent Component

lassie (system).

Public Interface
Internals

3.1.5 lassie/mapper.lisp

Dependency

normalizer.lisp (file).

Source

lassie.asd.

Parent Component

lassie (system).

Internals

3.1.6 lassie/assemble.lisp

Dependency

mapper.lisp (file).

Source

lassie.asd.

Parent Component

lassie (system).

Public Interface
Internals

3.1.7 lassie/lsa.lisp

Dependency

assemble.lisp (file).

Source

lassie.asd.

Parent Component

lassie (system).

Public Interface
Internals

3.1.8 lassie/lsa-extra.lisp

Dependency

lsa.lisp (file).

Source

lassie.asd.

Parent Component

lassie (system).

Public Interface
Internals

insert-into-sorted-vector (function).


4 Packages

Packages are listed by definition order.


4.1 lassie

The core functionality of Lassie.

Source

package.lisp.

Use List
Public Interface
Internals

4.2 lassie.assembler

Different assemblers and normalizers that one plug
into Lassie. Assemblers to construct a co-occurence matrix or document vector from a corpus, and normalizers to perform post processing on the assembled data. Normalizers can be printed and read readably.

Source

package.lisp.

Use List

common-lisp.

Used By List

lassie.

Public Interface
Internals

4.3 lassie.indexer

Indexers provide a - sometimes reversible - mapping
from objects and indices. The word ‘index’ is used here in a very general sense, random indexers, for instance, map to a set of indices. Within Lassie they are used in conjunction with assemblers that know how to change the co-occurence matrix when encountering given an index. They can be printed and read readably.

Source

package.lisp.

Use List

common-lisp.

Used By List

lassie.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: construct-document-vector (lsa features)

Construct a document vector from FEATURES. Inverse of DOCUMENT-VECTOR-FEATURES.

Package

lassie.

Source

lsa.lisp.

Function: construct-term-vector (lsa features)

Construct a term vector from FEATURES. Inverse of TERM-VECTOR-FEATURES.

Package

lassie.

Source

lsa.lisp.

Function: cosine-similarity (x y &key n)
Package

lassie.

Source

lsa-extra.lisp.

Function: document->vector (lsa document)

Turn DOCUMENT into a document vector.

Package

lassie.

Source

lsa.lisp.

Function: document-features (lsa document)

Convenience function that returns the features of DOCUMENT after turning into into a vector with LSA.

Package

lassie.

Source

lsa.lisp.

Function: document-vector-features (lsa vector-or-index)

Return the feature vector for the document given by document VECTOR or INDEX.

Package

lassie.

Source

lsa.lisp.

Function: load-lsa (&key filename svd-filename)

Return the lsa loaded from FILENAME and SVD-FILENAME.

Package

lassie.

Source

lsa.lisp.

Function: lsa (&key term-mapper document-mapper term-lister document-lister term-indexer document-indexer assembler normalizer supervisor learning-rate normalization-factor)

Perform LSA and return the lsa object that contains the SVD and remembers the mappers, indexers, ASSEMBLER and NORMALIZER for easy querying later by for example DOCUMENT-FEATURES.

This fat function assembles the co-occurrence matrix by iterating over all terms by TERM-LISTER and all documents by DOCUMENT-LISTER (either may be NIL). If DOCUMENT-LISTER is provided then DOCUMENT-MAPPER is employed to iterate over the terms of each document. Similarly TERM-MAPPER complements TERM-LISTER. TERM-INDEXER and DOCUMENT-INDEXER provide a - sometimes invertible - mapping from terms/documents to indices.

After the initial construction the mappers and indexers are stored in the LSA instance because they are needed to assemble term/document vectors later.

Finally the co-occurrence matrix is decomposed into singular vector pairs that define the feature spaces.

SUPERVISOR is a FSVD supervisor on which FSVD:SUPERVISE-SVD is invoked to control iteration (see FSVD:SVD). The lsa instance being constructed is passed as the :LSA argument to allow inspecting, saving, etc.

Package

lassie.

Source

lsa.lisp.

Function: make-counting-indexer (&key count)
Package

lassie.indexer.

Source

indexer.lisp.

Function: make-hashing-indexer (&key test)
Package

lassie.indexer.

Source

indexer.lisp.

Function: make-random-indexer (&key length n test)
Package

lassie.indexer.

Source

indexer.lisp.

Function: most-similar-documents (lsa document-features &key n test filter measure)

Return a vector of index and similarity pairs of the - at most N - documents whose features are most similar to DOCUMENT-FEATURES according to the similarity MEASURE.

Package

lassie.

Source

lsa-extra.lisp.

Function: save-lsa (lsa &key filename svd-filename)

Save LSA to FILENAME and its svd to SVD-FILENAME.

Package

lassie.

Source

lsa.lisp.

Function: term->vector (lsa term)

Turn TERM into a document vector.

Package

lassie.

Source

lsa.lisp.

Function: term-features (lsa term)

Convenience function that returns the features of TERM after turning into into a vector with LSA.

Package

lassie.

Source

lsa.lisp.

Function: term-vector-features (lsa vector-or-index)

Return the feature vector for the term given by term VECTOR or INDEX.

Package

lassie.

Source

lsa.lisp.


5.1.2 Generic functions

Generic Function: ->index (indexer object &key allocate-new-index-p)

Return an index representing OBJECT.

Package

lassie.indexer.

Source

indexer.lisp.

Methods
Method: ->index ((indexer random-indexer) object &key allocate-new-index-p)
Method: ->index ((indexer hashing-indexer) object &key allocate-new-index-p)
Method: ->index ((indexer counting-indexer) object &key allocate-new-index-p)
Generic Function: <-index (indexer index)

Return the object that is encoded to INDEX.

Package

lassie.indexer.

Source

indexer.lisp.

Methods
Method: <-index ((indexer hashing-indexer) index)
Method: <-index ((indexer counting-indexer) object)
Generic Function: assemble-co-occurrence-matrix (assembler lister)

Assemble MATRIX and remember how to perform the
same kind of activity on subsequent calls to ASSEMBLE-TERM-VECTOR and ASSEMBLE-DOCUMENT-VECTOR.

Package

lassie.assembler.

Source

assemble.lisp.

Methods
Method: assemble-co-occurrence-matrix ((assembler ri-term-assembler) lister)
Method: assemble-co-occurrence-matrix ((assembler lsa-assembler) lister)
Generic Function: assemble-document-vector (assembler lister)

Iterate over terms of LISTER and assemble a
document vector in the same way as the matrix was assembled previously.

Package

lassie.assembler.

Source

assemble.lisp.

Methods
Method: assemble-document-vector ((assembler ri-term-assembler) lister)
Method: assemble-document-vector ((assembler lsa-assembler) lister)
Generic Function: assemble-term-vector (assembler lister)

Iterate over documents of LISTER and assemble a
term vector in the same way as the matrix was assembled previously.

Package

lassie.assembler.

Source

assemble.lisp.

Methods
Method: assemble-term-vector ((assembler lsa-assembler) lister)
Generic Reader: document-indexer (object)
Package

lassie.

Methods
Reader Method: document-indexer ((lsa lsa))

Document indexer.

Source

lsa.lisp.

Target Slot

document-indexer.

Generic Reader: document-mapper (object)
Package

lassie.

Methods
Reader Method: document-mapper ((lsa lsa))

A mapper over all terms that occur in a given document.

Source

lsa.lisp.

Target Slot

document-mapper.

Generic Function: normalize-document-vector (normalizer document-vector document)

Returned the normalized DOCUMENT-VECTOR. Possibly desctructive.

Package

lassie.assembler.

Source

normalizer.lisp.

Methods
Method: normalize-document-vector ((normalizer column-power-normalizer) document-vector document)
Method: normalize-document-vector ((normalizer row-centering-normalizer) document-vector document)
Method: normalize-document-vector ((normalizer null-normalizer) document-vector document)
Method: normalize-document-vector ((normalizer sign-normalizer) document-vector document)
Method: normalize-document-vector ((normalizer pmi-normalizer) document-vector document)
Method: normalize-document-vector ((normalizer tf-idf-normalizer) document-vector document)
Generic Function: normalize-matrix (normalizer matrix)

Return the normalized MATRIX possibly destructively
and remember how to perform the same kind normalizations on subsequent calls to NORMALIZE-TERM and NORMALIZE-DOCUMENT.

Package

lassie.assembler.

Source

normalizer.lisp.

Methods
Method: normalize-matrix ((normalizer column-power-normalizer) matrix)
Method: normalize-matrix ((normalizer row-centering-normalizer) matrix)
Method: normalize-matrix ((normalizer null-normalizer) matrix)
Method: normalize-matrix ((normalizer sign-normalizer) matrix)
Method: normalize-matrix ((normalizer pmi-normalizer) matrix)
Method: normalize-matrix ((normalizer tf-idf-normalizer) matrix)
Generic Function: normalize-term-vector (normalizer term-vector term)

Return the normalized TERM-VECTOR. Possibly desctructive.

Package

lassie.assembler.

Source

normalizer.lisp.

Generic Reader: normalizer (object)
Package

lassie.

Methods
Reader Method: normalizer ((lsa lsa))

Performs some last minute transformations on the assembled matrix.

Source

lsa.lisp.

Target Slot

normalizer.

Generic Reader: svd (object)
Package

lassie.

Methods
Reader Method: svd ((lsa lsa))

The singular value decomposition.

Source

lsa.lisp.

Target Slot

svd.

Generic Reader: term-indexer (object)
Package

lassie.

Methods
Reader Method: term-indexer ((lsa lsa))

Term indexer.

Source

lsa.lisp.

Target Slot

term-indexer.

Generic Reader: term-mapper (object)
Package

lassie.

Methods
Reader Method: term-mapper ((lsa lsa))

A mapper over all documents in which a given term occurs.

Source

lsa.lisp.

Target Slot

term-mapper.


5.1.3 Standalone methods

Method: print-object :around ((normalizer tf-idf-normalizer) stream)
Source

normalizer.lisp.

Method: print-object :around ((assembler lsa-assembler) stream)
Source

assemble.lisp.

Method: print-object :around ((normalizer column-power-normalizer) stream)
Source

normalizer.lisp.

Method: print-object :around ((normalizer null-normalizer) stream)
Source

normalizer.lisp.

Method: print-object :around ((assembler ri-term-assembler) stream)
Source

assemble.lisp.

Method: print-object :around ((indexer hashing-indexer) stream)
Source

indexer.lisp.


5.1.4 Classes

Class: column-power-normalizer
Package

lassie.assembler.

Source

normalizer.lisp.

Direct methods
Direct slots
Slot: power
Initform

2

Initargs

:power

Readers

power.

Writers

This slot is read-only.

Class: lsa

This is not much more than a convenience class that
remembers how the SVD was produced to be able to extract features later, or just to know what a given row or column corresponds to.

Package

lassie.

Source

lsa.lisp.

Direct methods
Direct slots
Slot: term-mapper

A mapper over all documents in which a given term occurs.

Initargs

:term-mapper

Readers

term-mapper.

Writers

This slot is read-only.

Slot: document-mapper

A mapper over all terms that occur in a given document.

Initargs

:document-mapper

Readers

document-mapper.

Writers

This slot is read-only.

Slot: term-indexer

Term indexer.

Initargs

:term-indexer

Readers

term-indexer.

Writers

This slot is read-only.

Slot: document-indexer

Document indexer.

Initargs

:document-indexer

Readers

document-indexer.

Writers

This slot is read-only.

Slot: assembler

Turns co-occurrences into a matrix, term and document vectors.

Initargs

:assembler

Readers

assembler.

Writers

This slot is read-only.

Slot: normalizer

Performs some last minute transformations on the assembled matrix.

Initargs

:normalizer

Readers

normalizer.

Writers

This slot is read-only.

Slot: svd

The singular value decomposition.

Initargs

:svd

Readers

svd.

Writers

This slot is read-only.

Class: lsa-assembler

The standard assembler that adds ...

Package

lassie.assembler.

Source

assemble.lisp.

Direct subclasses

ri-term-assembler.

Direct methods
Direct slots
Slot: n-terms
Initargs

:n-terms

Readers

n-terms.

Writers

This slot is read-only.

Slot: n-documents
Initargs

:n-documents

Readers

n-documents.

Writers

This slot is read-only.

Class: null-normalizer
Package

lassie.assembler.

Source

normalizer.lisp.

Direct methods
Class: pmi-normalizer
Package

lassie.assembler.

Source

normalizer.lisp.

Direct methods
Direct slots
Slot: document-class-fn
Initform

(error "document-class-fn is required.")

Initargs

:document-class-fn

Readers

document-class-fn.

Writers

This slot is read-only.

Slot: term-total
Initargs

:term-total

Readers

term-total.

Writers

This slot is read-only.

Slot: term-counts
Initargs

:term-counts

Readers

term-counts.

Writers

This slot is read-only.

Slot: class-counts
Initargs

:class-counts

Readers

class-counts.

Writers

This slot is read-only.

Slot: term-counts-per-class
Initargs

:term-counts-per-class

Readers

term-counts-per-class.

Writers

This slot is read-only.

Slot: term-total-per-class
Initargs

:term-total-per-class

Readers

term-total-per-class.

Writers

This slot is read-only.

Slot: n-documents
Initargs

:n-documents

Readers

n-documents.

Writers

This slot is read-only.

Class: ri-term-assembler

Terms are random indexed, documents are not.

Package

lassie.assembler.

Source

assemble.lisp.

Direct superclasses

lsa-assembler.

Direct methods
Class: row-centering-normalizer
Package

lassie.assembler.

Source

normalizer.lisp.

Direct methods
Direct slots
Slot: row-averages
Readers

row-averages.

Writers

This slot is read-only.

Class: sign-normalizer
Package

lassie.assembler.

Source

normalizer.lisp.

Direct methods
Class: tf-idf-normalizer
Package

lassie.assembler.

Source

normalizer.lisp.

Direct methods
Direct slots
Slot: idfs

The inverse document frequencies in the originally assembled matrix.

Initargs

:idfs

Readers

idfs.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Ordinary functions

Function: %make-hashing-indexer (&key next-index index->object object->index)
Package

lassie.indexer.

Source

indexer.lisp.

Function: %make-random-indexer (&key length n object->index)
Package

lassie.indexer.

Source

indexer.lisp.

Function: alist->hashing-indexer (test alist)
Package

lassie.indexer.

Source

indexer.lisp.

Function: assemble-occurence-vector (lister size)

Return a vector of SIZE whose elements represent the frequency with which their indices were listed by LISTER.

Package

lassie.assembler.

Source

assemble.lisp.

Function: column-norm (matrix column &key power)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: compose-mappers (&rest mappers)

Return a mapper that maps from the same set as the first of MAPPERS maps from and maps to what the last of MAPPERS maps to, composing them in a chain. If MAPPERS is NIL #’FUNCALL, the identity mapper, is returned.

Package

lassie.

Source

mapper.lisp.

Function: concatente-mappers (&rest mappers)

Return a mapper that is the concatention of MAPPERS.

Package

lassie.

Source

mapper.lisp.

Function: construct-lsa-vector (lsa features sv-side)
Package

lassie.

Source

lsa.lisp.

Function: coordinate (basis vector)

Return the length of the projection of VECTOR to BASIS.

Package

lassie.

Source

lsa.lisp.

Function: copy-counting-indexer (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Function: copy-hashing-indexer (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Function: copy-random-indexer (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Reader: counting-indexer-count (instance)
Writer: (setf counting-indexer-count) (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Target Slot

count.

Function: counting-indexer-p (object)
Package

lassie.indexer.

Source

indexer.lisp.

Function: curry-mapper (mapper &rest curried-args)

What makes a mapper is that the first is a function that is somehow applied to arguments. Currying a mapper leaves the function parameter alone and curries the rest of the parameters.

Package

lassie.

Source

mapper.lisp.

Function: encode-mapper (mapper encoder &key allocate-new-index-p)

Translate MAPPER by encoding its sole argument with ENCODER.

Package

lassie.

Source

mapper.lisp.

Function: extract-lsa-features (lsa vector-or-index sv-own sv-other)
Package

lassie.

Source

lsa.lisp.

Function: extract-svd-features (svd vector fn)
Package

lassie.

Source

lsa.lisp.

Function: hash-table= (alist hash-table)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: hashing-indexer->alist (indexer)
Package

lassie.indexer.

Source

indexer.lisp.

Reader: hashing-indexer-index->object (instance)
Writer: (setf hashing-indexer-index->object) (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Target Slot

index->object.

Reader: hashing-indexer-next-index (instance)
Writer: (setf hashing-indexer-next-index) (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Target Slot

next-index.

Reader: hashing-indexer-object->index (instance)
Writer: (setf hashing-indexer-object->index) (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Target Slot

object->index.

Function: hashing-indexer-p (object)
Package

lassie.indexer.

Source

indexer.lisp.

Function: incf-and-maybe-grow (matrix delta &rest indices)
Package

lassie.assembler.

Source

assemble.lisp.

Function: inner* (vector1 vector2)
Package

lassie.

Source

lsa.lisp.

Function: insert-into-sorted-vector (item vec &key max-length key test)

Insert ITEM into VECTOR while keeping it sorted by TEST. Extend the vector if needed while respecting MAX-LENGTH

Package

lassie.

Source

lsa-extra.lisp.

Function: inverse-document-frequency (matrix term)

Relative importance of TERM across MATRIX.

Package

lassie.assembler.

Source

normalizer.lisp.

Function: make-column-power-normalizer (&key power)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: make-encoded-term-document-lister (term-mapper document-mapper term-encoder document-encoder term-lister document-lister)

Return a lister that maps to encoded terms and documents. If DOCUMENT-LISTER is not NIL get its documents, encode them and list their terms with DOCUMENT-MAPPER. Act similary with TERM-LISTER and TERM-MAPPER.

Package

lassie.

Source

mapper.lisp.

Function: make-encoded-term-document-mapper (document-mapper term-encoder document-encoder)

Return a mapper that applies to a document and calls its function argument with two parameters: the encoded term and the encoded document.

Package

lassie.

Source

mapper.lisp.

Function: make-index-vector (n length)

Create a random index vector of LENGTH with N 1s and N -1s. It is stored as a sparse vector (only the indices of non-zero elements where the first N are +1 the rest are -1).

Package

lassie.indexer.

Source

indexer.lisp.

Function: make-lsa-assembler (&key n-terms n-documents)
Package

lassie.assembler.

Source

assemble.lisp.

Function: make-mapper (&rest sequences)

Return a mapper that maps from SEQUENCES to elements of SEQUENCES.

Package

lassie.

Source

mapper.lisp.

Function: make-null-normalizer ()
Package

lassie.assembler.

Source

normalizer.lisp.

Function: make-ri-term-assembler ()
Package

lassie.assembler.

Source

assemble.lisp.

Function: make-tf-idf-normalizer (&key idfs)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: n-columns (matrix)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: n-documents-with-term (matrix term)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: n-rows (matrix)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: norm (vector &key power)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: normalize-column (matrix column &key power)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: normalize-vector (vector &key power)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: null-mapper (&rest args)
Package

lassie.

Source

mapper.lisp.

Reader: random-indexer-length (instance)
Writer: (setf random-indexer-length) (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Target Slot

length.

Reader: random-indexer-n (instance)
Writer: (setf random-indexer-n) (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Target Slot

n.

Reader: random-indexer-object->index (instance)
Writer: (setf random-indexer-object->index) (instance)
Package

lassie.indexer.

Source

indexer.lisp.

Target Slot

object->index.

Function: random-indexer-p (object)
Package

lassie.indexer.

Source

indexer.lisp.

Function: row-average (matrix row)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: sum-column (matrix column)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: sum-matrix (matrix)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: sum-row (matrix row)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: sum-vector (vector)
Package

lassie.assembler.

Source

normalizer.lisp.

Function: term-frequency (matrix term document)

A normalized measure of how often TERM appears in DOCUMENT.

Package

lassie.assembler.

Source

normalizer.lisp.

Function: test-compose-mappers ()
Package

lassie.

Source

mapper.lisp.

Function: test-hashing-indexer ()
Package

lassie.indexer.

Source

indexer.lisp.

Function: test-pmi-normalizer ()
Package

lassie.assembler.

Source

normalizer.lisp.

Function: test-tf-idf-normalizer ()
Package

lassie.assembler.

Source

normalizer.lisp.


5.2.2 Generic functions

Generic Reader: assembler (object)
Package

lassie.

Methods
Reader Method: assembler ((lsa lsa))

Turns co-occurrences into a matrix, term and document vectors.

Source

lsa.lisp.

Target Slot

assembler.

Generic Reader: class-counts (object)
Package

lassie.assembler.

Methods
Reader Method: class-counts ((pmi-normalizer pmi-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

class-counts.

Generic Reader: document-class-fn (object)
Package

lassie.assembler.

Methods
Reader Method: document-class-fn ((pmi-normalizer pmi-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

document-class-fn.

Generic Reader: idfs (object)
Package

lassie.assembler.

Methods
Reader Method: idfs ((tf-idf-normalizer tf-idf-normalizer))

The inverse document frequencies in the originally assembled matrix.

Source

normalizer.lisp.

Target Slot

idfs.

Generic Function: map-lines (function object)
Package

lassie.

Source

mapper.lisp.

Methods
Method: map-lines (function (stream stream))
Method: map-lines (function (pathname pathname))
Method: map-lines (function (string string))
Generic Reader: n-documents (object)
Package

lassie.assembler.

Methods
Reader Method: n-documents ((lsa-assembler lsa-assembler))

automatically generated reader method

Source

assemble.lisp.

Target Slot

n-documents.

Reader Method: n-documents ((pmi-normalizer pmi-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

n-documents.

Generic Reader: n-terms (object)
Package

lassie.assembler.

Methods
Reader Method: n-terms ((lsa-assembler lsa-assembler))

automatically generated reader method

Source

assemble.lisp.

Target Slot

n-terms.

Generic Reader: power (object)
Package

lassie.assembler.

Methods
Reader Method: power ((column-power-normalizer column-power-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

power.

Generic Reader: row-averages (object)
Package

lassie.assembler.

Methods
Reader Method: row-averages ((row-centering-normalizer row-centering-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

row-averages.

Generic Reader: term-counts (object)
Package

lassie.assembler.

Methods
Reader Method: term-counts ((pmi-normalizer pmi-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

term-counts.

Generic Reader: term-counts-per-class (object)
Package

lassie.assembler.

Methods
Reader Method: term-counts-per-class ((pmi-normalizer pmi-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

term-counts-per-class.

Generic Reader: term-total (object)
Package

lassie.assembler.

Methods
Reader Method: term-total ((pmi-normalizer pmi-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

term-total.

Generic Reader: term-total-per-class (object)
Package

lassie.assembler.

Methods
Reader Method: term-total-per-class ((pmi-normalizer pmi-normalizer))

automatically generated reader method

Source

normalizer.lisp.

Target Slot

term-total-per-class.


5.2.3 Structures

Structure: counting-indexer

Simply assigns a new index to every object.

Package

lassie.indexer.

Source

indexer.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: count
Package

common-lisp.

Initform

0

Readers

counting-indexer-count.

Writers

(setf counting-indexer-count).

Structure: hashing-indexer
Package

lassie.indexer.

Source

indexer.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: next-index
Initform

0

Readers

hashing-indexer-next-index.

Writers

(setf hashing-indexer-next-index).

Slot: index->object
Readers

hashing-indexer-index->object.

Writers

(setf hashing-indexer-index->object).

Slot: object->index
Readers

hashing-indexer-object->index.

Writers

(setf hashing-indexer-object->index).

Structure: random-indexer
Package

lassie.indexer.

Source

indexer.lisp.

Direct superclasses

structure-object.

Direct methods

->index.

Direct slots
Slot: length
Package

common-lisp.

Readers

random-indexer-length.

Writers

(setf random-indexer-length).

Slot: n
Readers

random-indexer-n.

Writers

(setf random-indexer-n).

Slot: object->index
Readers

random-indexer-object->index.

Writers

(setf random-indexer-object->index).


5.2.4 Types

Type: single-float-vector ()
Package

lassie.

Source

lsa.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (   -   <  
A   C   D   E   F   G   H   I   L   M   N   P   R   S   T  
Index Entry  Section

%
%make-hashing-indexer: Private ordinary functions
%make-random-indexer: Private ordinary functions

(
(setf counting-indexer-count): Private ordinary functions
(setf hashing-indexer-index->object): Private ordinary functions
(setf hashing-indexer-next-index): Private ordinary functions
(setf hashing-indexer-object->index): Private ordinary functions
(setf random-indexer-length): Private ordinary functions
(setf random-indexer-n): Private ordinary functions
(setf random-indexer-object->index): Private ordinary functions

-
->index: Public generic functions
->index: Public generic functions
->index: Public generic functions
->index: Public generic functions

<
<-index: Public generic functions
<-index: Public generic functions
<-index: Public generic functions

A
alist->hashing-indexer: Private ordinary functions
assemble-co-occurrence-matrix: Public generic functions
assemble-co-occurrence-matrix: Public generic functions
assemble-co-occurrence-matrix: Public generic functions
assemble-document-vector: Public generic functions
assemble-document-vector: Public generic functions
assemble-document-vector: Public generic functions
assemble-occurence-vector: Private ordinary functions
assemble-term-vector: Public generic functions
assemble-term-vector: Public generic functions
assembler: Private generic functions
assembler: Private generic functions

C
class-counts: Private generic functions
class-counts: Private generic functions
column-norm: Private ordinary functions
compose-mappers: Private ordinary functions
concatente-mappers: Private ordinary functions
construct-document-vector: Public ordinary functions
construct-lsa-vector: Private ordinary functions
construct-term-vector: Public ordinary functions
coordinate: Private ordinary functions
copy-counting-indexer: Private ordinary functions
copy-hashing-indexer: Private ordinary functions
copy-random-indexer: Private ordinary functions
cosine-similarity: Public ordinary functions
counting-indexer-count: Private ordinary functions
counting-indexer-p: Private ordinary functions
curry-mapper: Private ordinary functions

D
document->vector: Public ordinary functions
document-class-fn: Private generic functions
document-class-fn: Private generic functions
document-features: Public ordinary functions
document-indexer: Public generic functions
document-indexer: Public generic functions
document-mapper: Public generic functions
document-mapper: Public generic functions
document-vector-features: Public ordinary functions

E
encode-mapper: Private ordinary functions
extract-lsa-features: Private ordinary functions
extract-svd-features: Private ordinary functions

F
Function, %make-hashing-indexer: Private ordinary functions
Function, %make-random-indexer: Private ordinary functions
Function, (setf counting-indexer-count): Private ordinary functions
Function, (setf hashing-indexer-index->object): Private ordinary functions
Function, (setf hashing-indexer-next-index): Private ordinary functions
Function, (setf hashing-indexer-object->index): Private ordinary functions
Function, (setf random-indexer-length): Private ordinary functions
Function, (setf random-indexer-n): Private ordinary functions
Function, (setf random-indexer-object->index): Private ordinary functions
Function, alist->hashing-indexer: Private ordinary functions
Function, assemble-occurence-vector: Private ordinary functions
Function, column-norm: Private ordinary functions
Function, compose-mappers: Private ordinary functions
Function, concatente-mappers: Private ordinary functions
Function, construct-document-vector: Public ordinary functions
Function, construct-lsa-vector: Private ordinary functions
Function, construct-term-vector: Public ordinary functions
Function, coordinate: Private ordinary functions
Function, copy-counting-indexer: Private ordinary functions
Function, copy-hashing-indexer: Private ordinary functions
Function, copy-random-indexer: Private ordinary functions
Function, cosine-similarity: Public ordinary functions
Function, counting-indexer-count: Private ordinary functions
Function, counting-indexer-p: Private ordinary functions
Function, curry-mapper: Private ordinary functions
Function, document->vector: Public ordinary functions
Function, document-features: Public ordinary functions
Function, document-vector-features: Public ordinary functions
Function, encode-mapper: Private ordinary functions
Function, extract-lsa-features: Private ordinary functions
Function, extract-svd-features: Private ordinary functions
Function, hash-table=: Private ordinary functions
Function, hashing-indexer->alist: Private ordinary functions
Function, hashing-indexer-index->object: Private ordinary functions
Function, hashing-indexer-next-index: Private ordinary functions
Function, hashing-indexer-object->index: Private ordinary functions
Function, hashing-indexer-p: Private ordinary functions
Function, incf-and-maybe-grow: Private ordinary functions
Function, inner*: Private ordinary functions
Function, insert-into-sorted-vector: Private ordinary functions
Function, inverse-document-frequency: Private ordinary functions
Function, load-lsa: Public ordinary functions
Function, lsa: Public ordinary functions
Function, make-column-power-normalizer: Private ordinary functions
Function, make-counting-indexer: Public ordinary functions
Function, make-encoded-term-document-lister: Private ordinary functions
Function, make-encoded-term-document-mapper: Private ordinary functions
Function, make-hashing-indexer: Public ordinary functions
Function, make-index-vector: Private ordinary functions
Function, make-lsa-assembler: Private ordinary functions
Function, make-mapper: Private ordinary functions
Function, make-null-normalizer: Private ordinary functions
Function, make-random-indexer: Public ordinary functions
Function, make-ri-term-assembler: Private ordinary functions
Function, make-tf-idf-normalizer: Private ordinary functions
Function, most-similar-documents: Public ordinary functions
Function, n-columns: Private ordinary functions
Function, n-documents-with-term: Private ordinary functions
Function, n-rows: Private ordinary functions
Function, norm: Private ordinary functions
Function, normalize-column: Private ordinary functions
Function, normalize-vector: Private ordinary functions
Function, null-mapper: Private ordinary functions
Function, random-indexer-length: Private ordinary functions
Function, random-indexer-n: Private ordinary functions
Function, random-indexer-object->index: Private ordinary functions
Function, random-indexer-p: Private ordinary functions
Function, row-average: Private ordinary functions
Function, save-lsa: Public ordinary functions
Function, sum-column: Private ordinary functions
Function, sum-matrix: Private ordinary functions
Function, sum-row: Private ordinary functions
Function, sum-vector: Private ordinary functions
Function, term->vector: Public ordinary functions
Function, term-features: Public ordinary functions
Function, term-frequency: Private ordinary functions
Function, term-vector-features: Public ordinary functions
Function, test-compose-mappers: Private ordinary functions
Function, test-hashing-indexer: Private ordinary functions
Function, test-pmi-normalizer: Private ordinary functions
Function, test-tf-idf-normalizer: Private ordinary functions

G
Generic Function, ->index: Public generic functions
Generic Function, <-index: Public generic functions
Generic Function, assemble-co-occurrence-matrix: Public generic functions
Generic Function, assemble-document-vector: Public generic functions
Generic Function, assemble-term-vector: Public generic functions
Generic Function, assembler: Private generic functions
Generic Function, class-counts: Private generic functions
Generic Function, document-class-fn: Private generic functions
Generic Function, document-indexer: Public generic functions
Generic Function, document-mapper: Public generic functions
Generic Function, idfs: Private generic functions
Generic Function, map-lines: Private generic functions
Generic Function, n-documents: Private generic functions
Generic Function, n-terms: Private generic functions
Generic Function, normalize-document-vector: Public generic functions
Generic Function, normalize-matrix: Public generic functions
Generic Function, normalize-term-vector: Public generic functions
Generic Function, normalizer: Public generic functions
Generic Function, power: Private generic functions
Generic Function, row-averages: Private generic functions
Generic Function, svd: Public generic functions
Generic Function, term-counts: Private generic functions
Generic Function, term-counts-per-class: Private generic functions
Generic Function, term-indexer: Public generic functions
Generic Function, term-mapper: Public generic functions
Generic Function, term-total: Private generic functions
Generic Function, term-total-per-class: Private generic functions

H
hash-table=: Private ordinary functions
hashing-indexer->alist: Private ordinary functions
hashing-indexer-index->object: Private ordinary functions
hashing-indexer-next-index: Private ordinary functions
hashing-indexer-object->index: Private ordinary functions
hashing-indexer-p: Private ordinary functions

I
idfs: Private generic functions
idfs: Private generic functions
incf-and-maybe-grow: Private ordinary functions
inner*: Private ordinary functions
insert-into-sorted-vector: Private ordinary functions
inverse-document-frequency: Private ordinary functions

L
load-lsa: Public ordinary functions
lsa: Public ordinary functions

M
make-column-power-normalizer: Private ordinary functions
make-counting-indexer: Public ordinary functions
make-encoded-term-document-lister: Private ordinary functions
make-encoded-term-document-mapper: Private ordinary functions
make-hashing-indexer: Public ordinary functions
make-index-vector: Private ordinary functions
make-lsa-assembler: Private ordinary functions
make-mapper: Private ordinary functions
make-null-normalizer: Private ordinary functions
make-random-indexer: Public ordinary functions
make-ri-term-assembler: Private ordinary functions
make-tf-idf-normalizer: Private ordinary functions
map-lines: Private generic functions
map-lines: Private generic functions
map-lines: Private generic functions
map-lines: Private generic functions
Method, ->index: Public generic functions
Method, ->index: Public generic functions
Method, ->index: Public generic functions
Method, <-index: Public generic functions
Method, <-index: Public generic functions
Method, assemble-co-occurrence-matrix: Public generic functions
Method, assemble-co-occurrence-matrix: Public generic functions
Method, assemble-document-vector: Public generic functions
Method, assemble-document-vector: Public generic functions
Method, assemble-term-vector: Public generic functions
Method, assembler: Private generic functions
Method, class-counts: Private generic functions
Method, document-class-fn: Private generic functions
Method, document-indexer: Public generic functions
Method, document-mapper: Public generic functions
Method, idfs: Private generic functions
Method, map-lines: Private generic functions
Method, map-lines: Private generic functions
Method, map-lines: Private generic functions
Method, n-documents: Private generic functions
Method, n-documents: Private generic functions
Method, n-terms: Private generic functions
Method, normalize-document-vector: Public generic functions
Method, normalize-document-vector: Public generic functions
Method, normalize-document-vector: Public generic functions
Method, normalize-document-vector: Public generic functions
Method, normalize-document-vector: Public generic functions
Method, normalize-document-vector: Public generic functions
Method, normalize-matrix: Public generic functions
Method, normalize-matrix: Public generic functions
Method, normalize-matrix: Public generic functions
Method, normalize-matrix: Public generic functions
Method, normalize-matrix: Public generic functions
Method, normalize-matrix: Public generic functions
Method, normalizer: Public generic functions
Method, power: Private generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, row-averages: Private generic functions
Method, svd: Public generic functions
Method, term-counts: Private generic functions
Method, term-counts-per-class: Private generic functions
Method, term-indexer: Public generic functions
Method, term-mapper: Public generic functions
Method, term-total: Private generic functions
Method, term-total-per-class: Private generic functions
most-similar-documents: Public ordinary functions

N
n-columns: Private ordinary functions
n-documents: Private generic functions
n-documents: Private generic functions
n-documents: Private generic functions
n-documents-with-term: Private ordinary functions
n-rows: Private ordinary functions
n-terms: Private generic functions
n-terms: Private generic functions
norm: Private ordinary functions
normalize-column: Private ordinary functions
normalize-document-vector: Public generic functions
normalize-document-vector: Public generic functions
normalize-document-vector: Public generic functions
normalize-document-vector: Public generic functions
normalize-document-vector: Public generic functions
normalize-document-vector: Public generic functions
normalize-document-vector: Public generic functions
normalize-matrix: Public generic functions
normalize-matrix: Public generic functions
normalize-matrix: Public generic functions
normalize-matrix: Public generic functions
normalize-matrix: Public generic functions
normalize-matrix: Public generic functions
normalize-matrix: Public generic functions
normalize-term-vector: Public generic functions
normalize-vector: Private ordinary functions
normalizer: Public generic functions
normalizer: Public generic functions
null-mapper: Private ordinary functions

P
power: Private generic functions
power: Private generic functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods

R
random-indexer-length: Private ordinary functions
random-indexer-n: Private ordinary functions
random-indexer-object->index: Private ordinary functions
random-indexer-p: Private ordinary functions
row-average: Private ordinary functions
row-averages: Private generic functions
row-averages: Private generic functions

S
save-lsa: Public ordinary functions
sum-column: Private ordinary functions
sum-matrix: Private ordinary functions
sum-row: Private ordinary functions
sum-vector: Private ordinary functions
svd: Public generic functions
svd: Public generic functions

T
term->vector: Public ordinary functions
term-counts: Private generic functions
term-counts: Private generic functions
term-counts-per-class: Private generic functions
term-counts-per-class: Private generic functions
term-features: Public ordinary functions
term-frequency: Private ordinary functions
term-indexer: Public generic functions
term-indexer: Public generic functions
term-mapper: Public generic functions
term-mapper: Public generic functions
term-total: Private generic functions
term-total: Private generic functions
term-total-per-class: Private generic functions
term-total-per-class: Private generic functions
term-vector-features: Public ordinary functions
test-compose-mappers: Private ordinary functions
test-hashing-indexer: Private ordinary functions
test-pmi-normalizer: Private ordinary functions
test-tf-idf-normalizer: Private ordinary functions


A.3 Variables

Jump to:   A   C   D   I   L   N   O   P   R   S   T  
Index Entry  Section

A
assembler: Public classes

C
class-counts: Public classes
count: Private structures

D
document-class-fn: Public classes
document-indexer: Public classes
document-mapper: Public classes

I
idfs: Public classes
index->object: Private structures

L
length: Private structures

N
n: Private structures
n-documents: Public classes
n-documents: Public classes
n-terms: Public classes
next-index: Private structures
normalizer: Public classes

O
object->index: Private structures
object->index: Private structures

P
power: Public classes

R
row-averages: Public classes

S
Slot, assembler: Public classes
Slot, class-counts: Public classes
Slot, count: Private structures
Slot, document-class-fn: Public classes
Slot, document-indexer: Public classes
Slot, document-mapper: Public classes
Slot, idfs: Public classes
Slot, index->object: Private structures
Slot, length: Private structures
Slot, n: Private structures
Slot, n-documents: Public classes
Slot, n-documents: Public classes
Slot, n-terms: Public classes
Slot, next-index: Private structures
Slot, normalizer: Public classes
Slot, object->index: Private structures
Slot, object->index: Private structures
Slot, power: Public classes
Slot, row-averages: Public classes
Slot, svd: Public classes
Slot, term-counts: Public classes
Slot, term-counts-per-class: Public classes
Slot, term-indexer: Public classes
Slot, term-mapper: Public classes
Slot, term-total: Public classes
Slot, term-total-per-class: Public classes
svd: Public classes

T
term-counts: Public classes
term-counts-per-class: Public classes
term-indexer: Public classes
term-mapper: Public classes
term-total: Public classes
term-total-per-class: Public classes


A.4 Data types

Jump to:   A   C   F   H   I   L   M   N   P   R   S   T  
Index Entry  Section

A
assemble.lisp: The lassie/assemble․lisp file

C
Class, column-power-normalizer: Public classes
Class, lsa: Public classes
Class, lsa-assembler: Public classes
Class, null-normalizer: Public classes
Class, pmi-normalizer: Public classes
Class, ri-term-assembler: Public classes
Class, row-centering-normalizer: Public classes
Class, sign-normalizer: Public classes
Class, tf-idf-normalizer: Public classes
column-power-normalizer: Public classes
counting-indexer: Private structures

F
File, assemble.lisp: The lassie/assemble․lisp file
File, indexer.lisp: The lassie/indexer․lisp file
File, lassie.asd: The lassie/lassie․asd file
File, lsa-extra.lisp: The lassie/lsa-extra․lisp file
File, lsa.lisp: The lassie/lsa․lisp file
File, mapper.lisp: The lassie/mapper․lisp file
File, normalizer.lisp: The lassie/normalizer․lisp file
File, package.lisp: The lassie/package․lisp file

H
hashing-indexer: Private structures

I
indexer.lisp: The lassie/indexer․lisp file

L
lassie: The lassie system
lassie: The lassie package
lassie.asd: The lassie/lassie․asd file
lassie.assembler: The lassie․assembler package
lassie.indexer: The lassie․indexer package
lsa: Public classes
lsa-assembler: Public classes
lsa-extra.lisp: The lassie/lsa-extra․lisp file
lsa.lisp: The lassie/lsa․lisp file

M
mapper.lisp: The lassie/mapper․lisp file

N
normalizer.lisp: The lassie/normalizer․lisp file
null-normalizer: Public classes

P
Package, lassie: The lassie package
Package, lassie.assembler: The lassie․assembler package
Package, lassie.indexer: The lassie․indexer package
package.lisp: The lassie/package․lisp file
pmi-normalizer: Public classes

R
random-indexer: Private structures
ri-term-assembler: Public classes
row-centering-normalizer: Public classes

S
sign-normalizer: Public classes
single-float-vector: Private types
Structure, counting-indexer: Private structures
Structure, hashing-indexer: Private structures
Structure, random-indexer: Private structures
System, lassie: The lassie system

T
tf-idf-normalizer: Public classes
Type, single-float-vector: Private types