Skip to main content

Wma

Struct Wma 

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

Weighted Moving Average with linear weights 1, 2, ..., period.

Output is sum(weight_i * price_i) / sum(weights). Maintained incrementally in O(1) by keeping the rolling sum of values and the rolling weighted sum.

Both running sums are recomputed exactly from the live window every 16 · period steady-state updates, the same bound the SMA puts on drift. Without it the weighted sum — updated as W − S + period · x, a difference of quantities period times larger than the result — lost about 6e-10 of relative accuracy over 500 000 updates of a price series.

§Example

use wickra_core::{Indicator, Wma};

let mut indicator = Wma::new(3).unwrap();
let mut last = None;
for i in 0..80 {
    last = indicator.update(100.0 + f64::from(i));
}
assert!(last.is_some());

Implementations§

Source§

impl Wma

Source

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

Construct a new WMA with the given window length.

§Errors

Returns Error::PeriodZero if period == 0.

Source

pub const fn period(&self) -> usize

Configured period.

Source

pub fn value(&self) -> Option<f64>

Current value if available.

Trait Implementations§

Source§

impl Clone for Wma

Source§

fn clone(&self) -> Self

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 Wma

Source§

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

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

impl Indicator for Wma

Source§

fn batch_nan_into(&mut self, inputs: &[f64], out: &mut [f64])

The exact batch with the window sums, cursor and reseed count in locals: update’s operations in update’s order – the same bits, the same reseed cadence – held in registers rather than written back through self for every input, which made the replay three times slower than streaming at long periods. The warmup still goes through update.

Source§

fn batch_fast_into(&mut self, inputs: &[f64], out: &mut [f64])

SIMD kernel: rolling sums and the weighted-numerator recurrence N = N − S + period · x as prefix scans, re-anchored on exact window values every 16 · period inputs, scaled by 1 / Σ weights. Agrees with the exact batch to within a few units in the last place; warmup NaNs and length are identical. Afterwards the window is rebuilt exactly from the last period inputs.

Source§

type Input = f64

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

type Output = f64

Type of one output value.
Source§

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

Feed one new data point into the indicator and return the freshly computed output, or None if there is no value for this input. Read more
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 Freeze for Wma

§

impl RefUnwindSafe for Wma

§

impl Send for Wma

§

impl Sync for Wma

§

impl Unpin for Wma

§

impl UnsafeUnpin for Wma

§

impl UnwindSafe for Wma

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> BatchNanExt for T
where T: Indicator<Input = f64, Output = f64>,

Source§

fn batch_nan(&mut self, inputs: &[f64]) -> Vec<f64>

One f64 per input, warmup positions filled with NaN, bit-for-bit equal to replaying update.
Source§

fn batch_fast(&mut self, inputs: &[f64]) -> Vec<f64>

The opt-in fast batch (Indicator::batch_fast_into) into a fresh vector: within the indicator’s documented tolerance of batch_nan, deterministic across platforms.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.