pub struct DrawdownDuration { /* private fields */ }Expand description
Cumulative drawdown duration in bars.
Each update receives one equity-curve sample. The indicator tracks the
running all-time peak seen since construction (or last reset) and
reports how many bars have elapsed since that peak was set:
peak_t = max(input over [0..=t])
duration_t = bars elapsed since peak_t was first setA new peak resets the duration to 0. As long as the series stays under
water the duration grows linearly with each bar.
The indicator emits a value on every bar (no warmup beyond the first
input) and runs in O(1) per update.
§Example
use wickra_core::{DrawdownDuration, Indicator};
let mut dd = DrawdownDuration::new();
assert_eq!(dd.update(100.0), Some(0)); // first bar -> new peak
assert_eq!(dd.update(95.0), Some(1)); // 1 bar under water
assert_eq!(dd.update(90.0), Some(2)); // 2 bars under water
assert_eq!(dd.update(110.0), Some(0)); // new peak -> resetImplementations§
Trait Implementations§
Source§impl Clone for DrawdownDuration
impl Clone for DrawdownDuration
Source§fn clone(&self) -> DrawdownDuration
fn clone(&self) -> DrawdownDuration
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for DrawdownDuration
impl Debug for DrawdownDuration
Source§impl Default for DrawdownDuration
impl Default for DrawdownDuration
Source§fn default() -> DrawdownDuration
fn default() -> DrawdownDuration
Returns the “default value” for a type. Read more
Source§impl Indicator for DrawdownDuration
impl Indicator for DrawdownDuration
Source§fn update(&mut self, input: f64) -> Option<u32>
fn update(&mut self, input: f64) -> Option<u32>
Feed one new data point into the indicator and return the freshly computed
output, or
None if the indicator is still warming up.Source§fn reset(&mut self)
fn reset(&mut self)
Reset all internal state, leaving the indicator equivalent to a freshly
constructed instance with the same parameters.
Source§fn warmup_period(&self) -> usize
fn warmup_period(&self) -> usize
Number of inputs required before the first non-
None output can be produced.Auto Trait Implementations§
impl Freeze for DrawdownDuration
impl RefUnwindSafe for DrawdownDuration
impl Send for DrawdownDuration
impl Sync for DrawdownDuration
impl Unpin for DrawdownDuration
impl UnsafeUnpin for DrawdownDuration
impl UnwindSafe for DrawdownDuration
Blanket Implementations§
Source§impl<T> BatchExt for Twhere
T: Indicator,
impl<T> BatchExt for Twhere
T: Indicator,
Source§fn batch(&mut self, inputs: &[Self::Input]) -> Vec<Option<Self::Output>>
fn batch(&mut self, inputs: &[Self::Input]) -> Vec<Option<Self::Output>>
Run the indicator over a slice of inputs in order, returning one output (or
None during warmup) per input.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more