Struct AccArray

pub struct AccArray<const S: bool, T: TraceValue, C: TraceCount, const N: usize>
where
    TDesc<S>: TArch,
{ /* private fields */ }

An AccArray can be used to accumulate the times taken to execute different branches of code, from a common start point. Each branch is allocated a different index into the AccArray. It can also count the entries.

The AccArray is generic on whether to use the CPU-specific architcture timer implementation, the value to accumulate times in (e.g. u64), the value to use to count occurrences (e.g. u32), and the number of trace points in the vec

The ‘start’ method is called first; when a branch completed it invokes the ‘acc_n’ method with its index, and the delta time since the start is added to that start’s accumulator.

Invoking the ‘acc_n’ method does not update the ‘start’ time, and it is quite sensible to issue multiple ‘acc’ invocations (with different index values) for a given ‘start’ invocation.

The ‘acc_n_restart’ method, though, performs the same accumulation and it does update the ‘start’ time; this can be used to accumulate elapsed time between stages.

An AccArray can be generated for any N, for an accumulator value of (), u8, u16, u32, u64, u128 and usize, and for a counter value of (), u8, u16, u32, u64, usize. If a value of () is used then the count or delta accumulator are effectively always 0.

Implementations

impl<const S: bool, T, C, const N: usize> AccArray<S, T, C, N>

where TDesc<S>: TArch, T: TraceValue, C: TraceCount,

pub fn clear(&mut self)

Clear the timer and accumulated values

pub fn start(&mut self)

Start the underlying timer

pub fn acc_n(&mut self, index: usize)

Add the ticks on exit to a specific region

pub fn acc_n_restart(&mut self, index: usize)

Add the ticks on exit to a specific region

pub fn accs(&self) -> &[T; N]

Return the accumulated values

pub fn cnts(&self) -> &[C; N]

Return the accumulated counts

Trait Implementations

impl<const S: bool, T: Debug + TraceValue, C: Debug + TraceCount, const N: usize> Debug for AccArray<S, T, C, N>

where TDesc<S>: TArch,

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

Formats the value using the given formatter.

impl<const S: bool, T, C, const N: usize> Default for AccArray<S, T, C, N>

where TDesc<S>: TArch, T: TraceValue, C: TraceCount, [T; N]: Default, [C; N]: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<const S: bool, T, C, const N: usize> Display for AccArray<S, T, C, N>

where TDesc<S>: TArch, T: TraceValue + Display + Div<C>, <T as Div<C>>::Output: Display, C: TraceCount + Display + PartialEq<C>, [T; N]: Default, [C; N]: Default,

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

Formats the value using the given formatter.