You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ho...@apache.org on 2012/02/29 02:09:57 UTC
svn commit: r1294924 - in /lucene/dev/branches/branch_3x: ./ lucene/
lucene/contrib/misc/src/java/org/apache/lucene/misc/
lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ solr/
solr/core/
Author: hossman
Date: Wed Feb 29 01:09:56 2012
New Revision: 1294924
URL: http://svn.apache.org/viewvc?rev=1294924&view=rev
Log:
javadocs, pictures for SweetSpotSimilarity (merge r1294879 from trunk)
Added:
lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/
- copied from r1294920, lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/
lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ss.baselineTf.svg
- copied unchanged from r1294920, lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ss.baselineTf.svg
lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ss.computeLengthNorm.svg
- copied unchanged from r1294920, lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ss.computeLengthNorm.svg
lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ss.gnuplot
- copied unchanged from r1294920, lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ss.gnuplot
lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ss.hyperbolicTf.svg
- copied unchanged from r1294920, lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/doc-files/ss.hyperbolicTf.svg
Modified:
lucene/dev/branches/branch_3x/ (props changed)
lucene/dev/branches/branch_3x/lucene/ (props changed)
lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/SweetSpotSimilarity.java
lucene/dev/branches/branch_3x/solr/ (props changed)
lucene/dev/branches/branch_3x/solr/core/ (props changed)
Modified: lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/SweetSpotSimilarity.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/SweetSpotSimilarity.java?rev=1294924&r1=1294923&r2=1294924&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/SweetSpotSimilarity.java (original)
+++ lucene/dev/branches/branch_3x/lucene/contrib/misc/src/java/org/apache/lucene/misc/SweetSpotSimilarity.java Wed Feb 29 01:09:56 2012
@@ -43,6 +43,7 @@ import java.util.HashMap;
* subclasses can choose between.
* </p>
*
+ * @see <a href="doc-files/ss.gnuplot">A Gnuplot file used to generate some of the visualizations refrenced from each function.</a>
*/
public class SweetSpotSimilarity extends DefaultSimilarity {
@@ -82,7 +83,7 @@ public class SweetSpotSimilarity extends
*
* @param min the minimum tf value to ever be returned (default: 0.0)
* @param max the maximum tf value to ever be returned (default: 2.0)
- * @param base the base value to be used in the exponential for the hyperbolic function (default: e)
+ * @param base the base value to be used in the exponential for the hyperbolic function (default: 1.3)
* @param xoffset the midpoint of the hyperbolic function (default: 10.0)
* @see #hyperbolicTf
*/
@@ -166,6 +167,7 @@ public class SweetSpotSimilarity extends
* </p>
*
* @see #setLengthNormFactors
+ * @see <a href="doc-files/ss.computeLengthNorm.svg">An SVG visualization of this function</a>
*/
public float computeLengthNorm(String fieldName, int numTerms) {
int l = ln_min;
@@ -216,6 +218,7 @@ public class SweetSpotSimilarity extends
* </p>
*
* @see #setBaselineTfFactors
+ * @see <a href="doc-files/ss.baselineTf.svg">An SVG visualization of this function</a>
*/
public float baselineTf(float freq) {
@@ -239,6 +242,7 @@ public class SweetSpotSimilarity extends
* </p>
*
* @see #setHyperbolicTfFactors
+ * @see <a href="doc-files/ss.hyperbolicTf.svg">An SVG visualization of this function</a>
*/
public float hyperbolicTf(float freq) {
if (0.0f == freq) return 0.0f;