Struct AssociationRule 

pub struct AssociationRule { /* private fields */ }

An association rule antecedent ⇒ consequent with its standard metrics.

Both sides are disjoint, non-empty sets of item indices in ascending order. The metrics follow the standard market-basket definitions (and mlxtend’s): support is the joint support of antecedent ∪ consequent; confidence is support(A ∪ C) / support(A); lift is confidence / support(C); leverage is support(A ∪ C) − support(A)·support(C); conviction is (1 − support(C)) / (1 − confidence) (+∞ for a perfectly-confident rule).

Implementations

impl AssociationRule

pub fn antecedent(&self) -> &[usize]

The antecedent item indices, in ascending order.

pub fn consequent(&self) -> &[usize]

The consequent item indices, in ascending order.

pub const fn support(&self) -> f64

The joint support of the rule’s item union, in [0, 1].

pub const fn confidence(&self) -> f64

The confidence support(A ∪ C) / support(A), in [0, 1].

pub const fn lift(&self) -> f64

The lift confidence / support(C).

pub const fn leverage(&self) -> f64

The leverage support(A ∪ C) − support(A)·support(C).

pub const fn conviction(&self) -> f64

The conviction (1 − support(C)) / (1 − confidence) (+∞ if confidence == 1).

Trait Implementations

impl Clone for AssociationRule

fn clone(&self) -> AssociationRule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AssociationRule

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

Formats the value using the given formatter.

impl PartialEq for AssociationRule

fn eq(&self, other: &AssociationRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AssociationRule