Struct Ichimoku 

pub struct Ichimoku { /* private fields */ }

Ichimoku Kinko Hyo indicator.

Standard parameters are (9, 26, 52, 26). The first fully-populated output (every field Some) appears after senkou_b_period + displacement - 1 candles — 77 bars at the defaults — because Senkou B needs its own 52-bar midpoint and a 26-bar history of those midpoints to displace from.

Example

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

let mut ichi = Ichimoku::classic();
for i in 0..120 {
    let p = 100.0 + f64::from(i);
    let candle = Candle::new(p, p + 2.0, p - 2.0, p + 1.0, 0.0, i64::from(i)).unwrap();
    ichi.update(candle);
}
let out = ichi.value().unwrap();
assert!(out.tenkan.is_some() && out.kijun.is_some());
assert!(out.senkou_a.is_some() && out.senkou_b.is_some());
assert!(out.chikou.is_some());

Implementations

impl Ichimoku

pub fn new( tenkan_period: usize, kijun_period: usize, senkou_b_period: usize, displacement: usize, ) -> Result<Self>

Construct an Ichimoku indicator with custom periods.

tenkan_period is the short midpoint window (default 9), kijun_period the medium (default 26), senkou_b_period the long (default 52), and displacement the forward/backward shift in bars (default 26).

Errors

Returns Error::PeriodZero if any of tenkan_period, kijun_period, senkou_b_period, or displacement is zero, and Error::InvalidPeriod if the periods are not in strictly increasing order (tenkan < kijun < senkou_b).

pub fn classic() -> Self

Classical (9, 26, 52, 26) configuration.

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

Configured periods as (tenkan, kijun, senkou_b, displacement).

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

Most recent output if at least one bar has been consumed.

Trait Implementations

impl Clone for Ichimoku

fn clone(&self) -> Ichimoku

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ichimoku

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

Formats the value using the given formatter.

impl Indicator for Ichimoku

type Input = Candle

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

type Output = IchimokuOutput

Type of one output value.

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

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.