Struct ShortLine 

pub struct ShortLine { /* private fields */ }

Short Line — a single candle whose range is shorter than the recent average while its body still dominates that (small) range: a compact directional bar. As with LongLine, “short” only has meaning relative to recent activity, so the detector compares each candle’s range against a rolling average of the previous period ranges.

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

Output is +1.0 (short white line), −1.0 (short 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. 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, ShortLine};

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

Implementations

impl ShortLine

pub const fn new() -> Self

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

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

Construct a Short 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 ShortLine

fn clone(&self) -> ShortLine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShortLine

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

Formats the value using the given formatter.

impl Default for ShortLine

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for ShortLine

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.