pub struct SessionVwap { /* private fields */ }Expand description
Volume-weighted average price reset at each local day boundary.
Each bar contributes its typical price (high + low + close) / 3 weighted by
volume. The running VWAP is Σ(typical · volume) / Σ volume over the current
session; if the session’s volume is still zero the indicator falls back to the
latest typical price so the output is always finite. The session boundary is
the wall-clock day of Candle::timestamp shifted by
utc_offset_minutes.
Where crate::RollingVwap averages over a fixed bar window and
crate::AnchoredVwap anchors at a caller-chosen bar, Session VWAP anchors
at the automatically detected day open.
§Example
use wickra_core::{Candle, Indicator, SessionVwap};
let hour = 3_600_000;
let mut vwap = SessionVwap::new(0);
// typical = 100, volume 10.
vwap.update(Candle::new(100.0, 100.0, 100.0, 100.0, 10.0, 0).unwrap());
// typical = 110, volume 30 -> VWAP = (100*10 + 110*30) / 40 = 107.5.
let v = vwap.update(Candle::new(110.0, 110.0, 110.0, 110.0, 30.0, hour).unwrap()).unwrap();
assert!((v - 107.5).abs() < 1e-9);Implementations§
Source§impl SessionVwap
impl SessionVwap
Trait Implementations§
Source§impl Clone for SessionVwap
impl Clone for SessionVwap
Source§fn clone(&self) -> SessionVwap
fn clone(&self) -> SessionVwap
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 SessionVwap
impl Debug for SessionVwap
Source§impl Indicator for SessionVwap
impl Indicator for SessionVwap
Source§type Input = Candle
type Input = Candle
Type of one input data point (typically
f64 for a price, or Candle / Tick).Source§fn update(&mut self, candle: Candle) -> Option<f64>
fn update(&mut self, candle: Candle) -> 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 SessionVwap
impl RefUnwindSafe for SessionVwap
impl Send for SessionVwap
impl Sync for SessionVwap
impl Unpin for SessionVwap
impl UnsafeUnpin for SessionVwap
impl UnwindSafe for SessionVwap
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