similarity

Documentation

Index

• type BM25Scorer
  • func NewBM25Scorer(boost, k1, b, avgDocLen float64, idf *search.Explanation) *BM25Scorer
  • func (b *BM25Scorer) Explain(freq int, norm float64) *search.Explanation
  • func (b *BM25Scorer) QueryNormWeight() (float64, bool)
  • func (b *BM25Scorer) Score(freq int, norm float64) float64
  • func (b *BM25Scorer) ScoreImpactUpperBound(impacts []segment.Impact) float64
  • func (b *BM25Scorer) ScoreRawNorm(freq int, normBits uint64) float64
  • func (b *BM25Scorer) SetQueryNorm(queryNorm float64)
• type BM25Similarity
  • func NewBM25Similarity() *BM25Similarity
  • func NewBM25SimilarityBK1(b, k1 float64) *BM25Similarity
  • func NewBleveBM25Similarity() *BM25Similarity
  • func NewLegacyBM25Similarity() *BM25Similarity
  • func NewLegacyBM25SimilarityBK1(b, k1 float64) *BM25Similarity
  • func (b *BM25Similarity) AverageFieldLength(stats segment.CollectionStats) float64
  • func (b *BM25Similarity) ComputeNorm(numTerms int) float32
  • func (b *BM25Similarity) Idf(docFreq, docCount uint64) float64
  • func (b *BM25Similarity) IdfExplainTerm(collectionStats segment.CollectionStats, termStats segment.TermStats) *search.Explanation
  • func (b *BM25Similarity) Scorer(boost float64, collectionStats segment.CollectionStats, ...) search.Scorer
  • func (b *BM25Similarity) UsesQueryNorm() bool
• type CompositeSumScorer
  • func NewCompositeSumScorer() *CompositeSumScorer
  • func NewCompositeSumScorerWithBoost(boost float64) *CompositeSumScorer
  • func (c *CompositeSumScorer) ExplainComposite(constituents []*search.DocumentMatch) *search.Explanation
  • func (c *CompositeSumScorer) ScoreComposite(constituents []*search.DocumentMatch) float64
  • func (c *CompositeSumScorer) ScoreCompositeSum(sum float64) (float64, bool)
• type ConstantScorer
  • func (c ConstantScorer) Explain(_ int, _ float64) *search.Explanation
  • func (c ConstantScorer) ExplainComposite(_ []*search.DocumentMatch) *search.Explanation
  • func (c ConstantScorer) Score(_ int, _ float64) float64
  • func (c ConstantScorer) ScoreComposite(_ []*search.DocumentMatch) float64

Types

type BM25Scorer

type BM25Scorer struct {
	// contains filtered or unexported fields
}

func NewBM25Scorer

func NewBM25Scorer(boost, k1, b, avgDocLen float64, idf *search.Explanation) *BM25Scorer

func (*BM25Scorer) Explain

func (b *BM25Scorer) Explain(freq int, norm float64) *search.Explanation

func (*BM25Scorer) QueryNormWeight

func (b *BM25Scorer) QueryNormWeight() (float64, bool)

QueryNormWeight and SetQueryNorm are consumed by compatible searchers when Bleve-style query normalization is enabled.

func (*BM25Scorer) Score

func (b *BM25Scorer) Score(freq int, norm float64) float64

func (*BM25Scorer) ScoreImpactUpperBound

func (b *BM25Scorer) ScoreImpactUpperBound(impacts []segment.Impact) float64

ScoreImpactUpperBound evaluates every non-dominated pair persisted for a block using the same arithmetic as document scoring.

func (*BM25Scorer) ScoreRawNorm

func (b *BM25Scorer) ScoreRawNorm(freq int, normBits uint64) float64

func (*BM25Scorer) SetQueryNorm

func (b *BM25Scorer) SetQueryNorm(queryNorm float64)

type BM25Similarity

type BM25Similarity struct {
	// contains filtered or unexported fields
}

func NewBM25Similarity

func NewBM25Similarity() *BM25Similarity

NewBM25Similarity returns the standard BM25 similarity used by default.

func NewBM25SimilarityBK1

func NewBM25SimilarityBK1(b, k1 float64) *BM25Similarity

func NewBleveBM25Similarity

func NewBleveBM25Similarity() *BM25Similarity

NewBleveBM25Similarity approximates the ranking behavior of Bleve v2.5.7. It intentionally retains Bluge's norm encoding so an index can be searched with any of the built-in BM25 modes without rebuilding it.

func NewLegacyBM25Similarity

func NewLegacyBM25Similarity() *BM25Similarity

NewLegacyBM25Similarity preserves Bluge's historical BM25 score formula.

func NewLegacyBM25SimilarityBK1

func NewLegacyBM25SimilarityBK1(b, k1 float64) *BM25Similarity

func (*BM25Similarity) AverageFieldLength

func (b *BM25Similarity) AverageFieldLength(stats segment.CollectionStats) float64

func (*BM25Similarity) ComputeNorm

func (b *BM25Similarity) ComputeNorm(numTerms int) float32

func (*BM25Similarity) Idf

func (b *BM25Similarity) Idf(docFreq, docCount uint64) float64

func (*BM25Similarity) IdfExplainTerm

func (b *BM25Similarity) IdfExplainTerm(collectionStats segment.CollectionStats, termStats segment.TermStats) *search.Explanation

func (*BM25Similarity) Scorer

func (b *BM25Similarity) Scorer(boost float64, collectionStats segment.CollectionStats, termStats segment.TermStats) search.Scorer

func (*BM25Similarity) UsesQueryNorm

func (b *BM25Similarity) UsesQueryNorm() bool

UsesQueryNorm reports whether searchers should apply Bleve-style query normalization.

type CompositeSumScorer

type CompositeSumScorer struct {
	// contains filtered or unexported fields
}

func NewCompositeSumScorer

func NewCompositeSumScorer() *CompositeSumScorer

func NewCompositeSumScorerWithBoost

func NewCompositeSumScorerWithBoost(boost float64) *CompositeSumScorer

func (*CompositeSumScorer) ExplainComposite

func (c *CompositeSumScorer) ExplainComposite(constituents []*search.DocumentMatch) *search.Explanation

func (*CompositeSumScorer) ScoreComposite

func (c *CompositeSumScorer) ScoreComposite(constituents []*search.DocumentMatch) float64

func (*CompositeSumScorer) ScoreCompositeSum

func (c *CompositeSumScorer) ScoreCompositeSum(sum float64) (float64, bool)

ScoreCompositeSum applies the composite boost to an already accumulated constituent score. Non-positive boosts cannot preserve Top-N ordering.

type ConstantScorer

type ConstantScorer float64

func (ConstantScorer) Explain

func (c ConstantScorer) Explain(_ int, _ float64) *search.Explanation

func (ConstantScorer) ExplainComposite

func (c ConstantScorer) ExplainComposite(_ []*search.DocumentMatch) *search.Explanation

func (ConstantScorer) Score

func (c ConstantScorer) Score(_ int, _ float64) float64

func (ConstantScorer) ScoreComposite

func (c ConstantScorer) ScoreComposite(_ []*search.DocumentMatch) float64