RuleMiner

Struct RuleMiner 

Source
pub struct RuleMiner { /* private fields */ }
Expand description

Main rule mining engine

Implementations§

Source§

impl RuleMiner

Source

pub fn new(config: MiningConfig) -> Self

Create new rule miner with config

Source

pub fn add_transactions(&mut self, transactions: Vec<Transaction>) -> Result<()>

Add transactions to mine

Source

pub fn add_transaction(&mut self, transaction: Transaction) -> Result<()>

Add transactions from an iterator (streaming support)

This method allows adding transactions one-by-one from a stream, maintaining constant memory usage for the loading phase.

§Example
use rust_rule_miner::{RuleMiner, MiningConfig, data_loader::DataLoader, Transaction};
use chrono::Utc;

let mut miner = RuleMiner::new(MiningConfig::default());

// Add transactions one by one
let transaction = Transaction::new("tx1".to_string(), vec!["A".to_string()], Utc::now());
miner.add_transaction(transaction)?;

let rules = miner.mine_association_rules()?;
Source

pub fn add_transactions_from_iter<I>(&mut self, iter: I) -> Result<()>
where I: Iterator<Item = Result<Transaction>>,

Add transactions from an iterator (batch streaming)

More efficient than add_transaction() when you have an iterator.

§Example
use rust_rule_miner::{RuleMiner, MiningConfig, data_loader::{DataLoader, ColumnMapping}};

let mut miner = RuleMiner::new(MiningConfig::default());

// Load from CSV and add to miner
let mapping = ColumnMapping::simple(0, 1, 2);
let transactions = DataLoader::from_csv("file.csv", mapping)?;
miner.add_transactions_from_iter(transactions.into_iter().map(Ok))?;

let rules = miner.mine_association_rules()?;
Source

pub fn transaction_count(&self) -> usize

Get transaction count

Source

pub fn mine_association_rules(&mut self) -> Result<Vec<AssociationRule>>

Mine association rules using configured algorithm

Source

pub fn stats(&self) -> &MiningStats

Get mining statistics

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more