Struct WinRate 

pub struct WinRate { /* private fields */ }

Win Rate — the fraction of strictly-positive returns among the last period returns, in [0, 1].

WinRate = #(rᵢ > 0) / period

Feed a stream of per-trade or per-bar returns (or PnL); the indicator reports the rolling hit rate. A return of exactly 0 is treated as a non-win (a flat / scratch), so WinRate is the share of the window that strictly made money — the most basic performance statistic and a building block for Expectancy, Kelly sizing, and confidence filters.

Each update is O(1): the count of wins in the window is maintained incrementally.

Example

use wickra_core::{Indicator, WinRate};

let mut indicator = WinRate::new(4).unwrap();
// returns: +, -, +, +  -> 3 of 4 win -> 0.75.
let out = indicator.batch(&[1.0, -1.0, 2.0, 1.0]);
assert_eq!(out[3], Some(0.75));

Implementations

impl WinRate

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

Construct a new Win Rate over the given window.

Errors

Returns Error::PeriodZero if period == 0.

pub const fn period(&self) -> usize

Configured period.

Trait Implementations

impl Clone for WinRate

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WinRate

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

Formats the value using the given formatter.

impl Indicator for WinRate

type Input = f64

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, ret: f64) -> Option<f64>

Feed one new data point into the indicator and return the freshly computed output, or None if there is no value for this input.

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.

fn batch_nan_into(&mut self, inputs: &[Self::Input], out: &mut [f64])

where Self::Input: Copy, Self::Output: Into<f64>,

Run the indicator over inputs, writing one output per input into the caller-owned out buffer (NaN where update returns None). It exists for every indicator whose output converts to an f64; the batch pipelines use it for the scalar f64 -> f64 ones.

fn batch_fast_into(&mut self, inputs: &[Self::Input], out: &mut [f64])

where Self::Input: Copy, Self::Output: Into<f64>,

Opt-in fast batch: like batch_nan_into, but an indicator with a vectorised kernel may reassociate its arithmetic to run it in SIMD lanes. Each value then agrees with the exact batch to within the tolerance the indicator documents (a few units in the last place), not bit for bit; warmup positions, NaN placement and the output length are identical. The kernels are deterministic: the same input produces the same bits on every platform, with or without SIMD hardware.