Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

correct spelling mistake, removed unused import, fixed two javadoc @param mismatches 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150024 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Erik Hatcher 2003-09-13 23:44:48 +00:00
parent e676d0f3d4
commit 165ee0d2c0
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/java/org/apache/lucene/search/Similarity.java
View File

@ -60,7 +60,6 @@ import java.util.Vector;
import org.apache.lucene.index.Term; import org.apache.lucene.index.Term;
import org.apache.lucene.index.IndexWriter; // for javadoc import org.apache.lucene.index.IndexWriter; // for javadoc
import org.apache.lucene.index.IndexReader; // for javadoc
import org.apache.lucene.document.Field; // for javadoc import org.apache.lucene.document.Field; // for javadoc
@ -229,13 +228,13 @@ public abstract class Similarity {
* form the initial score for a document. * form the initial score for a document.
* *
* <p>Terms and phrases repeated in a document indicate the topic of the * <p>Terms and phrases repeated in a document indicate the topic of the
* document, so implemenations of this method usually return larger values * document, so implementations of this method usually return larger values
* when <code>freq</code> is large, and smaller values when <code>freq</code> * when <code>freq</code> is large, and smaller values when <code>freq</code>
* is small. * is small.
* *
* <p>The default implementation calls {@link #tf(float)}. * <p>The default implementation calls {@link #tf(float)}.
* *
* @param tf the frequency of a term within a document * @param freq the frequency of a term within a document
* @return a score factor based on a term's within-document frequency * @return a score factor based on a term's within-document frequency
*/ */
public float tf(int freq) { public float tf(int freq) {
@ -247,7 +246,7 @@ public abstract class Similarity {
* the frequency that is passed to {@link #tf(float)}. * the frequency that is passed to {@link #tf(float)}.
* *
* <p>A phrase match with a small edit distance to a document passage more * <p>A phrase match with a small edit distance to a document passage more
* closely matches the document, so implemenations of this method usually * closely matches the document, so implementations of this method usually
* return larger values when the edit distance is small and smaller values * return larger values when the edit distance is small and smaller values
* when it is large. * when it is large.
* *
@ -267,7 +266,7 @@ public abstract class Similarity {
* when <code>freq</code> is large, and smaller values when <code>freq</code> * when <code>freq</code> is large, and smaller values when <code>freq</code>
* is small. * is small.
* *
* @param tf the frequency of a term within a document * @param freq the frequency of a term within a document
* @return a score factor based on a term's within-document frequency * @return a score factor based on a term's within-document frequency
*/ */
public abstract float tf(float freq); public abstract float tf(float freq);