Skip to main content

VolumeSignalIndicator

Struct VolumeSignalIndicator 

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

Volume anomaly indicator.

Classifies each candle’s volume relative to a rolling mean of the prior lookback candles. Returns None until sufficient history is available.

Implements ClassificationIndicator<VolumeSignal>.

Implementations§

Source§

impl VolumeSignalIndicator

Source

pub fn new(config: VolSignalConfig) -> Result<Self, IndicatorError>

Create a new VolumeSignal indicator.

§Errors

Returns InvalidParameter if lookback is 0 or elevated_threshold is not positive.

Source

pub fn compute( &self, candles: &[Candle], ) -> Result<Vec<Option<VolumeSignal>>, IndicatorError>

Convenience wrapper — delegates to the ClassificationIndicator trait impl.

Callers that hold a concrete VolumeSignalIndicator can call .compute() without importing the trait.

Trait Implementations§

Source§

impl ClassificationIndicator<VolumeSignal> for VolumeSignalIndicator

Source§

fn lookback(&self) -> usize

Number of prior candles consumed before first Some result is emitted.
Source§

fn compute( &self, candles: &[Candle], ) -> Result<Vec<Option<VolumeSignal>>, IndicatorError>

Classify each candle. Returns one Option<T> per input candle.

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> 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, 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.