Skip to main content

Chain

Struct Chain 

Source
pub struct Chain<A, B>
where A: Indicator<Input = f64, Output = f64>, B: Indicator<Input = f64>,
{ /* private fields */ }
Expand description

Chain two indicators so the output of the first becomes the input of the second.

Both indicators must agree on f64 as the bridging type, which is the common case for price-in/value-out indicators. The chain itself is an indicator, so chains can be nested arbitrarily.

§Example

use wickra_core::{Chain, Ema, Indicator, Rsi};

// RSI(7) on top of EMA(14). EMA seeds at input 14, then RSI needs 7+1 more
// valid inputs to emit, so the chain becomes ready at input 21.
let mut chain = Chain::new(Ema::new(14).unwrap(), Rsi::new(7).unwrap());
for i in 1..=21 {
    chain.update(f64::from(i));
}
assert!(chain.is_ready());

Implementations§

Source§

impl<A, B> Chain<A, B>
where A: Indicator<Input = f64, Output = f64>, B: Indicator<Input = f64>,

Source

pub const fn new(first: A, second: B) -> Self

Construct a chain whose inputs flow through first and then second.

Source

pub fn then<C>(self, third: C) -> Chain<Self, C>
where C: Indicator<Input = f64>, Self: Indicator<Input = f64, Output = f64>,

Add a third stage on top.

Source

pub const fn first(&self) -> &A

Borrow the upstream indicator.

Source

pub const fn second(&self) -> &B

Borrow the downstream indicator.

Trait Implementations§

Source§

impl<A, B> Clone for Chain<A, B>
where A: Indicator<Input = f64, Output = f64> + Clone, B: Indicator<Input = f64> + Clone,

Source§

fn clone(&self) -> Chain<A, B>

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<A, B> Debug for Chain<A, B>
where A: Indicator<Input = f64, Output = f64> + Debug, B: Indicator<Input = f64> + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<A, B> Indicator for Chain<A, B>
where A: Indicator<Input = f64, Output = f64>, B: Indicator<Input = f64>,

Source§

type Input = f64

Type of one input data point (typically f64 for a price, or Candle / Tick).
Source§

type Output = <B as Indicator>::Output

Type of one output value.
Source§

fn update(&mut self, input: f64) -> Option<Self::Output>

Feed one new data point into the indicator and return the freshly computed output, or None if the indicator is still warming up.
Source§

fn reset(&mut self)

Reset all internal state, leaving the indicator equivalent to a freshly constructed instance with the same parameters.
Source§

fn warmup_period(&self) -> usize

Number of inputs required before the first non-None output can be produced.
Source§

fn is_ready(&self) -> bool

Whether the indicator has emitted at least one value since the last reset.
Source§

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

Stable, human-readable indicator name. Used by chaining and diagnostics.

Auto Trait Implementations§

§

impl<A, B> Freeze for Chain<A, B>
where A: Freeze, B: Freeze,

§

impl<A, B> RefUnwindSafe for Chain<A, B>

§

impl<A, B> Send for Chain<A, B>
where A: Send, B: Send,

§

impl<A, B> Sync for Chain<A, B>
where A: Sync, B: Sync,

§

impl<A, B> Unpin for Chain<A, B>
where A: Unpin, B: Unpin,

§

impl<A, B> UnsafeUnpin for Chain<A, B>
where A: UnsafeUnpin, B: UnsafeUnpin,

§

impl<A, B> UnwindSafe for Chain<A, B>
where A: UnwindSafe, B: UnwindSafe,

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> BatchExt for T
where T: Indicator,

Source§

fn batch(&mut self, inputs: &[Self::Input]) -> Vec<Option<Self::Output>>
where Self::Input: Clone,

Run the indicator over a slice of inputs in order, returning one output (or None during warmup) per input.
Source§

fn batch_parallel<F>( inputs_per_asset: &[Vec<Self::Input>], make: F, ) -> Vec<Vec<Option<Self::Output>>>
where Self: Sized + Send, Self::Input: Sync + Clone, Self::Output: Send, F: Fn() -> Self + Sync + Send,

Available on crate feature parallel only.
Run an independent copy of the indicator over each input series in parallel. 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.