pub struct OIWeighted { /* private fields */ }Expand description
Open-Interest-Weighted Price — the running mean mark price, weighting each tick by its open interest.
oiWeighted = Σ(markPrice · openInterest) / Σ openInterestWhere a plain mean treats every tick equally, the OI-weighted price pulls
toward the levels at which the most contracts were actually outstanding — the
price the bulk of open positioning sits around, a fair-value anchor for
liquidations and mean-reversion. The accumulation runs from construction;
call reset at each session boundary to re-anchor. Until any open interest
has accrued the indicator returns the current mark price.
Input = DerivativesTick, Output = f64. Ready after the first tick.
§Example
use wickra_core::{DerivativesTick, Indicator, OIWeighted};
fn tick(mark: f64, oi: f64) -> DerivativesTick {
DerivativesTick::new(0.0, mark, mark, mark, oi, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0)
.unwrap()
}
let mut oiw = OIWeighted::new();
assert_eq!(oiw.update(tick(100.0, 10.0)), Some(100.0));
// (100·10 + 110·30) / (10 + 30) = 4300 / 40 = 107.5.
assert_eq!(oiw.update(tick(110.0, 30.0)), Some(107.5));Implementations§
Source§impl OIWeighted
impl OIWeighted
Trait Implementations§
Source§impl Clone for OIWeighted
impl Clone for OIWeighted
Source§fn clone(&self) -> OIWeighted
fn clone(&self) -> OIWeighted
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 OIWeighted
impl Debug for OIWeighted
Source§impl Default for OIWeighted
impl Default for OIWeighted
Source§fn default() -> OIWeighted
fn default() -> OIWeighted
Returns the “default value” for a type. Read more
Source§impl Indicator for OIWeighted
impl Indicator for OIWeighted
Source§type Input = DerivativesTick
type Input = DerivativesTick
Type of one input data point (typically
f64 for a price, or Candle / Tick).Source§fn update(&mut self, tick: DerivativesTick) -> Option<f64>
fn update(&mut self, tick: DerivativesTick) -> 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.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 OIWeighted
impl RefUnwindSafe for OIWeighted
impl Send for OIWeighted
impl Sync for OIWeighted
impl Unpin for OIWeighted
impl UnsafeUnpin for OIWeighted
impl UnwindSafe for OIWeighted
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