Struct TopkRule 

pub struct TopkRule { /* private fields */ }

Top-k search: at each node, a pass only branches on the k + 1 best-ranked features. Relaxing the rule raises k, following its StepStrategy, up to limit.

Implementations

impl TopkRule

pub fn new(limit: usize, increment: Box<dyn StepStrategy>) -> Self

A rule whose k grows following increment, up to limit.

pub fn with_delay(self, delay: u8) -> Self

Sets the number of passes before the rule takes effect.

pub fn with_budget(self, budget: usize) -> Self

Sets k for the first pass.

Trait Implementations

impl Rule for TopkRule

fn evaluate(&self, context: &RuleContext) -> RuleResult

Decides whether the search continues below the node.

fn priority(&self) -> u8

Rules with a higher priority are evaluated first.

fn description(&self) -> String

A short human-readable name.

fn state(&self) -> RuleState

The current state of the rule.

fn is_active(&self) -> bool

Whether the rule is applied.

fn activate(&mut self)

Starts applying the rule; called before the first pass.

fn deactivate(&mut self)

Stops applying the rule.

fn relax(&mut self)

Widens the rule’s budget before the next pass, or deactivates it once the budget is at its limit.

fn is_relaxable(&self) -> bool

Whether the rule restricts the search only temporarily. A search whose pass was cut by a relaxable rule is not finished.

fn delay(&self) -> u8

Number of passes to wait before the rule takes effect.

fn as_any(&self) -> &dyn Any

Upcast used by RuleManager::get_rule_mut.

fn as_any_mut(&mut self) -> &mut dyn Any

Mutable upcast used by RuleManager::get_rule_mut.

fn reset(&mut self)

Resets any internal state, such as a timer.