psyche-utils 0.2.19

Utils module for Psyche AI Toolset
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

mod bucket_limit_rule;
mod closure_rule;
mod fixed_score_rule;
mod mul_rule;
mod sum_rule;

use crate::bucket_strainer::Bucket;
use crate::Scalar;
pub use bucket_limit_rule::*;
pub use closure_rule::*;
pub use fixed_score_rule::*;
pub use mul_rule::*;
pub use sum_rule::*;

/// Trait used to tell how much successfuly bucket has to get incoming item.
///
/// # Example
/// ```
/// use psyche_utils::bucket_strainer::{Bucket, Rule};
/// use psyche_utils::Scalar;
///
/// #[derive(Clone)]
/// struct SuccessRule;
///
/// impl<T> Rule<T> for SuccessRule
/// where
///     T: Clone,
/// {
///     fn score(&self, _: &T, _: &Bucket<T>) -> Scalar {
///         1.0
///     }
///
///     fn box_clone(&self) -> Box<dyn Rule<T>> {
///         Box::new((*self).clone())
///     }
/// }
/// ```
pub trait Rule<T>
where
    T: Clone,
{
    /// Score incoming item.
    ///
    /// # Arguments
    /// * `item` - Incoming item.
    /// * `bucket` - Bucket that tests incoming item.
    ///
    /// # Return
    /// Score for given item that tell how lucky it is to fall into given bucket.
    fn score(&self, item: &T, bucket: &Bucket<T>) -> Scalar;

    /// Create boxed clone for this rule.
    fn box_clone(&self) -> Box<dyn Rule<T>>;
}

impl<T> Clone for Box<Rule<T>>
where
    T: Clone,
{
    fn clone(&self) -> Box<Rule<T>> {
        self.box_clone()
    }
}