pub struct BodySizePct { /* private fields */ }Expand description
Body Size Percent — the absolute body as a fraction of the bar’s range.
BodySizePct = |close − open| / (high − low)The result lives in [0, 1]: 1 is a full-bodied marubozu (the bar opened
at one extreme and closed at the other, no wicks), 0 a doji (open equals
close, the bar is all wick). It is the unsigned magnitude companion to
BalanceOfPower — where BoP keeps the direction,
this keeps only the conviction, which is exactly what candlestick body /
range filters key on. A zero-range bar carries no information and yields 0.
This is a stateless per-bar transform: every candle produces one value.
§Example
use wickra_core::{Candle, Indicator, BodySizePct};
let mut indicator = BodySizePct::new();
// body |12 - 10| = 2, range 14 - 10 = 4 -> 0.5.
let c = Candle::new(10.0, 14.0, 10.0, 12.0, 10.0, 0).unwrap();
assert!((indicator.update(c).unwrap() - 0.5).abs() < 1e-12);Implementations§
Source§impl BodySizePct
impl BodySizePct
Trait Implementations§
Source§impl Clone for BodySizePct
impl Clone for BodySizePct
Source§fn clone(&self) -> BodySizePct
fn clone(&self) -> BodySizePct
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 BodySizePct
impl Debug for BodySizePct
Source§impl Default for BodySizePct
impl Default for BodySizePct
Source§fn default() -> BodySizePct
fn default() -> BodySizePct
Returns the “default value” for a type. Read more
Source§impl Indicator for BodySizePct
impl Indicator for BodySizePct
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 BodySizePct
impl RefUnwindSafe for BodySizePct
impl Send for BodySizePct
impl Sync for BodySizePct
impl Unpin for BodySizePct
impl UnsafeUnpin for BodySizePct
impl UnwindSafe for BodySizePct
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