core/org.gnit.lucenekmp.search/PhraseMatcher

PhraseMatcher

Base class for exact and sloppy phrase matching

To find matches on a document, first advance .approximation to the relevant document, then call .reset. Clients can then call .nextMatch to iterate over the matches

Inheritors

ExactPhraseMatcher

SloppyPhraseMatcher

Properties

matchCost

val matchCost: Float

An estimate of the average cost of finding all matches on a document

Functions

approximation

abstract fun approximation(): DocIdSetIterator

Approximation that only matches documents that have all terms.

endOffset

abstract fun endOffset(): Int

The end offset of the current match

endPosition

abstract fun endPosition(): Int

The end position of the current match

impactsApproximation

abstract fun impactsApproximation(): ImpactsDISI

Approximation that is aware of impacts.

maxFreq

abstract fun maxFreq(): Float

An upper bound on the number of possible matches on this document

nextMatch

abstract fun nextMatch(): Boolean

Find the next match on the current document, returning false if there are none.

reset

abstract fun reset()

Called after .approximation has been advanced

sloppyWeight

abstract fun sloppyWeight(): Float

The slop-adjusted weight of the current match

startOffset

abstract fun startOffset(): Int

The start offset of the current match

startPosition

abstract fun startPosition(): Int

The start position of the current match