Skip to main content

Jma

Struct Jma 

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

Mark Jurik’s adaptive moving average. The original algorithm is proprietary and Jurik Research has never published the full source. This implementation follows the widely-used three-stage filter reconstruction circulated since the 1999 TASC article on the indicator — the same form used by most open-source ports (TradingView Pine, pandas-ta, various MQL ports):

beta        = 0.45 * (period - 1) / (0.45 * (period - 1) + 2)
alpha       = beta ^ power
phase_ratio = clamp(phase / 100 + 1.5, 0.5, 2.5)

e0_t = (1 - alpha) * x_t + alpha * e0_{t-1}
e1_t = (x_t - e0_t) * (1 - beta) + beta * e1_{t-1}
e2_t = (e0_t + phase_ratio * e1_t - JMA_{t-1}) * (1 - alpha)^2 + alpha^2 * e2_{t-1}
JMA_t = JMA_{t-1} + e2_t

The state is seeded by setting e0 = JMA = first input, so a constant input stream is reproduced exactly from the first output onward.

§Parameters

  • period: smoothing length (default 14).
  • phase: phase shift in [-100, 100]. Values outside this range are clamped to the boundary phase_ratio so the constructor never fails on a finite phase.
  • power: kernel exponent in 1..=4 (default 2 matches the popular reconstruction).

§Example

use wickra_core::{Indicator, Jma};

let mut jma = Jma::new(14, 0.0, 2).unwrap();
let mut last = None;
for i in 0..40 {
    last = jma.update(100.0 + f64::from(i));
}
assert!(last.is_some());

Implementations§

Source§

impl Jma

Source

pub fn new(period: usize, phase: f64, power: u32) -> Result<Self>

§Errors
Source

pub fn classic() -> Self

Construct JMA with the popular defaults (period = 14, phase = 0, power = 2).

Source

pub const fn params(&self) -> (usize, f64, u32)

Configured (period, phase, power).

Trait Implementations§

Source§

impl Clone for Jma

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 Jma

Source§

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

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

impl Indicator for Jma

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.
Source§

fn batch_nan_into(&mut self, inputs: &[Self::Input], out: &mut [f64])
where Self::Input: Copy, Self::Output: Into<f64>,

Run the indicator over inputs, writing one output per input into the caller-owned out buffer (NaN where update returns None). It exists for every indicator whose output converts to an f64; the batch pipelines use it for the scalar f64 -> f64 ones. Read more
Source§

fn batch_fast_into(&mut self, inputs: &[Self::Input], out: &mut [f64])
where Self::Input: Copy, Self::Output: Into<f64>,

Opt-in fast batch: like batch_nan_into, but an indicator with a vectorised kernel may reassociate its arithmetic to run it in SIMD lanes. Each value then agrees with the exact batch to within the tolerance the indicator documents (a few units in the last place), not bit for bit; warmup positions, NaN placement and the output length are identical. The kernels are deterministic: the same input produces the same bits on every platform, with or without SIMD hardware. Read more

Auto Trait Implementations§

§

impl Freeze for Jma

§

impl RefUnwindSafe for Jma

§

impl Send for Jma

§

impl Sync for Jma

§

impl Unpin for Jma

§

impl UnsafeUnpin for Jma

§

impl UnwindSafe for Jma

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.