Struct DayOfWeekProfile 

pub struct DayOfWeekProfile { /* private fields */ }

Mean bar return bucketed by local weekday (Monday 0 .. Sunday 6).

Each bar’s simple return close / previous_close - 1 is accumulated into the bucket of its local weekday (the wall-clock day of Candle::timestamp shifted by utc_offset_minutes), and the profile reports the running mean per weekday. The first bar produces no output.

Example

use wickra_core::{Candle, Indicator, DayOfWeekProfile};

let day = 24 * 3_600_000;
let mut prof = DayOfWeekProfile::new(0);
// 1970-01-01 was a Thursday (weekday 3).
assert!(prof.update(Candle::new(100.0, 100.0, 100.0, 100.0, 1.0, 0).unwrap()).is_none());
let out = prof.update(Candle::new(101.0, 101.0, 101.0, 101.0, 1.0, day).unwrap()).unwrap();
assert_eq!(out.bins.len(), 7);

Implementations

impl DayOfWeekProfile

pub const fn new(utc_offset_minutes: i32) -> Self

Construct a Day-of-Week Profile with the given UTC offset (minutes).

pub const fn utc_offset_minutes(&self) -> i32

Configured UTC offset in minutes.

pub fn value(&self) -> Option<&DayOfWeekProfileOutput>

Most recent profile if at least one return has been recorded.

Trait Implementations

impl Clone for DayOfWeekProfile

fn clone(&self) -> DayOfWeekProfile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DayOfWeekProfile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Indicator for DayOfWeekProfile

type Input = Candle

Type of one input data point (typically f64 for a price, or Candle / Tick).

type Output = DayOfWeekProfileOutput

Type of one output value.

fn update(&mut self, candle: Candle) -> Option<DayOfWeekProfileOutput>

Feed one new data point into the indicator and return the freshly computed output, or None if the indicator is still warming up.

fn reset(&mut self)

Reset all internal state, leaving the indicator equivalent to a freshly constructed instance with the same parameters.

fn warmup_period(&self) -> usize

Number of inputs required before the first non-None output can be produced.

fn is_ready(&self) -> bool

Whether the indicator has emitted at least one value since the last reset.

fn name(&self) -> &'static str

Stable, human-readable indicator name. Used by chaining and diagnostics.