Struct dogs::tree_search::decorators::bounding::BoundingDecorator

pub struct BoundingDecorator<Space, B, N> { /* fields omitted */ }

Registers the global dual bound

• when a node is destructed: remove its bound of the pq and update the global bound
• TODO when a node bound is updated: update the global bound

Implementations

impl<Space, B, N> BoundingDecorator<Space, B, N> where
    B: Ord + Display + Copy + Into<i64>, 

pub fn unwrap(&self) -> &Space

unwraps itself

pub fn new(s: Space) -> Self where
    B: Ord + Into<i64>, 

builds the decorator using the wrapped space

pub fn bind_logger(self, logger_ref: Weak<MetricLogger>) -> Self

binds the logger to display bound updates

Trait Implementations

impl<Space: Debug, B: Debug, N: Debug> Debug for BoundingDecorator<Space, B, N>

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

Formats the value using the given formatter.

impl<N, G, Space, B> GuidedSpace<LifetimeEventNode<N, B, BoundSet<B>>, G> for BoundingDecorator<Space, B, N> where
    Space: GuidedSpace<N, G>,
    B: Display + Ord + Copy + Into<i64>, 

fn guide(&mut self, n: &LifetimeEventNode<N, B, BoundSet<B>>) -> G

returns the guide value of the node

impl<N, B, Id, Space> Identifiable<LifetimeEventNode<N, B, BoundSet<B>>, Id> for BoundingDecorator<Space, B, N> where
    Space: Identifiable<N, Id>,
    B: Ord + Display + Copy + Into<i64>, 

fn id(&self, n: &mut LifetimeEventNode<N, B, BoundSet<B>>) -> Id

returns the ID of the node

impl<N, Space, B> ParetoDominanceSpace<N> for BoundingDecorator<Space, B, N> where
    Space: ParetoDominanceSpace<N>, 

fn dominates(&self, a: &N, b: &N) -> bool

returns true if a dominates b

impl<N, Space, B> PartialNeighborGeneration<LifetimeEventNode<N, B, BoundSet<B>>> for BoundingDecorator<Space, B, N> where
    Space: PartialNeighborGeneration<N> + SearchSpace<N, B>,
    B: Ord + Copy + Into<i64> + Display, 

fn next_neighbor(
    &mut self,
    node: &mut LifetimeEventNode<N, B, BoundSet<B>>
) -> Option<LifetimeEventNode<N, B, BoundSet<B>>>

returns the next neighbor if it exists, or None

impl<N, Space, B> SearchSpace<LifetimeEventNode<N, B, BoundSet<B>>, B> for BoundingDecorator<Space, B, N> where
    N: Clone,
    Space: SearchSpace<N, B>,
    B: Display + Ord + Copy + Into<i64> + Serialize, 

fn initial(&mut self) -> LifetimeEventNode<N, B, BoundSet<B>>

returns the initial (or root) node

fn bound(&mut self, n: &LifetimeEventNode<N, B, BoundSet<B>>) -> B

returns the bound value of the node (i.e. f-cost)

fn goal(&mut self, n: &LifetimeEventNode<N, B, BoundSet<B>>) -> bool

returns true if and only if the node is goal

fn g_cost(&mut self, n: &LifetimeEventNode<N, B, BoundSet<B>>) -> B

returns the g-cost of the node the h-cost can be computed by substracting the f-cost (SearchSpace.bound) by the g-cost

fn restart(&mut self, msg: String)

called when the algorithm restarts

fn handle_new_best(
    &mut self,
    n: LifetimeEventNode<N, B, BoundSet<B>>
) -> LifetimeEventNode<N, B, BoundSet<B>>

called when the algorithm finds a new-best-known solution

fn stop_search(&mut self, _msg: String)

called when the algorithm finishes

fn display_statistics(&self)

displays various statistics about the search (nb nodes, etc.) TODO: use export_statistics to get the statistics in the JSON format, and display them

fn json_statistics(&self, json: &mut Value)

registers information about the search statistics in a json file

fn start_search(&mut self, _msg: String)

called when the algorithm starts

fn request_log_header(&self, _res: Vec<String>)

requests log headers (does nothing if there is no logging decorator within the algorithm)

fn request_logging(&self, _res: Vec<String>)

requests a logging to appear (does nothing if there is no logging decorator within the algorithm)

impl<Space, B, N> SearchSpaceDecorator<Space> for BoundingDecorator<Space, B, N>

fn unwrap(&self) -> &Space

gets the underlying search space

impl<N, Sol, B, Space> ToSolution<LifetimeEventNode<N, B, BoundSet<B>>, Sol> for BoundingDecorator<Space, B, N> where
    Space: SearchSpace<N, B> + ToSolution<N, Sol>,
    B: Ord + Display + Copy + Into<i64>, 

fn solution(&mut self, n: &mut LifetimeEventNode<N, B, BoundSet<B>>) -> Sol

constructs a solution from a goal node panics if the node is not a goal

impl<N, B, Space> TotalNeighborGeneration<LifetimeEventNode<N, B, BoundSet<B>>> for BoundingDecorator<Space, B, N> where
    Space: TotalNeighborGeneration<N> + SearchSpace<N, B>,
    B: Ord + Display + Copy + Into<i64>, 

fn neighbors(
    &mut self,
    n: &mut LifetimeEventNode<N, B, BoundSet<B>>
) -> Vec<LifetimeEventNode<N, B, BoundSet<B>>>

returns all neighbors of a given node