Struct dogs::tree_search::decorators::stats::StatTsDecorator

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

stats decorator. Stores statistics data-structures and reference to the logger.

Implementations

impl<Space, B: Serialize + Copy + Display> StatTsDecorator<Space, B>

pub fn new(s: Space) -> Self

builds the decorator around a search space

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

binds to a logger (to display statistics in the console)

pub fn get_pareto_diagram(&self) -> Value

generates pareto diagram to visualize the search statistics

Trait Implementations

impl<Space: Debug, B: Debug> Debug for StatTsDecorator<Space, B>

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

Formats the value using the given formatter.

impl<N, G, Space, B> GuidedSpace<N, G> for StatTsDecorator<Space, B> where
    Space: GuidedSpace<N, G>,
    B: Serialize, 

fn guide(&mut self, node: &N) -> G

returns the guide value of the node

impl<N, B, Id, Space> Identifiable<N, Id> for StatTsDecorator<Space, B> where
    Space: Identifiable<N, Id>,
    B: Serialize, 

fn id(&self, n: &mut N) -> Id

returns the ID of the node

impl<N, Space, B> ParetoDominanceSpace<N> for StatTsDecorator<Space, B> where
    Space: ParetoDominanceSpace<N>,
    B: Serialize, 

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

returns true if a dominates b

impl<N, Space, B> PartialNeighborGeneration<N> for StatTsDecorator<Space, B> where
    Space: PartialNeighborGeneration<N>,
    B: Serialize, 

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

returns the next neighbor if it exists, or None

impl<N, Space, B> SearchSpace<N, B> for StatTsDecorator<Space, B> where
    Space: SearchSpace<N, B>,
    B: Clone + Serialize + Into<i64> + PartialOrd + Copy + Display, 

fn stop_search(&mut self, _msg: String)

adds factice point when the search stops

fn initial(&mut self) -> N

returns the initial (or root) node

fn bound(&mut self, node: &N) -> B

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

fn g_cost(&mut self, node: &N) -> 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 goal(&mut self, node: &N) -> bool

returns true if and only if the node is goal

fn restart(&mut self, msg: String)

called when the algorithm restarts

fn handle_new_best(&mut self, n: N) -> N

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

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

registers information about the search statistics in a json file

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 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> SearchSpaceDecorator<Space> for StatTsDecorator<Space, B>

fn unwrap(&self) -> &Space

gets the underlying search space

impl<N, Sol, Space, B> ToSolution<N, Sol> for StatTsDecorator<Space, B> where
    Space: ToSolution<N, Sol>,
    B: Serialize, 

fn solution(&mut self, node: &mut N) -> Sol

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

impl<N, Space, B> TotalNeighborGeneration<N> for StatTsDecorator<Space, B> where
    Space: TotalNeighborGeneration<N>,
    B: Serialize, 

fn neighbors(&mut self, node: &mut N) -> Vec<N>

returns all neighbors of a given node