Struct Alligator 

pub struct Alligator { /* private fields */ }

Bill Williams’ Alligator: three SMMAs of the median price (high + low) / 2 with different periods. Classic parameters are (jaw = 13, teeth = 8, lips = 5).

The original chart variant additionally shifts each line forward by a fixed number of bars for display (Jaw +8, Teeth +5, Lips +3). Wickra publishes the unshifted SMMA values — the consumer can apply the visual shift on the chart side. The indicator emits values once all three SMMAs have warmed up, i.e. after max(jaw, teeth, lips) = jaw candles.

Reference: Bill Williams, Trading Chaos, 1995.

Example

use wickra_core::{Alligator, Candle, Indicator};

let mut alligator = Alligator::classic();
let mut last = None;
for i in 0..40 {
    let base = 100.0 + f64::from(i);
    let candle =
        Candle::new(base, base + 1.0, base - 1.0, base, 1.0, i64::from(i)).unwrap();
    last = alligator.update(candle);
}
assert!(last.is_some());

Implementations

impl Alligator

pub fn new( jaw_period: usize, teeth_period: usize, lips_period: usize, ) -> Result<Self>

Errors

Returns Error::PeriodZero if any period is zero.

pub fn classic() -> Self

Bill Williams’ classic parameters: (jaw = 13, teeth = 8, lips = 5).

pub const fn periods(&self) -> (usize, usize, usize)

Configured (jaw_period, teeth_period, lips_period).

Trait Implementations

impl Clone for Alligator

fn clone(&self) -> Alligator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Alligator

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

Formats the value using the given formatter.

impl Indicator for Alligator

type Input = Candle

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

type Output = AlligatorOutput

Type of one output value.

fn update(&mut self, candle: Candle) -> Option<AlligatorOutput>

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

fn reset(&mut self)

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

fn warmup_period(&self) -> usize

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

fn is_ready(&self) -> bool

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

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

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