Struct Vortex 

pub struct Vortex { /* private fields */ }

Vortex Indicator — Botes & Siepman’s pair of oscillators (VI+, VI−) that capture the relationship between two consecutive bars.

Two “vortex movements” measure how far price travelled against the opposite extreme of the previous bar; each is normalised by the summed true range:

VM+_t = |high_t − low_{t−1}|
VM−_t = |low_t  − high_{t−1}|
VI+   = Σ VM+ over n / Σ TR over n
VI−   = Σ VM− over n / Σ TR over n

VI+ crossing above VI− is a bullish signal, the reverse a bearish one; the wider the gap, the stronger the trend. A fully flat window (zero true range) reports (0, 0).

Example

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

let mut indicator = Vortex::new(14).unwrap();
let mut last = None;
for i in 0..80 {
    let base = 100.0 + i as f64;
    let candle =
        Candle::new(base, base + 2.0, base - 2.0, base + 1.0, 10.0, i64::from(i)).unwrap();
    last = indicator.update(candle);
}
assert!(last.is_some());

Implementations

impl Vortex

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

Construct a new Vortex Indicator with the given period.

Errors

Returns Error::PeriodZero if period == 0.

pub const fn period(&self) -> usize

Configured period.

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

Current value if available.

Trait Implementations

impl Clone for Vortex

fn clone(&self) -> Vortex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vortex

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

Formats the value using the given formatter.

impl Indicator for Vortex

type Input = Candle

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

type Output = VortexOutput

Type of one output value.

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

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.