Trait SearchLogger

pub trait SearchLogger<Q: RankingRuleQueryTrait> {
    // Required methods
    fn initial_query(&mut self, _query: &Q);
    fn initial_universe(&mut self, _universe: &RoaringBitmap);
    fn query_for_initial_universe(&mut self, _query: &Q);
    fn ranking_rules(&mut self, _rr: &[Box<dyn RankingRule<'_, Q> + '_>]);
    fn add_to_results(&mut self, _docids: &[u32]);
    fn log_internal_state(&mut self, _rr: &dyn Any);

    // Provided methods
    fn start_iteration_ranking_rule(
        &mut self,
        _ranking_rule_idx: usize,
        _ranking_rule: &dyn RankingRule<'_, Q>,
        _query: &Q,
        _universe: &RoaringBitmap,
    ) { ... }
    fn next_bucket_ranking_rule(
        &mut self,
        _ranking_rule_idx: usize,
        _ranking_rule: &dyn RankingRule<'_, Q>,
        _universe: &RoaringBitmap,
        _candidates: &RoaringBitmap,
    ) { ... }
    fn skip_bucket_ranking_rule(
        &mut self,
        _ranking_rule_idx: usize,
        _ranking_rule: &dyn RankingRule<'_, Q>,
        _candidates: &RoaringBitmap,
    ) { ... }
    fn end_iteration_ranking_rule(
        &mut self,
        _ranking_rule_idx: usize,
        _ranking_rule: &dyn RankingRule<'_, Q>,
        _universe: &RoaringBitmap,
    ) { ... }
}

Trait for structure logging the execution of a search query.

Required Methods

fn initial_query(&mut self, _query: &Q)

Logs the initial query

fn initial_universe(&mut self, _universe: &RoaringBitmap)

Logs the value of the initial set of all candidates

fn query_for_initial_universe(&mut self, _query: &Q)

Logs the query that was used to compute the set of all candidates

fn ranking_rules(&mut self, _rr: &[Box<dyn RankingRule<'_, Q> + '_>])

Logs the ranking rules used to perform the search query

fn add_to_results(&mut self, _docids: &[u32])

Logs the addition of document ids to the final results

fn log_internal_state(&mut self, _rr: &dyn Any)

Logs an internal state in the search algorithms

Provided Methods

fn start_iteration_ranking_rule( &mut self, _ranking_rule_idx: usize, _ranking_rule: &dyn RankingRule<'_, Q>, _query: &Q, _universe: &RoaringBitmap, )

Logs the start of a ranking rule’s iteration.

fn next_bucket_ranking_rule( &mut self, _ranking_rule_idx: usize, _ranking_rule: &dyn RankingRule<'_, Q>, _universe: &RoaringBitmap, _candidates: &RoaringBitmap, )

Logs the end of the computation of a ranking rule bucket

fn skip_bucket_ranking_rule( &mut self, _ranking_rule_idx: usize, _ranking_rule: &dyn RankingRule<'_, Q>, _candidates: &RoaringBitmap, )

Logs the skipping of a ranking rule bucket

fn end_iteration_ranking_rule( &mut self, _ranking_rule_idx: usize, _ranking_rule: &dyn RankingRule<'_, Q>, _universe: &RoaringBitmap, )

Logs the end of a ranking rule’s iteration.

Implementors

impl<Q: RankingRuleQueryTrait> SearchLogger<Q> for DefaultSearchLogger