2014-04-19 20:29:42 +02:00
|
|
|
// Copyright (c) 2013 Couchbase, Inc.
|
|
|
|
// Licensed 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.
|
2014-09-02 16:54:50 +02:00
|
|
|
|
2014-09-01 17:15:38 +02:00
|
|
|
package scorers
|
2014-04-19 20:29:42 +02:00
|
|
|
|
|
|
|
import (
|
|
|
|
"math"
|
|
|
|
"reflect"
|
|
|
|
"testing"
|
|
|
|
|
2014-08-28 21:38:57 +02:00
|
|
|
"github.com/blevesearch/bleve/index"
|
2014-09-01 17:15:38 +02:00
|
|
|
"github.com/blevesearch/bleve/search"
|
2014-04-19 20:29:42 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
func TestTermScorer(t *testing.T) {
|
|
|
|
|
|
|
|
var docTotal uint64 = 100
|
|
|
|
var docTerm uint64 = 9
|
2014-07-30 18:30:38 +02:00
|
|
|
var queryTerm = "beer"
|
|
|
|
var queryField = "desc"
|
|
|
|
var queryBoost = 1.0
|
|
|
|
scorer := NewTermQueryScorer(queryTerm, queryField, queryBoost, docTotal, docTerm, true)
|
2014-04-19 20:29:42 +02:00
|
|
|
idf := 1.0 + math.Log(float64(docTotal)/float64(docTerm+1.0))
|
|
|
|
|
|
|
|
tests := []struct {
|
|
|
|
termMatch *index.TermFieldDoc
|
2014-09-01 17:15:38 +02:00
|
|
|
result *search.DocumentMatch
|
2014-04-19 20:29:42 +02:00
|
|
|
}{
|
|
|
|
// test some simple math
|
|
|
|
{
|
|
|
|
termMatch: &index.TermFieldDoc{
|
|
|
|
ID: "one",
|
|
|
|
Freq: 1,
|
|
|
|
Norm: 1.0,
|
2014-04-19 20:49:15 +02:00
|
|
|
Vectors: []*index.TermFieldVector{
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:49:15 +02:00
|
|
|
Field: "desc",
|
|
|
|
Pos: 1,
|
|
|
|
Start: 0,
|
|
|
|
End: 4,
|
|
|
|
},
|
|
|
|
},
|
2014-04-19 20:29:42 +02:00
|
|
|
},
|
2014-09-01 17:15:38 +02:00
|
|
|
result: &search.DocumentMatch{
|
2014-04-19 20:29:42 +02:00
|
|
|
ID: "one",
|
|
|
|
Score: math.Sqrt(1.0) * idf,
|
2014-09-01 17:15:38 +02:00
|
|
|
Expl: &search.Explanation{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: math.Sqrt(1.0) * idf,
|
|
|
|
Message: "fieldWeight(desc:beer in one), product of:",
|
2014-09-01 17:15:38 +02:00
|
|
|
Children: []*search.Explanation{
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: 1,
|
|
|
|
Message: "tf(termFreq(desc:beer)=1",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: 1,
|
|
|
|
Message: "fieldNorm(field=desc, doc=one)",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: idf,
|
|
|
|
Message: "idf(docFreq=9, maxDocs=100)",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
2014-09-01 17:15:38 +02:00
|
|
|
Locations: search.FieldTermLocationMap{
|
|
|
|
"desc": search.TermLocationMap{
|
2016-04-03 05:54:36 +02:00
|
|
|
"beer": []*search.Location{
|
2016-04-03 06:03:33 +02:00
|
|
|
{
|
2014-04-19 20:49:15 +02:00
|
|
|
Pos: 1,
|
|
|
|
Start: 0,
|
|
|
|
End: 4,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
2014-04-19 20:29:42 +02:00
|
|
|
},
|
|
|
|
},
|
|
|
|
// test the same thing again (score should be cached this time)
|
|
|
|
{
|
|
|
|
termMatch: &index.TermFieldDoc{
|
|
|
|
ID: "one",
|
|
|
|
Freq: 1,
|
|
|
|
Norm: 1.0,
|
|
|
|
},
|
2014-09-01 17:15:38 +02:00
|
|
|
result: &search.DocumentMatch{
|
2014-04-19 20:29:42 +02:00
|
|
|
ID: "one",
|
|
|
|
Score: math.Sqrt(1.0) * idf,
|
2014-09-01 17:15:38 +02:00
|
|
|
Expl: &search.Explanation{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: math.Sqrt(1.0) * idf,
|
|
|
|
Message: "fieldWeight(desc:beer in one), product of:",
|
2014-09-01 17:15:38 +02:00
|
|
|
Children: []*search.Explanation{
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: 1,
|
|
|
|
Message: "tf(termFreq(desc:beer)=1",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: 1,
|
|
|
|
Message: "fieldNorm(field=desc, doc=one)",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: idf,
|
|
|
|
Message: "idf(docFreq=9, maxDocs=100)",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
2014-04-19 20:29:42 +02:00
|
|
|
},
|
|
|
|
},
|
|
|
|
// test a case where the sqrt isn't precalculated
|
|
|
|
{
|
|
|
|
termMatch: &index.TermFieldDoc{
|
|
|
|
ID: "one",
|
|
|
|
Freq: 65,
|
|
|
|
Norm: 1.0,
|
|
|
|
},
|
2014-09-01 17:15:38 +02:00
|
|
|
result: &search.DocumentMatch{
|
2014-04-19 20:29:42 +02:00
|
|
|
ID: "one",
|
|
|
|
Score: math.Sqrt(65) * idf,
|
2014-09-01 17:15:38 +02:00
|
|
|
Expl: &search.Explanation{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: math.Sqrt(65) * idf,
|
|
|
|
Message: "fieldWeight(desc:beer in one), product of:",
|
2014-09-01 17:15:38 +02:00
|
|
|
Children: []*search.Explanation{
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: math.Sqrt(65),
|
|
|
|
Message: "tf(termFreq(desc:beer)=65",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: 1,
|
|
|
|
Message: "fieldNorm(field=desc, doc=one)",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 20:39:07 +02:00
|
|
|
Value: idf,
|
|
|
|
Message: "idf(docFreq=9, maxDocs=100)",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
2014-04-19 20:29:42 +02:00
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, test := range tests {
|
2016-07-21 01:29:20 +02:00
|
|
|
actual := scorer.Score(test.termMatch, nil)
|
2014-04-19 20:29:42 +02:00
|
|
|
|
|
|
|
if !reflect.DeepEqual(actual, test.result) {
|
|
|
|
t.Errorf("expected %#v got %#v for %#v", test.result, actual, test.termMatch)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
2014-04-19 21:04:12 +02:00
|
|
|
|
|
|
|
func TestTermScorerWithQueryNorm(t *testing.T) {
|
|
|
|
|
|
|
|
var docTotal uint64 = 100
|
|
|
|
var docTerm uint64 = 9
|
2014-07-30 18:30:38 +02:00
|
|
|
var queryTerm = "beer"
|
|
|
|
var queryField = "desc"
|
|
|
|
var queryBoost = 3.0
|
|
|
|
scorer := NewTermQueryScorer(queryTerm, queryField, queryBoost, docTotal, docTerm, true)
|
2014-04-19 21:04:12 +02:00
|
|
|
idf := 1.0 + math.Log(float64(docTotal)/float64(docTerm+1.0))
|
|
|
|
|
|
|
|
scorer.SetQueryNorm(2.0)
|
|
|
|
|
2014-04-19 21:11:29 +02:00
|
|
|
expectedQueryWeight := 3 * idf * 3 * idf
|
|
|
|
actualQueryWeight := scorer.Weight()
|
|
|
|
if expectedQueryWeight != actualQueryWeight {
|
|
|
|
t.Errorf("expected query weight %f, got %f", expectedQueryWeight, actualQueryWeight)
|
|
|
|
}
|
|
|
|
|
2014-04-19 21:04:12 +02:00
|
|
|
tests := []struct {
|
|
|
|
termMatch *index.TermFieldDoc
|
2014-09-01 17:15:38 +02:00
|
|
|
result *search.DocumentMatch
|
2014-04-19 21:04:12 +02:00
|
|
|
}{
|
|
|
|
{
|
|
|
|
termMatch: &index.TermFieldDoc{
|
|
|
|
ID: "one",
|
|
|
|
Freq: 1,
|
|
|
|
Norm: 1.0,
|
|
|
|
},
|
2014-09-01 17:15:38 +02:00
|
|
|
result: &search.DocumentMatch{
|
2014-04-19 21:04:12 +02:00
|
|
|
ID: "one",
|
|
|
|
Score: math.Sqrt(1.0) * idf * 3.0 * idf * 2.0,
|
2014-09-01 17:15:38 +02:00
|
|
|
Expl: &search.Explanation{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: math.Sqrt(1.0) * idf * 3.0 * idf * 2.0,
|
|
|
|
Message: "weight(desc:beer^3.000000 in one), product of:",
|
2014-09-01 17:15:38 +02:00
|
|
|
Children: []*search.Explanation{
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: 2.0 * idf * 3.0,
|
|
|
|
Message: "queryWeight(desc:beer^3.000000), product of:",
|
2014-09-01 17:15:38 +02:00
|
|
|
Children: []*search.Explanation{
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: 3,
|
|
|
|
Message: "boost",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: idf,
|
|
|
|
Message: "idf(docFreq=9, maxDocs=100)",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: 2,
|
|
|
|
Message: "queryNorm",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: math.Sqrt(1.0) * idf,
|
|
|
|
Message: "fieldWeight(desc:beer in one), product of:",
|
2014-09-01 17:15:38 +02:00
|
|
|
Children: []*search.Explanation{
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: 1,
|
|
|
|
Message: "tf(termFreq(desc:beer)=1",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: 1,
|
|
|
|
Message: "fieldNorm(field=desc, doc=one)",
|
|
|
|
},
|
2016-04-03 03:54:33 +02:00
|
|
|
{
|
2014-04-19 21:04:12 +02:00
|
|
|
Value: idf,
|
|
|
|
Message: "idf(docFreq=9, maxDocs=100)",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, test := range tests {
|
2016-07-21 01:29:20 +02:00
|
|
|
actual := scorer.Score(test.termMatch, nil)
|
2014-04-19 21:04:12 +02:00
|
|
|
|
|
|
|
if !reflect.DeepEqual(actual, test.result) {
|
|
|
|
t.Errorf("expected %#v got %#v for %#v", test.result, actual, test.termMatch)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|