Struct ThreeLineBreak 

pub struct ThreeLineBreak { /* private fields */ }

Three Line Break — the trend direction of a line-break (“kakushi”) chart, where a reversal requires the close to break the extreme of the last lines lines.

continue the trend when close exceeds the prior line's end
reverse the trend when close breaks beyond the extreme of the last `lines` lines
output = current line direction: +1 (up), −1 (down)

A line-break chart ignores time and small moves entirely: it draws a new line only when the close makes a new extreme in the trend, and flips direction only when the close reverses past the high (or low) of the last lines lines — classically three. This filters out minor pullbacks, so the emitted direction stays in a trend until a genuinely significant reversal. Distinct from the candlestick ThreeLineStrike (a fixed four-bar pattern); this is the line-break chart type reduced to its trend state. See also the alt-chart “Three-Line-Break Bars” builder.

The output is +1.0 / −1.0. The first bar seeds the reference price; the direction is emitted once the first line is drawn (data-dependent; warmup_period returns the minimum 2). Each update is O(lines).

Example

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

let mut indicator = ThreeLineBreak::new(3).unwrap();
let mut last = None;
for i in 0..20 {
    let close = 100.0 + f64::from(i);
    let c = Candle::new(close, close, close, close, 1_000.0, 0).unwrap();
    last = indicator.update(c);
}
assert_eq!(last, Some(1.0));

Implementations

impl ThreeLineBreak

pub fn new(lines: usize) -> Result<Self>

Construct a Three Line Break requiring lines lines to reverse (classic 3).

Errors

Returns Error::PeriodZero if lines == 0.

pub const fn lines(&self) -> usize

Configured number of lines required to reverse.

pub const fn value(&self) -> Option<f64>

Current direction if available.

Trait Implementations

impl Clone for ThreeLineBreak

fn clone(&self) -> ThreeLineBreak

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreeLineBreak

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

Formats the value using the given formatter.

impl Indicator for ThreeLineBreak

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.