Struct BarInput 

pub struct BarInput {
    pub close: Decimal,
    pub high: Decimal,
    pub low: Decimal,
    pub open: Decimal,
    pub volume: Decimal,
}

Thin input type for signal computation, decoupled from OhlcvBar.

Carrying all four price fields and volume allows future indicators (e.g. MACD on high-low, OBV on volume) without forcing a dependency on OhlcvBar.

Fields

close: Decimal

Closing price (used by most indicators).

high: Decimal

High price of the bar.

low: Decimal

Low price of the bar.

open: Decimal

Opening price of the bar.

volume: Decimal

Total traded volume during the bar.

Implementations

impl BarInput

pub fn new( close: Decimal, high: Decimal, low: Decimal, open: Decimal, volume: Decimal, ) -> Self

Constructs a BarInput with all fields explicitly specified.

pub fn from_close(close: Decimal) -> Self

Constructs a BarInput from a single close price, setting all OHLC fields to close and volume to zero. Useful in tests and for close-only indicators (SMA/EMA/RSI).

pub fn typical_price(&self) -> Decimal

Returns the typical price of this bar: (high + low + close) / 3.

pub fn weighted_close(&self) -> Decimal

Returns the weighted close price: (high + low + close + close) / 4.

Weights the close twice, giving it extra significance compared to the typical price. Used by some indicators (e.g. CCI variants) and charting systems as a price reference.

pub fn range(&self) -> Decimal

Returns the price range: high - low.

pub fn midpoint(&self) -> Decimal

Returns the midpoint of the bar: (high + low) / 2.

pub fn close_location_value(&self) -> Decimal

Close Location Value: ((close - low) - (high - close)) / (high - low).

Ranges from -1.0 (close at low) to +1.0 (close at high). Returns zero when the range is zero (doji / flat bar).

pub fn net_move(&self) -> Decimal

Returns the signed intrabar move: close - open.

Positive for bullish bars, negative for bearish, zero for doji. Unlike body_size, this preserves direction.

pub fn body_size(&self) -> Decimal

Returns the absolute body size: |close - open|.

pub fn body_high(&self) -> Decimal

Returns the higher of open and close: max(open, close).

pub fn body_low(&self) -> Decimal

Returns the lower of open and close: min(open, close).

pub fn upper_wick(&self) -> Decimal

Returns the upper wick length: high - max(open, close).

pub fn lower_wick(&self) -> Decimal

Returns the lower wick length: min(open, close) - low.

pub fn is_bullish(&self) -> bool

Returns true if the bar closed higher than it opened (bullish candle).

pub fn is_bearish(&self) -> bool

Returns true if the bar closed lower than it opened (bearish candle).

pub fn price_change(&self, prev_close: Option<Decimal>) -> Decimal

Returns the close-to-close price change: close - prev_close.

When prev_close is None (first bar), returns Decimal::ZERO.

pub fn log_return(&self, prev_close: Option<Decimal>) -> Option<Decimal>

Returns the log return: ln(close / prev_close) via f64.

Returns None when prev_close is None, zero, or negative, or when the f64 conversion fails.

pub fn true_range(&self, prev_close: Option<Decimal>) -> Decimal

Returns the True Range of this bar given the previous bar’s close.

TR = max(high - low, |high - prev_close|, |low - prev_close|)

When there is no previous close (first bar), high - low is used as the true range.

Trait Implementations

impl Clone for BarInput

fn clone(&self) -> BarInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BarInput

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

Formats the value using the given formatter.

impl From<&OhlcvBar> for BarInput

fn from(bar: &OhlcvBar) -> Self

Converts to this type from the input type.

impl Copy for BarInput