Struct LongLine 

pub struct LongLine { /* private fields */ }

Long Line — a single candle whose range is longer than the recent average and whose body dominates that range (a solid directional bar). Because “long” only has meaning relative to recent activity, the detector compares each candle’s range against a rolling average of the previous period ranges.

avg = mean range of the previous `period` candles
long line = range > avg  AND  |close − open| >= 0.5 * range
white -> +1.0,  black -> −1.0

Output is +1.0 (long white line), −1.0 (long black line), or 0.0 otherwise. The first period candles return 0.0 while the rolling average fills. period defaults to 5 and must be at least 1. This rolling baseline is the one place the family departs from a purely intra-candle rule, since a short/long classification is inherently scale-relative. Pattern-shape check only — no trend filter is applied; combine with a trend indicator for actionable signals.

Signed ±1 encoding

This detector emits the uniform candlestick sign convention shared across the pattern family — +1.0 bullish, −1.0 bearish, 0.0 no pattern — so it drops straight into a machine-learning feature matrix as a single dimension.

Example

use wickra_core::{Candle, Indicator, LongLine};

let mut indicator = LongLine::new();
// Five quiet bars fill the rolling average.
for ts in 0..5 {
    indicator.update(Candle::new(10.0, 10.5, 9.5, 10.2, 1.0, ts).unwrap());
}
// A wide solid white bar is a long white line.
let out = indicator
    .update(Candle::new(10.0, 13.0, 9.9, 12.9, 1.0, 5).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl LongLine

pub const fn new() -> Self

Construct a Long Line detector with the default 5-candle rolling average.

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

Construct a Long Line detector with a custom averaging period.

period must be at least 1.

pub fn period(&self) -> usize

Configured averaging period.

Trait Implementations

impl Clone for LongLine

fn clone(&self) -> LongLine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LongLine

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

Formats the value using the given formatter.

impl Default for LongLine

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for LongLine

type Input = Candle

Type of one input data point (typically f64 for a price, or Candle / Tick).

type Output = f64

Type of one output value.

fn update(&mut self, candle: Candle) -> Option<f64>

Feed one new data point into the indicator and return the freshly computed output, or None if the indicator is still warming up.

fn reset(&mut self)

Reset all internal state, leaving the indicator equivalent to a freshly constructed instance with the same parameters.

fn warmup_period(&self) -> usize

Number of inputs required before the first non-None output can be produced.

fn is_ready(&self) -> bool

Whether the indicator has emitted at least one value since the last reset.

fn name(&self) -> &'static str

Stable, human-readable indicator name. Used by chaining and diagnostics.