You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by mi...@apache.org on 2015/03/06 18:51:52 UTC
svn commit: r1664687 - in /lucene/dev/trunk/lucene: CHANGES.txt
core/src/java/org/apache/lucene/search/similarities/DefaultSimilarity.java
core/src/test/org/apache/lucene/search/similarities/TestDefaultSimilarity.java
Author: mikemccand
Date: Fri Mar 6 17:51:52 2015
New Revision: 1664687
URL: http://svn.apache.org/r1664687
Log:
LUCENE-6343: DefaultSimilarity javadocs has the wrong example for encode/decode precision loss
Added:
lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/similarities/TestDefaultSimilarity.java (with props)
Modified:
lucene/dev/trunk/lucene/CHANGES.txt
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/DefaultSimilarity.java
Modified: lucene/dev/trunk/lucene/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/CHANGES.txt?rev=1664687&r1=1664686&r2=1664687&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/CHANGES.txt (original)
+++ lucene/dev/trunk/lucene/CHANGES.txt Fri Mar 6 17:51:52 2015
@@ -223,6 +223,9 @@ Other
* LUCENE-6333: Refactored queries to delegate their equals and hashcode
impls to the super class. (Lee Hinman via Adrien Grand)
+* LUCENE-6343: DefaultSimilarity javadocs had the wrong float value to
+ demonstrate precision of encoded norms (András Péteri via Mike McCandless)
+
Changes in Runtime Behavior
* LUCENE-6255: PhraseQuery now ignores leading holes and requires that
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/DefaultSimilarity.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/DefaultSimilarity.java?rev=1664687&r1=1664686&r2=1664687&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/DefaultSimilarity.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/DefaultSimilarity.java Fri Mar 6 17:51:52 2015
@@ -29,7 +29,7 @@ import org.apache.lucene.util.SmallFloat
* {@link #decodeNormValue(long) decoded} back to a float <i>norm</i> value.
* This encoding/decoding, while reducing index size, comes with the price of
* precision loss - it is not guaranteed that <i>decode(encode(x)) = x</i>. For
- * instance, <i>decode(encode(0.89)) = 0.75</i>.
+ * instance, <i>decode(encode(0.89)) = 0.875</i>.
* <p>
* Compression of norm values to a single byte saves memory at search time,
* because once a field is referenced at search time, its norms - for all
Added: lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/similarities/TestDefaultSimilarity.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/similarities/TestDefaultSimilarity.java?rev=1664687&view=auto
==============================================================================
--- lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/similarities/TestDefaultSimilarity.java (added)
+++ lucene/dev/trunk/lucene/core/src/test/org/apache/lucene/search/similarities/TestDefaultSimilarity.java Fri Mar 6 17:51:52 2015
@@ -0,0 +1,30 @@
+package org.apache.lucene.search.similarities;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.apache.lucene.util.LuceneTestCase;
+
+public class TestDefaultSimilarity extends LuceneTestCase {
+
+ // Javadocs give this as an example so we test to make sure it's correct:
+ public void testPrecisionLoss() throws Exception {
+ DefaultSimilarity sim = new DefaultSimilarity();
+ float v = sim.decodeNormValue(sim.encodeNormValue(.89f));
+ assertEquals(0.875f, v, 0.0001f);
+ }
+}