Skip to main content

ThreeLineBreakBars

Struct ThreeLineBreakBars 

Source
pub struct ThreeLineBreakBars { /* private fields */ }
Expand description

Three-Line-Break bar builder using the classic close-based reversal rule.

A line-break chart draws a new line in the trend direction whenever the close makes a new extreme, and only reverses when the close breaks the extreme of the previous lines lines (three by default — hence “three-line break”). This filters minor noise: a pullback that fails to exceed the last three lines is ignored entirely, so the chart isolates meaningful reversals.

This is the bar-builder counterpart of the ThreeLineBreak indicator: the indicator reports the current line state as a streaming value, whereas this builder emits each completed line as a LineBreakBar so you can reconstruct the full line-break chart. At most one line forms per candle, so BarBuilder::update returns either an empty vector or a single bar.

Construction rules:

  • The first candle seeds a reference close and prints nothing.
  • The first subsequent move (up or down) draws the first line.
  • In an up-trend a close above the last line’s top extends it (a new up line); a close below the lowest low of the last lines lines reverses to a down line. The down-trend is symmetric.

§Example

use wickra_core::{BarBuilder, Candle, ThreeLineBreakBars};

let flat = |price: f64| Candle::new(price, price, price, price, 1.0, 0).unwrap();
let mut bars = ThreeLineBreakBars::new(3).unwrap();
bars.update(flat(10.0));           // seed
let first = bars.update(flat(11.0)); // first up line
assert_eq!(first.len(), 1);
assert_eq!(first[0].direction, 1);

Implementations§

Source§

impl ThreeLineBreakBars

Source

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

Construct a line-break builder that reverses on a break of the last lines lines (3 for the classic three-line break).

§Errors

Returns Error::PeriodZero if lines == 0.

Source

pub const fn lines(&self) -> usize

Configured number of lines a reversal must break.

Source

pub fn tracked(&self) -> usize

Number of recent lines currently tracked for the reversal test.

Trait Implementations§

Source§

impl BarBuilder for ThreeLineBreakBars

Source§

type Bar = LineBreakBar

Type of one completed bar.
Source§

fn update(&mut self, candle: Candle) -> Vec<LineBreakBar>

Feed one candle and return every bar completed on it (possibly none).
Source§

fn reset(&mut self)

Reset all internal state to the freshly-constructed configuration.
Source§

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

Stable, human-readable builder name.
Source§

fn batch(&mut self, candles: &[Candle]) -> Vec<Self::Bar>

Replay update over a slice, concatenating all completed bars. The result length is data-dependent (not the input length).
Source§

impl Clone for ThreeLineBreakBars

Source§

fn clone(&self) -> ThreeLineBreakBars

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ThreeLineBreakBars

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.