The lassie Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The lassie Reference Manual

This is the lassie Reference Manual, version 0.0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:04:36 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Lassie is a Common Lisp library for Latent Semantic Indexing by
Ravenpack, Gabor Melis.

It's under the MIT licence. See COPYING.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 lassie

Author

Gabor Melis

License

MIT

Description

Library for Latent Semantic Indexing.

Version

0.0.1

Dependency

fsvd

Source

lassie.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 lassie.asd

Location

lassie.asd

Systems

lassie (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 lassie/package.lisp

Parent

lassie (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 lassie/indexer.lisp

Dependency

package.lisp (file)

Parent

lassie (system)

Location

indexer.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 lassie/normalizer.lisp

Dependency

indexer.lisp (file)

Parent

lassie (system)

Location

normalizer.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 lassie/mapper.lisp

Dependency

normalizer.lisp (file)

Parent

lassie (system)

Location

mapper.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 lassie/assemble.lisp

Dependency

mapper.lisp (file)

Parent

lassie (system)

Location

assemble.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 lassie/lsa.lisp

Dependency

assemble.lisp (file)

Parent

lassie (system)

Location

lsa.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.8 lassie/lsa-extra.lisp

Dependency

lsa.lisp (file)

Parent

lassie (system)

Location

lsa-extra.lisp

Exported Definitions
Internal Definitions

insert-into-sorted-vector (function)


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 lassie

The core functionality of Lassie.

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

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 (file)

Use List

common-lisp

Used By List

lassie

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

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 (file)

Use List

common-lisp

Used By List

lassie

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: construct-document-vector LSA FEATURES

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

Package

lassie

Source

lsa.lisp (file)

Function: construct-term-vector LSA FEATURES

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

Package

lassie

Source

lsa.lisp (file)

Function: cosine-similarity X Y &key N
Package

lassie

Source

lsa-extra.lisp (file)

Function: document->vector LSA DOCUMENT

Turn DOCUMENT into a document vector.

Package

lassie

Source

lsa.lisp (file)

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 (file)

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 (file)

Function: load-lsa &key FILENAME SVD-FILENAME

Return the lsa loaded from FILENAME and SVD-FILENAME.

Package

lassie

Source

lsa.lisp (file)

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 (file)

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

lassie.indexer

Source

indexer.lisp (file)

Function: make-hashing-indexer &key TEST
Package

lassie.indexer

Source

indexer.lisp (file)

Function: make-random-indexer &key LENGTH N TEST
Package

lassie.indexer

Source

indexer.lisp (file)

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 (file)

Function: save-lsa LSA &key FILENAME SVD-FILENAME

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

Package

lassie

Source

lsa.lisp (file)

Function: term->vector LSA TERM

Turn TERM into a document vector.

Package

lassie

Source

lsa.lisp (file)

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 (file)

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Methods
Method: assemble-term-vector (ASSEMBLER lsa-assembler) LISTER
Generic Function: document-indexer OBJECT
Package

lassie

Methods
Method: document-indexer (LSA lsa)

Document indexer.

Source

lsa.lisp (file)

Generic Function: document-mapper OBJECT
Package

lassie

Methods
Method: document-mapper (LSA lsa)

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

Source

lsa.lisp (file)

Generic Function: normalize-document-vector NORMALIZER DOCUMENT-VECTOR DOCUMENT

Returned the normalized DOCUMENT-VECTOR. Possibly desctructive.

Package

lassie.assembler

Source

normalizer.lisp (file)

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 (file)

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 (file)

Generic Function: normalizer OBJECT
Package

lassie

Methods
Method: normalizer (LSA lsa)

Performs some last minute transformations on the assembled matrix.

Source

lsa.lisp (file)

Generic Function: svd OBJECT
Package

lassie

Methods
Method: svd (LSA lsa)

The singular value decomposition.

Source

lsa.lisp (file)

Generic Function: term-indexer OBJECT
Package

lassie

Methods
Method: term-indexer (LSA lsa)

Term indexer.

Source

lsa.lisp (file)

Generic Function: term-mapper OBJECT
Package

lassie

Methods
Method: term-mapper (LSA lsa)

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

Source

lsa.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Classes

Class: column-power-normalizer ()
Package

lassie.assembler

Source

normalizer.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: power
Initargs

:power

Initform

2

Readers

power (generic function)

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 (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: term-mapper

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

Initargs

:term-mapper

Readers

term-mapper (generic function)

Slot: document-mapper

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

Initargs

:document-mapper

Readers

document-mapper (generic function)

Slot: term-indexer

Term indexer.

Initargs

:term-indexer

Readers

term-indexer (generic function)

Slot: document-indexer

Document indexer.

Initargs

:document-indexer

Readers

document-indexer (generic function)

Slot: assembler

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

Initargs

:assembler

Readers

assembler (generic function)

Slot: normalizer

Performs some last minute transformations on the assembled matrix.

Initargs

:normalizer

Readers

normalizer (generic function)

Slot: svd

The singular value decomposition.

Initargs

:svd

Readers

svd (generic function)

Class: lsa-assembler ()

The standard assembler that adds ...

Package

lassie.assembler

Source

assemble.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

ri-term-assembler (class)

Direct methods
Direct slots
Slot: n-terms
Initargs

:n-terms

Readers

n-terms (generic function)

Slot: n-documents
Initargs

:n-documents

Readers

n-documents (generic function)

Class: null-normalizer ()
Package

lassie.assembler

Source

normalizer.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Class: pmi-normalizer ()
Package

lassie.assembler

Source

normalizer.lisp (file)

Direct superclasses

standard-object (class)

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

:document-class-fn

Initform

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

Readers

document-class-fn (generic function)

Slot: term-total
Initargs

:term-total

Readers

term-total (generic function)

Slot: term-counts
Initargs

:term-counts

Readers

term-counts (generic function)

Slot: class-counts
Initargs

:class-counts

Readers

class-counts (generic function)

Slot: term-counts-per-class
Initargs

:term-counts-per-class

Readers

term-counts-per-class (generic function)

Slot: term-total-per-class
Initargs

:term-total-per-class

Readers

term-total-per-class (generic function)

Slot: n-documents
Initargs

:n-documents

Readers

n-documents (generic function)

Class: ri-term-assembler ()

Terms are random indexed, documents are not.

Package

lassie.assembler

Source

assemble.lisp (file)

Direct superclasses

lsa-assembler (class)

Direct methods
Class: row-centering-normalizer ()
Package

lassie.assembler

Source

normalizer.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: row-averages
Readers

row-averages (generic function)

Class: sign-normalizer ()
Package

lassie.assembler

Source

normalizer.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Class: tf-idf-normalizer ()
Package

lassie.assembler

Source

normalizer.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: idfs

The inverse document frequencies in the originally assembled matrix.

Initargs

:idfs

Readers

idfs (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: %make-hashing-indexer &key (NEXT-INDEX NEXT-INDEX) (INDEX->OBJECT INDEX->OBJECT) (OBJECT->INDEX OBJECT->INDEX)
Package

lassie.indexer

Source

indexer.lisp (file)

Function: %make-random-indexer &key (LENGTH LENGTH) (N N) (OBJECT->INDEX OBJECT->INDEX)
Package

lassie.indexer

Source

indexer.lisp (file)

Function: alist->hashing-indexer TEST ALIST
Package

lassie.indexer

Source

indexer.lisp (file)

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 (file)

Function: column-norm MATRIX COLUMN &key POWER
Package

lassie.assembler

Source

normalizer.lisp (file)

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 (file)

Function: concatente-mappers &rest MAPPERS

Return a mapper that is the concatention of MAPPERS.

Package

lassie

Source

mapper.lisp (file)

Function: construct-lsa-vector LSA FEATURES SV-SIDE
Package

lassie

Source

lsa.lisp (file)

Function: coordinate BASIS VECTOR

Return the length of the projection of VECTOR to BASIS.

Package

lassie

Source

lsa.lisp (file)

Function: copy-counting-indexer INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: copy-hashing-indexer INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: copy-random-indexer INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: counting-indexer-count INSTANCE
Function: (setf counting-indexer-count) VALUE INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: counting-indexer-p OBJECT
Package

lassie.indexer

Source

indexer.lisp (file)

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 (file)

Function: encode-mapper MAPPER ENCODER &key ALLOCATE-NEW-INDEX-P

Translate MAPPER by encoding its sole argument with ENCODER.

Package

lassie

Source

mapper.lisp (file)

Function: extract-lsa-features LSA VECTOR-OR-INDEX SV-OWN SV-OTHER
Package

lassie

Source

lsa.lisp (file)

Function: extract-svd-features SVD VECTOR FN
Package

lassie

Source

lsa.lisp (file)

Function: hash-table= ALIST HASH-TABLE
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: hashing-indexer->alist INDEXER
Package

lassie.indexer

Source

indexer.lisp (file)

Function: hashing-indexer-index->object INSTANCE
Function: (setf hashing-indexer-index->object) VALUE INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: hashing-indexer-next-index INSTANCE
Function: (setf hashing-indexer-next-index) VALUE INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: hashing-indexer-object->index INSTANCE
Function: (setf hashing-indexer-object->index) VALUE INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: hashing-indexer-p OBJECT
Package

lassie.indexer

Source

indexer.lisp (file)

Function: incf-and-maybe-grow MATRIX DELTA &rest INDICES
Package

lassie.assembler

Source

assemble.lisp (file)

Function: inner* VECTOR1 VECTOR2
Package

lassie

Source

lsa.lisp (file)

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 (file)

Function: inverse-document-frequency MATRIX TERM

Relative importance of TERM across MATRIX.

Package

lassie.assembler

Source

normalizer.lisp (file)

Function: make-column-power-normalizer &key POWER
Package

lassie.assembler

Source

normalizer.lisp (file)

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 (file)

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 (file)

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 (file)

Function: make-lsa-assembler &key N-TERMS N-DOCUMENTS
Package

lassie.assembler

Source

assemble.lisp (file)

Function: make-mapper &rest SEQUENCES

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

Package

lassie

Source

mapper.lisp (file)

Function: make-null-normalizer ()
Package

lassie.assembler

Source

normalizer.lisp (file)

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

lassie.assembler

Source

assemble.lisp (file)

Function: make-tf-idf-normalizer &key IDFS
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: n-columns MATRIX
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: n-documents-with-term MATRIX TERM
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: n-rows MATRIX
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: norm VECTOR &key POWER
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: normalize-column MATRIX COLUMN &key POWER
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: normalize-vector VECTOR &key POWER
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: null-mapper &rest ARGS
Package

lassie

Source

mapper.lisp (file)

Function: random-indexer-length INSTANCE
Function: (setf random-indexer-length) VALUE INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: random-indexer-n INSTANCE
Function: (setf random-indexer-n) VALUE INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: random-indexer-object->index INSTANCE
Function: (setf random-indexer-object->index) VALUE INSTANCE
Package

lassie.indexer

Source

indexer.lisp (file)

Function: random-indexer-p OBJECT
Package

lassie.indexer

Source

indexer.lisp (file)

Function: row-average MATRIX ROW
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: sum-column MATRIX COLUMN
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: sum-matrix MATRIX
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: sum-row MATRIX ROW
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: sum-vector VECTOR
Package

lassie.assembler

Source

normalizer.lisp (file)

Function: term-frequency MATRIX TERM DOCUMENT

A normalized measure of how often TERM appears in DOCUMENT.

Package

lassie.assembler

Source

normalizer.lisp (file)

Function: test-compose-mappers ()
Package

lassie

Source

mapper.lisp (file)

Function: test-hashing-indexer ()
Package

lassie.indexer

Source

indexer.lisp (file)

Function: test-pmi-normalizer ()
Package

lassie.assembler

Source

normalizer.lisp (file)

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

lassie.assembler

Source

normalizer.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Generic functions

Generic Function: assembler OBJECT
Package

lassie

Methods
Method: assembler (LSA lsa)

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

Source

lsa.lisp (file)

Generic Function: class-counts OBJECT
Package

lassie.assembler

Methods
Method: class-counts (PMI-NORMALIZER pmi-normalizer)

automatically generated reader method

Source

normalizer.lisp (file)

Generic Function: document-class-fn OBJECT
Package

lassie.assembler

Methods
Method: document-class-fn (PMI-NORMALIZER pmi-normalizer)

automatically generated reader method

Source

normalizer.lisp (file)

Generic Function: idfs OBJECT
Package

lassie.assembler

Methods
Method: idfs (TF-IDF-NORMALIZER tf-idf-normalizer)

The inverse document frequencies in the originally assembled matrix.

Source

normalizer.lisp (file)

Generic Function: map-lines FUNCTION OBJECT
Package

lassie

Source

mapper.lisp (file)

Methods
Method: map-lines FUNCTION (STREAM stream)
Method: map-lines FUNCTION (PATHNAME pathname)
Method: map-lines FUNCTION (STRING string)
Generic Function: n-documents OBJECT
Package

lassie.assembler

Methods
Method: n-documents (LSA-ASSEMBLER lsa-assembler)

automatically generated reader method

Source

assemble.lisp (file)

Method: n-documents (PMI-NORMALIZER pmi-normalizer)

automatically generated reader method

Source

normalizer.lisp (file)

Generic Function: n-terms OBJECT
Package

lassie.assembler

Methods
Method: n-terms (LSA-ASSEMBLER lsa-assembler)

automatically generated reader method

Source

assemble.lisp (file)

Generic Function: power OBJECT
Package

lassie.assembler

Methods
Method: power (COLUMN-POWER-NORMALIZER column-power-normalizer)

automatically generated reader method

Source

normalizer.lisp (file)

Generic Function: row-averages OBJECT
Package

lassie.assembler

Methods
Method: row-averages (ROW-CENTERING-NORMALIZER row-centering-normalizer)

automatically generated reader method

Source

normalizer.lisp (file)

Generic Function: term-counts OBJECT
Package

lassie.assembler

Methods
Method: term-counts (PMI-NORMALIZER pmi-normalizer)

automatically generated reader method

Source

normalizer.lisp (file)

Generic Function: term-counts-per-class OBJECT
Package

lassie.assembler

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

automatically generated reader method

Source

normalizer.lisp (file)

Generic Function: term-total OBJECT
Package

lassie.assembler

Methods
Method: term-total (PMI-NORMALIZER pmi-normalizer)

automatically generated reader method

Source

normalizer.lisp (file)

Generic Function: term-total-per-class OBJECT
Package

lassie.assembler

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

automatically generated reader method

Source

normalizer.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Structures

Structure: counting-indexer ()

Simply assigns a new index to every object.

Package

lassie.indexer

Source

indexer.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods
Direct slots
Slot: count
Initform

0

Readers

counting-indexer-count (function)

Writers

(setf counting-indexer-count) (function)

Structure: hashing-indexer ()
Package

lassie.indexer

Source

indexer.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods
Direct slots
Slot: next-index
Initform

0

Readers

hashing-indexer-next-index (function)

Writers

(setf hashing-indexer-next-index) (function)

Slot: index->object
Readers

hashing-indexer-index->object (function)

Writers

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

Slot: object->index
Readers

hashing-indexer-object->index (function)

Writers

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

Structure: random-indexer ()
Package

lassie.indexer

Source

indexer.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

->index (method)

Direct slots
Slot: length
Readers

random-indexer-length (function)

Writers

(setf random-indexer-length) (function)

Slot: n
Readers

random-indexer-n (function)

Writers

(setf random-indexer-n) (function)

Slot: object->index
Readers

random-indexer-object->index (function)

Writers

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


Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Types

Type: single-float-vector ()
Package

lassie

Source

lsa.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
File, Lisp, lassie.asd: The lassie<dot>asd file
File, Lisp, lassie/assemble.lisp: The lassie/assemble<dot>lisp file
File, Lisp, lassie/indexer.lisp: The lassie/indexer<dot>lisp file
File, Lisp, lassie/lsa-extra.lisp: The lassie/lsa-extra<dot>lisp file
File, Lisp, lassie/lsa.lisp: The lassie/lsa<dot>lisp file
File, Lisp, lassie/mapper.lisp: The lassie/mapper<dot>lisp file
File, Lisp, lassie/normalizer.lisp: The lassie/normalizer<dot>lisp file
File, Lisp, lassie/package.lisp: The lassie/package<dot>lisp file

L
lassie.asd: The lassie<dot>asd file
lassie/assemble.lisp: The lassie/assemble<dot>lisp file
lassie/indexer.lisp: The lassie/indexer<dot>lisp file
lassie/lsa-extra.lisp: The lassie/lsa-extra<dot>lisp file
lassie/lsa.lisp: The lassie/lsa<dot>lisp file
lassie/mapper.lisp: The lassie/mapper<dot>lisp file
lassie/normalizer.lisp: The lassie/normalizer<dot>lisp file
lassie/package.lisp: The lassie/package<dot>lisp file
Lisp File, lassie.asd: The lassie<dot>asd file
Lisp File, lassie/assemble.lisp: The lassie/assemble<dot>lisp file
Lisp File, lassie/indexer.lisp: The lassie/indexer<dot>lisp file
Lisp File, lassie/lsa-extra.lisp: The lassie/lsa-extra<dot>lisp file
Lisp File, lassie/lsa.lisp: The lassie/lsa<dot>lisp file
Lisp File, lassie/mapper.lisp: The lassie/mapper<dot>lisp file
Lisp File, lassie/normalizer.lisp: The lassie/normalizer<dot>lisp file
Lisp File, lassie/package.lisp: The lassie/package<dot>lisp file

Jump to:   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

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: Internal functions
%make-random-indexer: Internal functions

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

-
->index: Exported generic functions
->index: Exported generic functions
->index: Exported generic functions
->index: Exported generic functions

<
<-index: Exported generic functions
<-index: Exported generic functions
<-index: Exported generic functions

A
alist->hashing-indexer: Internal functions
assemble-co-occurrence-matrix: Exported generic functions
assemble-co-occurrence-matrix: Exported generic functions
assemble-co-occurrence-matrix: Exported generic functions
assemble-document-vector: Exported generic functions
assemble-document-vector: Exported generic functions
assemble-document-vector: Exported generic functions
assemble-occurence-vector: Internal functions
assemble-term-vector: Exported generic functions
assemble-term-vector: Exported generic functions
assembler: Internal generic functions
assembler: Internal generic functions

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

D
document->vector: Exported functions
document-class-fn: Internal generic functions
document-class-fn: Internal generic functions
document-features: Exported functions
document-indexer: Exported generic functions
document-indexer: Exported generic functions
document-mapper: Exported generic functions
document-mapper: Exported generic functions
document-vector-features: Exported functions

E
encode-mapper: Internal functions
extract-lsa-features: Internal functions
extract-svd-features: Internal functions

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

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

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

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

L
load-lsa: Exported functions
lsa: Exported functions

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

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

P
power: Internal generic functions
power: Internal generic functions

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

S
save-lsa: Exported functions
sum-column: Internal functions
sum-matrix: Internal functions
sum-row: Internal functions
sum-vector: Internal functions
svd: Exported generic functions
svd: Exported generic functions

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

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

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

A
assembler: Exported classes

C
class-counts: Exported classes
count: Internal structures

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

I
idfs: Exported classes
index->object: Internal structures

L
length: Internal structures

N
n: Internal structures
n-documents: Exported classes
n-documents: Exported classes
n-terms: Exported classes
next-index: Internal structures
normalizer: Exported classes

O
object->index: Internal structures
object->index: Internal structures

P
power: Exported classes

R
row-averages: Exported classes

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

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

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

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   H   L   N   P   R   S   T  
Index Entry  Section

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

H
hashing-indexer: Internal structures

L
lassie: The lassie system
lassie: The lassie package
lassie.assembler: The lassie<dot>assembler package
lassie.indexer: The lassie<dot>indexer package
lsa: Exported classes
lsa-assembler: Exported classes

N
null-normalizer: Exported classes

P
Package, lassie: The lassie package
Package, lassie.assembler: The lassie<dot>assembler package
Package, lassie.indexer: The lassie<dot>indexer package
pmi-normalizer: Exported classes

R
random-indexer: Internal structures
ri-term-assembler: Exported classes
row-centering-normalizer: Exported classes

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

T
tf-idf-normalizer: Exported classes
Type, single-float-vector: Internal types

Jump to:   C   H   L   N   P   R   S   T