Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

_floatToByte(
$f
)
:
float
Float to byte conversion
Inherited from: \Zend_Search_Lucene_Search_Similarity::_floatToByte()Name | Type | Description |
---|---|---|
$f |
Type | Description |
---|---|
float |

coord(
integer $overlap, integer $maxOverlap
)
:
float
Implemented as 'overlap/maxOverlap'.
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
Name | Type | Description |
---|---|---|
$overlap | integer | |
$maxOverlap | integer |
Type | Description |
---|---|
float |

decodeNorm(
integer $byte
)
:
float
Decodes a normalization factor stored in an index.
Inherited from: \Zend_Search_Lucene_Search_Similarity::decodeNorm()Name | Type | Description |
---|---|---|
$byte | integer |
Type | Description |
---|---|
float |

encodeNorm(
float $f
)
:
integer
Encodes a normalization factor for storage in an index.
Inherited from: \Zend_Search_Lucene_Search_Similarity::encodeNorm()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.
Name | Type | Description |
---|---|---|
$f | float |
Type | Description |
---|---|
integer |

getDefault(
)
:
\Zend_Search_Lucene_Search_Similarity
Return the default Similarity implementation used by indexing and search code.
Inherited from: \Zend_Search_Lucene_Search_Similarity::getDefault()Type | Description |
---|---|
\Zend_Search_Lucene_Search_Similarity |

idf(
mixed $input, \Zend_Search_Lucene_Interface $reader
)
:
\a
Computes a score factor for a simple term or a phrase.
Inherited from: \Zend_Search_Lucene_Search_Similarity::idf()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
Name | Type | Description |
---|---|---|
$input | mixed | |
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\a | score factor for the term |

idfFreq(
integer $docFreq, integer $numDocs
)
:
float
Implemented as 'log(numDocs/(docFreq+1)) + 1'.
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
Name | Type | Description |
---|---|---|
$docFreq | integer | |
$numDocs | integer |
Type | Description |
---|---|
float |

lengthNorm(
string $fieldName, integer $numTerms
)
:
float
Implemented as '1/sqrt(numTerms)'.
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
Name | Type | Description |
---|---|---|
$fieldName | string | |
$numTerms | integer |
Type | Description |
---|---|
float |

queryNorm(
float $sumOfSquaredWeights
)
:
float
Implemented as '1/sqrt(sumOfSquaredWeights)'.
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
Name | Type | Description |
---|---|---|
$sumOfSquaredWeights | float |
Type | Description |
---|---|
float |

setDefault(
\Zend_Search_Lucene_Search_Similarity $similarity
)
:
void
Set the default Similarity implementation used by indexing and search code.
Inherited from: \Zend_Search_Lucene_Search_Similarity::setDefault()Name | Type | Description |
---|---|---|
$similarity | \Zend_Search_Lucene_Search_Similarity |

sloppyFreq(
integer $distance
)
:
float
Implemented as '1/(distance + 1)'.
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
Name | Type | Description |
---|---|---|
$distance | integer |
Type | Description |
---|---|
float |

tf(
float $freq
)
:
float
Implemented as 'sqrt(freq)'.
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
Name | Type | Description |
---|---|---|
$freq | float |
Type | Description |
---|---|
float |