## Zend_Search_Lucene_Search_Similarity

Description

- abstract:
- license: New BSD License
- copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Search/Lucene/Search/Similarity.php (line 34)

Direct descendents

Class | Description
--- | ---
Zend_Search_Lucene_Search_Similarity_Default |

Method Summary
static float decodeNorm (integer $byte)
static integer encodeNorm (float $f)
static Zend_Search_Lucene_Search_Similarity getDefault ()
static void setDefault (Zend_Search_Lucene_Search_Similarity $similarity)
float coord (integer $overlap, integer $maxOverlap)
a idf (mixed $input, Zend_Search_Lucene $reader)
float idfFreq (integer $docFreq, integer $numDocs)
float lengthNorm (string $fieldName, integer $numTokens)
float queryNorm (float $sumOfSquaredWeights)
float sloppyFreq (integer $distance)
float tf (float $freq)
Methods
static decodeNorm (line 384)

Decodes a normalization factor stored in an index.

- access: public

float decodeNorm (integer $byte)

- integer $byte

static encodeNorm (line 404)

Encodes a normalization factor for storage in an index.

The encoding uses a five-bit exponent and three-bit mantissa, thus representing values from around 7x10^9 to 2x10^-9 with about one significant decimal digit of accuracy. Zero is also represented. Negative numbers are rounded up to zero. Values too large to represent are rounded down to the largest representable value. Positive values too small to represent are rounded up to the smallest positive representable value.

integer encodeNorm (float $f)

- float $f

static getDefault (line 325)

Return the default Similarity implementation used by indexing and search code.

- access: public

Zend_Search_Lucene_Search_Similarity getDefault ()
static setDefault (line 313)

Set the default Similarity implementation used by indexing and search code.

- access: public

void setDefault (Zend_Search_Lucene_Search_Similarity $similarity)

- Zend_Search_Lucene_Search_Similarity $similarity

coord (line 551)

Computes a score factor based on the fraction of all query terms that a document contains. This value is multiplied into scores.

The presence of a large portion of the query terms indicates a better match with the query, so implemenations of this method usually return larger values when the ratio between these parameters is large and smaller values when the ratio between them is small.

overlap - the number of query terms matched in the document maxOverlap - the total number of terms in the query Returns a score factor based on term overlap with the query

- access: public
- abstract:

float coord (integer $overlap, integer $maxOverlap)

- integer $overlap
- integer $maxOverlap

Redefined in descendants as:

- Zend_Search_Lucene_Search_Similarity_Default::coord() : Implemented as 'overlap/maxOverlap'.

idf (line 501)

Computes a score factor for a simple term or a phrase.

The default implementation is: return idfFreq(searcher.docFreq(term), searcher.maxDoc());

input - the term in question or array of terms reader - reader the document collection being searched Returns a score factor for the term

- return: score factor for the term
- access: public

a idf (mixed $input, Zend_Search_Lucene $reader)

- mixed $input
- Zend_Search_Lucene $reader

idfFreq (line 532)

Computes a score factor based on a term's document frequency (the number of documents which contain the term). This value is multiplied by the tf(int) factor for each term in the query and these products are then summed to form the initial score for a document.

Terms that occur in fewer documents are better indicators of topic, so implemenations of this method usually return larger values for rare terms, and smaller values for common terms.

docFreq - the number of documents which contain the term numDocs - the total number of documents in the collection Returns a score factor based on the term's document frequency

- access: public
- abstract:

float idfFreq (integer $docFreq, integer $numDocs)

- integer $docFreq
- integer $numDocs

Redefined in descendants as:

- Zend_Search_Lucene_Search_Similarity_Default::idfFreq() : Implemented as 'log(numDocs/(docFreq+1)) + 1'.

lengthNorm (line 359)

Computes the normalization value for a field given the total number of terms contained in a field. These values, together with field boosts, are stored in an index and multipled into scores for hits on each field by the search code.

Matches in longer fields are less precise, so implemenations of this method usually return smaller values when 'numTokens' is large, and larger values when 'numTokens' is small.

That these values are computed under IndexWriter::addDocument(Document) and stored then using encodeNorm(float). Thus they have limited precision, and documents must be re-indexed if this method is altered.

fieldName - name of field numTokens - the total number of tokens contained in fields named 'fieldName' of 'doc'. Returns a normalization factor for hits on this field of this document

- access: public
- abstract:

float lengthNorm (string $fieldName, integer $numTokens)

- string $fieldName
- integer $numTokens

Redefined in descendants as:

- Zend_Search_Lucene_Search_Similarity_Default::lengthNorm() : Implemented as '1/sqrt(numTerms)'.

queryNorm (line 375)

Computes the normalization value for a query given the sum of the squared weights of each of the query terms. This value is then multipled into the weight of each query term.

This does not affect ranking, but rather just attempts to make scores from different queries comparable.

sumOfSquaredWeights - the sum of the squares of query term weights Returns a normalization factor for query weights

- access: public
- abstract:

float queryNorm (float $sumOfSquaredWeights)

- float $sumOfSquaredWeights

Redefined in descendants as:

- Zend_Search_Lucene_Search_Similarity_Default::queryNorm() : Implemented as '1/sqrt(sumOfSquaredWeights)'.

sloppyFreq (line 484)

Computes the amount of a sloppy phrase match, based on an edit distance.

This value is summed for each sloppy phrase match in a document to form the frequency that is passed to tf(float).

A phrase match with a small edit distance to a document passage more closely matches the document, so implementations of this method usually return larger values when the edit distance is small and smaller values when it is large.

distance - the edit distance of this sloppy phrase match Returns the frequency increment for this match

- access: public
- abstract:

float sloppyFreq (integer $distance)

- integer $distance

Redefined in descendants as:

- Zend_Search_Lucene_Search_Similarity_Default::sloppyFreq() : Implemented as '1/(distance + 1)'.

tf (line 466)

Computes a score factor based on a term or phrase's frequency in a document. This value is multiplied by the idf(Term, Searcher) factor for each term in the query and these products are then summed to form the initial score for a document.

Terms and phrases repeated in a document indicate the topic of the document, so implementations of this method usually return larger values when 'freq' is large, and smaller values when 'freq' is small.

freq - the frequency of a term within a document Returns a score factor based on a term's within-document frequency

- access: public
- abstract:

float tf (float $freq)

- float $freq

Redefined in descendants as:

- Zend_Search_Lucene_Search_Similarity_Default::tf() : Implemented as 'sqrt(freq)'.

Documentation generated on Tue, 11 Jul 2006 12:18:06 -0500 by phpDocumentor 1.3.0RC6