Struct PivotReversal 

pub struct PivotReversal { /* private fields */ }

Pivot Reversal — emits a reversal breakout signal when price closes through the most recently confirmed swing pivot.

pivot high: a bar whose high is strictly above the `left` bars before and the
            `right` bars after it (confirmed `right` bars late)
pivot low : the mirror on lows
signal = +1 when close crosses above the last confirmed pivot high
signal = −1 when close crosses below the last confirmed pivot low
signal =  0 otherwise

Unlike WilliamsFractals, which merely marks the swing points, Pivot Reversal turns them into an actionable entry: once a swing high is confirmed it becomes a breakout trigger — a close back above it signals a bullish reversal — and likewise a close below a confirmed swing low signals a bearish reversal. This is the logic of the classic “Pivot Reversal” strategy. Signals fire only on the crossing bar, not while price sits beyond the level.

The first signal can appear once left + right + 1 bars exist (a pivot needs neighbours on both sides). The output is +1 / 0 / −1. Each update is O(left + right).

Example

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

let mut indicator = PivotReversal::new(2, 2).unwrap();
let mut fired = false;
for i in 0..60 {
    let base = 100.0 + (f64::from(i) * 0.4).sin() * 5.0;
    let c = Candle::new(base, base + 1.0, base - 1.0, base, 1_000.0, 0).unwrap();
    match indicator.update(c) {
        Some(s) if s != 0.0 => fired = true,
        _ => {}
    }
}
let _ = fired;

Implementations

impl PivotReversal

pub fn new(left: usize, right: usize) -> Result<PivotReversal, Error>

Construct a Pivot Reversal with left bars before and right bars after the pivot.

Errors

Returns Error::PeriodZero if left or right is 0.

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

Configured (left, right) strengths.

pub const fn pivot_high(&self) -> Option<f64>

Most recent confirmed pivot-high level, if any.

pub const fn pivot_low(&self) -> Option<f64>

Most recent confirmed pivot-low level, if any.

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

Current value if available.

Trait Implementations

impl Clone for PivotReversal

fn clone(&self) -> PivotReversal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PivotReversal

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

Formats the value using the given formatter.

impl Indicator for PivotReversal

type Input = Candle

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

type Output = f64

Type of one output value.

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

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.