Skip to main content

RunBars

Struct RunBars 

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

Run bar builder — a simplified form of López de Prado’s run bars.

A run is an uninterrupted sequence of same-signed ticks: a streak of up-ticks (a buy run) or down-ticks (a sell run), with unchanged closes extending the current run. This builder counts the current run’s length and closes a bar when it reaches run_length; a tick in the opposite direction restarts the run from one. Where ImbalanceBars sample on the net signed imbalance (which oscillating flow can cancel back to zero), run bars sample on persistence: they fire only when the market pushes the same way without interruption, making them a cleaner sequential-trend detector.

Simplification. The full method estimates a dynamic expected run length from an EWMA and can weight runs by volume or traded value. This builder uses a fixed run-length threshold on unweighted ticks. See López de Prado (2018), ch. 2, for the adaptive estimator and weighted variants.

At most one bar closes per candle, so BarBuilder::update returns either an empty vector or a single RunBar.

§Example

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

let flat = |price: f64| Candle::new(price, price, price, price, 1.0, 0).unwrap();
let mut bars = RunBars::new(3).unwrap();
bars.update(flat(10.0));            // seed
bars.update(flat(11.0));            // run 1
bars.update(flat(12.0));            // run 2
let out = bars.update(flat(13.0));  // run 3 -> close
assert_eq!(out.len(), 1);
assert_eq!(out[0].direction, 1);

Implementations§

Source§

impl RunBars

Source

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

Construct a run-bar builder that closes a bar on a run of run_length ticks.

§Errors

Returns Error::PeriodZero if run_length == 0.

Source

pub const fn run_length(&self) -> usize

Configured run length that closes a bar.

Source

pub const fn run(&self) -> usize

Length of the in-progress run.

Trait Implementations§

Source§

impl BarBuilder for RunBars

Source§

type Bar = RunBar

Type of one completed bar.
Source§

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

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 RunBars

Source§

fn clone(&self) -> RunBars

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 RunBars

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.