Struct MFI

pub struct MFI { /* private fields */ }

Money Flow Index (MFI) Indicator

MFI is a momentum indicator that uses both price and volume to identify overbought or oversold conditions. It’s often called “Volume-weighted RSI”.

Formula:

1. Typical Price = (High + Low + Close) / 3
2. Raw Money Flow = Typical Price × Volume
3. Money Flow Direction: Positive if current TP > previous TP, else Negative
4. Money Ratio = (Positive Money Flow Sum) / (Negative Money Flow Sum)
5. MFI = 100 - (100 / (1 + Money Ratio))

Implementations

impl MFI

pub fn new() -> Self

Create a new MFI calculator with default configuration (period=14)

pub fn with_period(period: usize) -> Result<Self, MFIError>

Create a new MFI calculator with custom period

pub fn with_config(config: MFIConfig) -> Self

Create a new MFI calculator with custom configuration

pub fn calculate(&mut self, input: MFIInput) -> Result<MFIOutput, MFIError>

Calculate MFI for the given input

pub fn calculate_batch( &mut self, inputs: &[MFIInput], ) -> Result<Vec<MFIOutput>, MFIError>

Calculate MFI for a batch of inputs

pub fn reset(&mut self)

Reset the calculator state

pub fn get_state(&self) -> &MFIState

Get current state (for serialization/debugging)

pub fn set_state(&mut self, state: MFIState)

Restore state (for deserialization)

pub fn positive_money_flow(&self) -> f64

Get current positive money flow sum

pub fn negative_money_flow(&self) -> f64

Get current negative money flow sum

Trait Implementations

impl Default for MFI

fn default() -> Self

Returns the “default value” for a type.