pub struct StarcBands { /* private fields */ }Expand description
STARC Bands (Stoller Average Range Channel): a close-SMA centerline with bands sized by ATR.
middle = SMA(close, sma_period)
upper = middle + multiplier · ATR(atr_period)
lower = middle − multiplier · ATR(atr_period)STARC and Keltner share the same skeleton — moving
average plus an ATR offset — but Keltner’s centerline is an EMA of the
typical price while STARC uses an SMA of the close. The SMA gives a
flatter, less reactive midline that traders use to pick the larger swing
targets; Stoller’s reference parameters are SMA(6) over the close with
ATR(15) and a multiplier of 2.0.
§Example
use wickra_core::{Candle, Indicator, StarcBands};
let mut indicator = StarcBands::new(6, 15, 2.0).unwrap();
let mut last = None;
for i in 0..40 {
let base = 100.0 + f64::from(i);
let candle =
Candle::new(base, base + 2.0, base - 2.0, base + 1.0, 10.0, i64::from(i)).unwrap();
last = indicator.update(candle);
}
assert!(last.is_some());Implementations§
Source§impl StarcBands
impl StarcBands
Sourcepub fn new(
sma_period: usize,
atr_period: usize,
multiplier: f64,
) -> Result<Self>
pub fn new( sma_period: usize, atr_period: usize, multiplier: f64, ) -> Result<Self>
§Errors
Returns Error::PeriodZero / Error::NonPositiveMultiplier on
invalid inputs.
Sourcepub const fn parameters(&self) -> (usize, usize, f64)
pub const fn parameters(&self) -> (usize, usize, f64)
Configured (sma_period, atr_period, multiplier).
Trait Implementations§
Source§impl Clone for StarcBands
impl Clone for StarcBands
Source§fn clone(&self) -> StarcBands
fn clone(&self) -> StarcBands
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 StarcBands
impl Debug for StarcBands
Source§impl Indicator for StarcBands
impl Indicator for StarcBands
Source§type Input = Candle
type Input = Candle
Type of one input data point (typically
f64 for a price, or Candle / Tick).Source§type Output = StarcBandsOutput
type Output = StarcBandsOutput
Type of one output value.
Source§fn update(&mut self, candle: Candle) -> Option<StarcBandsOutput>
fn update(&mut self, candle: Candle) -> Option<StarcBandsOutput>
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 StarcBands
impl RefUnwindSafe for StarcBands
impl Send for StarcBands
impl Sync for StarcBands
impl Unpin for StarcBands
impl UnsafeUnpin for StarcBands
impl UnwindSafe for StarcBands
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