added boolean search
This commit is contained in:
Marty Schoch
parent
4ed5cda99c
commit
c80f7f4042
|
|
@ -0,0 +1,41 @@
|
|||
// Copyright (c) 2014 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.
|
||||
package search
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/couchbaselabs/bleve/index"
|
||||
)
|
||||
|
||||
type TermBooleanQuery struct {
|
||||
Must *TermConjunctionQuery `json:"must,omitempty"`
|
||||
MustNot *TermDisjunctionQuery `json:"must_not,omitempty"`
|
||||
Should *TermDisjunctionQuery `json:"should,omitempty"`
|
||||
BoostVal float64 `json:"boost,omitempty"`
|
||||
Explain bool `json:"explain,omitempty"`
|
||||
}
|
||||
|
||||
func (q *TermBooleanQuery) Boost() float64 {
|
||||
return q.BoostVal
|
||||
}
|
||||
|
||||
func (q *TermBooleanQuery) Searcher(index index.Index) (Searcher, error) {
|
||||
return NewTermBooleanSearcher(index, q)
|
||||
}
|
||||
|
||||
func (q *TermBooleanQuery) Validate() error {
|
||||
if q.Must == nil && q.Should == nil {
|
||||
return fmt.Errorf("Boolean query must contain at least one MUST or SHOULD clause")
|
||||
}
|
||||
if q.Must != nil && len(q.Must.Terms) == 0 && q.Should != nil && len(q.Should.Terms) == 0 {
|
||||
return fmt.Errorf("Boolean query must contain at least one MUST or SHOULD clause")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
|
@ -0,0 +1,257 @@
|
|||
// Copyright (c) 2014 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.
|
||||
package search
|
||||
|
||||
import (
|
||||
"math"
|
||||
|
||||
"github.com/couchbaselabs/bleve/index"
|
||||
)
|
||||
|
||||
type TermBooleanSearcher struct {
|
||||
index index.Index
|
||||
mustSearcher *TermConjunctionSearcher
|
||||
shouldSearcher *TermDisjunctionSearcher
|
||||
mustNotSearcher *TermDisjunctionSearcher
|
||||
queryNorm float64
|
||||
currMust *DocumentMatch
|
||||
currShould *DocumentMatch
|
||||
currMustNot *DocumentMatch
|
||||
currentId string
|
||||
min uint64
|
||||
scorer *TermConjunctionQueryScorer
|
||||
}
|
||||
|
||||
func NewTermBooleanSearcher(index index.Index, query *TermBooleanQuery) (*TermBooleanSearcher, error) {
|
||||
// build the downstream searchres
|
||||
var err error
|
||||
var mustSearcher *TermConjunctionSearcher
|
||||
if query.Must != nil {
|
||||
mustSearcher, err = NewTermConjunctionSearcher(index, query.Must)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
var shouldSearcher *TermDisjunctionSearcher
|
||||
if query.Should != nil {
|
||||
shouldSearcher, err = NewTermDisjunctionSearcher(index, query.Should)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
var mustNotSearcher *TermDisjunctionSearcher
|
||||
if query.MustNot != nil {
|
||||
mustNotSearcher, err = NewTermDisjunctionSearcher(index, query.MustNot)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
// build our searcher
|
||||
rv := TermBooleanSearcher{
|
||||
index: index,
|
||||
mustSearcher: mustSearcher,
|
||||
shouldSearcher: shouldSearcher,
|
||||
mustNotSearcher: mustNotSearcher,
|
||||
scorer: NewTermConjunctionQueryScorer(query.Explain),
|
||||
}
|
||||
rv.computeQueryNorm()
|
||||
err = rv.initSearchers()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &rv, nil
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) computeQueryNorm() {
|
||||
// first calculate sum of squared weights
|
||||
sumOfSquaredWeights := 0.0
|
||||
if s.mustSearcher != nil {
|
||||
sumOfSquaredWeights += s.mustSearcher.Weight()
|
||||
}
|
||||
if s.shouldSearcher != nil {
|
||||
sumOfSquaredWeights += s.shouldSearcher.Weight()
|
||||
}
|
||||
|
||||
// now compute query norm from this
|
||||
s.queryNorm = 1.0 / math.Sqrt(sumOfSquaredWeights)
|
||||
// finally tell all the downsteam searchers the norm
|
||||
if s.mustSearcher != nil {
|
||||
s.mustSearcher.SetQueryNorm(s.queryNorm)
|
||||
}
|
||||
if s.shouldSearcher != nil {
|
||||
s.shouldSearcher.SetQueryNorm(s.queryNorm)
|
||||
}
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) initSearchers() error {
|
||||
var err error
|
||||
// get all searchers pointing at their first match
|
||||
if s.mustSearcher != nil {
|
||||
s.currMust, err = s.mustSearcher.Next()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if s.shouldSearcher != nil {
|
||||
s.currShould, err = s.shouldSearcher.Next()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if s.mustNotSearcher != nil {
|
||||
s.currMustNot, err = s.mustNotSearcher.Next()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if s.mustSearcher != nil && s.currMust != nil {
|
||||
s.currentId = s.currMust.ID
|
||||
} else if s.mustSearcher == nil && s.currShould != nil {
|
||||
s.currentId = s.currShould.ID
|
||||
} else {
|
||||
s.currentId = ""
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) advanceNextMust() error {
|
||||
var err error
|
||||
|
||||
if s.mustSearcher != nil {
|
||||
s.currMust, err = s.mustSearcher.Next()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else if s.mustSearcher == nil {
|
||||
s.currShould, err = s.shouldSearcher.Next()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if s.mustSearcher != nil && s.currMust != nil {
|
||||
s.currentId = s.currMust.ID
|
||||
} else if s.mustSearcher == nil && s.currShould != nil {
|
||||
s.currentId = s.currShould.ID
|
||||
} else {
|
||||
s.currentId = ""
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) Weight() float64 {
|
||||
var rv float64
|
||||
rv += s.mustSearcher.Weight()
|
||||
rv += s.shouldSearcher.Weight()
|
||||
|
||||
return rv
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) SetQueryNorm(qnorm float64) {
|
||||
s.mustSearcher.SetQueryNorm(qnorm)
|
||||
s.shouldSearcher.SetQueryNorm(qnorm)
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) Next() (*DocumentMatch, error) {
|
||||
|
||||
var err error
|
||||
var rv *DocumentMatch
|
||||
|
||||
for s.currentId != "" {
|
||||
if s.currMustNot != nil && s.currMustNot.ID < s.currentId {
|
||||
// advance must not searcher to our candidate entry
|
||||
s.currMustNot, err = s.mustNotSearcher.Advance(s.currentId)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if s.currMustNot != nil && s.currMustNot.ID == s.currentId {
|
||||
// the candidate is excluded
|
||||
s.advanceNextMust()
|
||||
continue
|
||||
}
|
||||
} else if s.currMustNot != nil && s.currMustNot.ID == s.currentId {
|
||||
// the candidate is excluded
|
||||
s.advanceNextMust()
|
||||
continue
|
||||
}
|
||||
|
||||
if s.currShould != nil && s.currShould.ID < s.currentId {
|
||||
// advance shoudl searcher to our candidate entry
|
||||
s.currShould, err = s.shouldSearcher.Advance(s.currentId)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if s.currShould != nil && s.currShould.ID == s.currentId {
|
||||
// score bonus matches should
|
||||
cons := []*DocumentMatch{}
|
||||
if s.currMust != nil {
|
||||
cons = append(cons, s.currMust)
|
||||
}
|
||||
cons = append(cons, s.currShould)
|
||||
rv = s.scorer.Score(cons)
|
||||
s.advanceNextMust()
|
||||
break
|
||||
} else if s.shouldSearcher.min == 0 {
|
||||
// match is OK anyway
|
||||
rv = s.scorer.Score([]*DocumentMatch{s.currMust})
|
||||
s.advanceNextMust()
|
||||
break
|
||||
}
|
||||
} else if s.currShould != nil && s.currShould.ID == s.currentId {
|
||||
// score bonus matches should
|
||||
cons := []*DocumentMatch{}
|
||||
if s.currMust != nil {
|
||||
cons = append(cons, s.currMust)
|
||||
}
|
||||
cons = append(cons, s.currShould)
|
||||
rv = s.scorer.Score(cons)
|
||||
s.advanceNextMust()
|
||||
break
|
||||
} else if s.shouldSearcher == nil || s.shouldSearcher.min == 0 {
|
||||
// match is OK anyway
|
||||
rv = s.scorer.Score([]*DocumentMatch{s.currMust})
|
||||
s.advanceNextMust()
|
||||
break
|
||||
}
|
||||
|
||||
s.advanceNextMust()
|
||||
}
|
||||
return rv, nil
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) Advance(ID string) (*DocumentMatch, error) {
|
||||
s.currentId = ID
|
||||
return s.Next()
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) Count() uint64 {
|
||||
// for now return a worst case
|
||||
var sum uint64 = 0
|
||||
sum += s.mustSearcher.Count()
|
||||
sum += s.shouldSearcher.Count()
|
||||
return sum
|
||||
}
|
||||
|
||||
func (s *TermBooleanSearcher) Close() {
|
||||
if s.mustSearcher != nil {
|
||||
s.mustSearcher.Close()
|
||||
}
|
||||
if s.shouldSearcher != nil {
|
||||
s.shouldSearcher.Close()
|
||||
}
|
||||
if s.mustNotSearcher != nil {
|
||||
s.mustNotSearcher.Close()
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,113 @@
|
|||
// Copyright (c) 2014 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.
|
||||
package search
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/couchbaselabs/bleve/index"
|
||||
)
|
||||
|
||||
func TestTermBooleanSearch(t *testing.T) {
|
||||
|
||||
tests := []struct {
|
||||
index index.Index
|
||||
query Query
|
||||
results []*DocumentMatch
|
||||
}{
|
||||
{
|
||||
index: twoDocIndex,
|
||||
query: &TermBooleanQuery{
|
||||
Must: &TermConjunctionQuery{
|
||||
Terms: []Query{
|
||||
&TermQuery{
|
||||
Term: "beer",
|
||||
Field: "desc",
|
||||
BoostVal: 1.0,
|
||||
Explain: true,
|
||||
},
|
||||
},
|
||||
Explain: true,
|
||||
},
|
||||
Should: &TermDisjunctionQuery{
|
||||
Terms: []Query{
|
||||
&TermQuery{
|
||||
Term: "marty",
|
||||
Field: "name",
|
||||
BoostVal: 1.0,
|
||||
Explain: true,
|
||||
},
|
||||
&TermQuery{
|
||||
Term: "dustin",
|
||||
Field: "name",
|
||||
BoostVal: 1.0,
|
||||
Explain: true,
|
||||
},
|
||||
},
|
||||
Explain: true,
|
||||
Min: 0,
|
||||
},
|
||||
MustNot: &TermDisjunctionQuery{
|
||||
Terms: []Query{
|
||||
&TermQuery{
|
||||
Term: "steve",
|
||||
Field: "name",
|
||||
BoostVal: 1.0,
|
||||
Explain: true,
|
||||
},
|
||||
},
|
||||
Explain: true,
|
||||
Min: 0,
|
||||
},
|
||||
Explain: true,
|
||||
},
|
||||
results: []*DocumentMatch{
|
||||
&DocumentMatch{
|
||||
ID: "1",
|
||||
Score: 1.6775110856165738,
|
||||
},
|
||||
&DocumentMatch{
|
||||
ID: "3",
|
||||
Score: 0.8506018914159408,
|
||||
},
|
||||
&DocumentMatch{
|
||||
ID: "4",
|
||||
Score: 0.34618161159873423,
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for testIndex, test := range tests {
|
||||
searcher, err := test.query.Searcher(test.index)
|
||||
defer searcher.Close()
|
||||
|
||||
next, err := searcher.Next()
|
||||
i := 0
|
||||
for err == nil && next != nil {
|
||||
if i < len(test.results) {
|
||||
if next.ID != test.results[i].ID {
|
||||
t.Errorf("expected result %d to have id %s got %s for test %d", i, test.results[i].ID, next.ID, testIndex)
|
||||
}
|
||||
if next.Score != test.results[i].Score {
|
||||
t.Errorf("expected result %d to have score %v got %v for test %d", i, test.results[i].Score, next.Score, testIndex)
|
||||
t.Logf("scoring explanation: %s", next.Expl)
|
||||
}
|
||||
}
|
||||
next, err = searcher.Next()
|
||||
i++
|
||||
}
|
||||
if err != nil {
|
||||
t.Fatalf("error iterating searcher: %v for test %d", err, testIndex)
|
||||
}
|
||||
if len(test.results) != i {
|
||||
t.Errorf("expected %d results got %d for test %d", len(test.results), i, testIndex)
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue