Initial commit
[moodle.git] / search / Zend / Search / Lucene / Search / Similarity / Default.php
1 <?php
2 /**
3  * Zend Framework
4  *
5  * LICENSE
6  *
7  * This source file is subject to the new BSD license that is bundled
8  * with this package in the file LICENSE.txt.
9  * It is also available through the world-wide-web at this URL:
10  * http://framework.zend.com/license/new-bsd
11  * If you did not receive a copy of the license and are unable to
12  * obtain it through the world-wide-web, please send an email
13  * to license@zend.com so we can send you a copy immediately.
14  *
15  * @category   Zend
16  * @package    Zend_Search_Lucene
17  * @subpackage Search
18  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20  */
23 /**
24  * @category   Zend
25  * @package    Zend_Search_Lucene
26  * @subpackage Search
27  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
28  * @license    http://framework.zend.com/license/new-bsd     New BSD License
29  */
30 class Zend_Search_Lucene_Search_Similarity_Default extends Zend_Search_Lucene_Search_Similarity
31 {
33     /**
34      * Implemented as '1/sqrt(numTerms)'.
35      *
36      * @param string $fieldName
37      * @param integer numTerms
38      * @return float
39      */
40     public function lengthNorm($fieldName, $numTerms)
41     {
42         if ($numTerms == 0) {
43             return 1E10;
44         }
46         return 1.0/sqrt($numTerms);
47     }
49     /**
50      * Implemented as '1/sqrt(sumOfSquaredWeights)'.
51      *
52      * @param float $sumOfSquaredWeights
53      * @return float
54      */
55     public function queryNorm($sumOfSquaredWeights)
56     {
57         return 1.0/sqrt($sumOfSquaredWeights);
58     }
60     /**
61      * Implemented as 'sqrt(freq)'.
62      *
63      * @param float $freq
64      * @return float
65      */
66     public function tf($freq)
67     {
68         return sqrt($freq);
69     }
71     /**
72      * Implemented as '1/(distance + 1)'.
73      *
74      * @param integer $distance
75      * @return float
76      */
77     public function sloppyFreq($distance)
78     {
79         return 1.0/($distance + 1);
80     }
82     /**
83      * Implemented as 'log(numDocs/(docFreq+1)) + 1'.
84      *
85      * @param integer $docFreq
86      * @param integer $numDocs
87      * @return float
88      */
89     public function idfFreq($docFreq, $numDocs)
90     {
91         return log($numDocs/(float)($docFreq+1)) + 1.0;
92     }
94     /**
95      * Implemented as 'overlap/maxOverlap'.
96      *
97      * @param integer $overlap
98      * @param integer $maxOverlap
99      * @return float
100      */
101     public function coord($overlap, $maxOverlap)
102     {
103         return $overlap/(float)$maxOverlap;
104     }