Struct SparseTermQuery 

pub struct SparseTermQuery {
    pub field: Field,
    pub dim_id: u32,
    pub weight: f32,
    pub heap_factor: f32,
    pub combiner: MultiValueCombiner,
    pub over_fetch_factor: f32,
}

Query for a single sparse vector dimension.

Analogous to TermQuery for text: searches one dimension’s posting list with a given weight. Multiple SparseTermQuery instances are combined as BooleanQuery SHOULD clauses to form a full sparse vector search.

Fields

field: Field

dim_id: u32

weight: f32

heap_factor: f32

MaxScore heap factor (1.0 = exact, lower = approximate)

combiner: MultiValueCombiner

Multi-value combiner for ordinal deduplication

over_fetch_factor: f32

Multiplier on executor limit to compensate for ordinal deduplication

Implementations

impl SparseTermQuery

pub fn new(field: Field, dim_id: u32, weight: f32) -> Self

pub fn with_heap_factor(self, heap_factor: f32) -> Self

pub fn with_combiner(self, combiner: MultiValueCombiner) -> Self

pub fn with_over_fetch_factor(self, factor: f32) -> Self

Trait Implementations

impl Clone for SparseTermQuery

fn clone(&self) -> SparseTermQuery

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SparseTermQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SparseTermQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Query for SparseTermQuery

fn scorer<'a>( &self, reader: &'a SegmentReader, _limit: usize, ) -> ScorerFuture<'a>

Create a scorer for this query against a single segment (async)

fn scorer_sync<'a>( &self, reader: &'a SegmentReader, _limit: usize, ) -> Result<Box<dyn Scorer + 'a>>

Create a scorer synchronously (mmap/RAM only).

fn count_estimate<'a>(&self, reader: &'a SegmentReader) -> CountFuture<'a>

Estimated number of matching documents in a segment (async)

fn as_sparse_term_query_info(&self) -> Option<SparseTermQueryInfo>

Return sparse term info if this is a single-dimension sparse query eligible for MaxScore optimization

fn as_sparse_term_queries(&self) -> Option<Vec<SparseTermQueryInfo>>

Decompose into sparse term query infos for MaxScore optimization.

fn as_term_query_info(&self) -> Option<TermQueryInfo>

Return term info if this is a simple term query eligible for MaxScore optimization

fn is_filter(&self) -> bool

True if this query is a pure filter (always scores 1.0, no positions). Used by the planner to convert non-selective MUST filters into predicates.

fn as_doc_predicate<'a>( &self, _reader: &'a SegmentReader, ) -> Option<DocPredicate<'a>>

For filter queries: return a cheap per-doc predicate against a segment. The predicate does O(1) work per doc (e.g., fast-field lookup).