Struct RangeEfficiency 

pub struct RangeEfficiency { /* private fields */ }

Range Efficiency — ratio of net price displacement to the sum of all bar ranges over the last period bars.

net_move   = |close_now - close_N_ago|
total_range = sum(high_i - low_i) for i in last N bars
efficiency  = net_move / total_range

• Near 1.0: price moved consistently in one direction with tight, efficient bars.
• Near 0.0: lots of range used, little net movement — choppy, mean-reverting market.
• Compared to DirectionalEfficiency (which uses bar-to-bar returns), this uses raw bar ranges — it’s more sensitive to volatility.
• Returns SignalValue::Unavailable until period bars have been seen.
• Returns SignalValue::Unavailable if total range is zero.

Errors

Returns FinError::InvalidPeriod if period == 0.

Example

use fin_primitives::signals::indicators::RangeEfficiency;
use fin_primitives::signals::Signal;

let re = RangeEfficiency::new("re", 10).unwrap();
assert_eq!(re.period(), 10);

Implementations

impl RangeEfficiency

pub fn new(name: impl Into<String>, period: usize) -> Result<Self, FinError>

Constructs a new RangeEfficiency.

Errors

Returns FinError::InvalidPeriod if period == 0.

Trait Implementations

impl Signal for RangeEfficiency

fn name(&self) -> &str

Returns the name of this signal (unique within a pipeline).

fn period(&self) -> usize

Returns the number of bars required before the signal produces a value.

fn is_ready(&self) -> bool

Returns true if the signal has accumulated enough bars to produce a value.

fn update(&mut self, bar: &BarInput) -> Result<SignalValue, FinError>

Updates the signal with a BarInput and returns the current value.

fn reset(&mut self)

Resets the signal to its initial state as if no bars had been seen.

fn update_bar(&mut self, bar: &OhlcvBar) -> Result<SignalValue, FinError>

Convenience wrapper: converts bar to BarInput and calls Self::update.

fn warm_up(&mut self, bars: &[BarInput]) -> Result<SignalValue, FinError>

Feed a slice of historical bars to prime the indicator in one call.