Skip to main content

Mama

Struct Mama 

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

Ehlers’ MESA Adaptive Moving Average (MAMA).

MAMA adapts its smoothing constant from the rate-of-change of price phase, derived via a truncated Hilbert transform — full math in “Cycle Analytics for Traders” (Ehlers 2013, ch. 8) and the original 2001 MESA paper.

The two-parameter (fast_limit, slow_limit) is the range over which the adaptive alpha can vary; defaults (0.5, 0.05) match the canonical EasyLanguage implementation. The companion FAMA is `mama * 0.5 * fast_limit

  • fama_prev * (1 - 0.5 * fast_limit)`, lagging MAMA so crossovers signal trend reversals.

The indicator emits both lines as a MamaOutput. Use the crate::Fama wrapper in this module to expose just the slow line if needed (e.g. for chaining).

§Example

use wickra_core::{Indicator, Mama};

let mut mama = Mama::new(0.5, 0.05).unwrap();
let mut last = None;
for i in 0..100 {
    last = mama.update(100.0 + (f64::from(i) * 0.2).sin() * 5.0);
}
assert!(last.is_some());

Implementations§

Source§

impl Mama

Source

pub fn new(fast_limit: f64, slow_limit: f64) -> Result<Self>

Construct with custom (fast_limit, slow_limit) adaptive alpha bounds.

§Errors

Returns Error::InvalidPeriod if either limit is outside (0, 1] or if slow_limit > fast_limit.

Source

pub fn classic() -> Self

Default (0.5, 0.05) parameters from Ehlers’ original publication.

Source

pub const fn limits(&self) -> (f64, f64)

Configured (fast_limit, slow_limit).

Source

pub const fn value(&self) -> Option<MamaOutput>

Current (mama, fama) pair if available.

Trait Implementations§

Source§

impl Clone for Mama

Source§

fn clone(&self) -> Mama

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 Mama

Source§

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

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

impl Indicator for Mama

Source§

type Input = f64

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

type Output = MamaOutput

Type of one output value.
Source§

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

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 Freeze for Mama

§

impl RefUnwindSafe for Mama

§

impl Send for Mama

§

impl Sync for Mama

§

impl Unpin for Mama

§

impl UnsafeUnpin for Mama

§

impl UnwindSafe for Mama

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.