Skip to main content

IndicatorRegistry

Struct IndicatorRegistry 

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

A registry that owns a collection of Indicator trait objects and provides batch operations (calculate all, clear, etc.).

Use the registry when you want to manage multiple indicators as a group and recalculate them together whenever the underlying bar data changes.

§Example

use egui_charts::studies::{IndicatorRegistry, SMA, EMA};

let mut registry = IndicatorRegistry::new();
registry.add(Box::new(SMA::new(20)));
registry.add(Box::new(EMA::new(50)));
registry.calculate_all(&bars);

for indicator in registry.indicators() {
    println!("{}: {} values", indicator.name(), indicator.values().len());
}

Implementations§

Source§

impl IndicatorRegistry

Source

pub fn new() -> Self

Create an empty registry with no indicators.

Source

pub fn add_indicator(&mut self, indicator: Box<dyn Indicator>)

Append a boxed indicator to the registry.

Source

pub fn add(&mut self, indicator: Box<dyn Indicator>)

Alias for add_indicator for brevity.

Source

pub fn remove_indicator(&mut self, index: usize) -> Option<Box<dyn Indicator>>

Remove and return the indicator at index, or None if out of bounds.

Source

pub fn indicators(&self) -> &[Box<dyn Indicator>]

Return a shared slice of all registered indicators.

Source

pub fn indicators_mut(&mut self) -> &mut [Box<dyn Indicator>]

Return a mutable slice of all registered indicators.

Source

pub fn calculate_all(&mut self, data: &[Bar])

Recalculate every indicator against the provided bar data.

This iterates through all registered indicators and calls Indicator::calculate on each one.

Source

pub fn update_all(&mut self, data: &[Bar], from: usize)

Bring every indicator up to date after data[from..] changed or grew, given that data[..from] is unchanged since the previous call.

Calls Indicator::update on each one; studies that are not incremental recompute in full.

Source

pub fn clear(&mut self)

Remove all indicators from the registry.

Trait Implementations§

Source§

impl Default for IndicatorRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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.