mewTyp-class: The state of the moving expanding window average

mewTyp-classR Documentation

The state of the moving expanding window average

Description

The class holds the current state of the moving expanding window (MEW) average

Details

The user should never create, update or access an instance of this class themselves. An instance of the class should be created with the function mewInit and updated with the functions mewAccum and mewMean. The user can extract the current value of the MEW average with the function mewGetMean, and print the first six elements of the mean vector to the screen with either the show or print functions.

Slots

i_new

(scalar integer) The index of the bin to add the current sample to

i_old

(scalar integer) The index of the bin to deweight

know_mean

(scalar integer) flag 0: mean not known 1: mean known

n_bin

(scalar integer) The number of bins to use in the MEW process

n_bin_use

(scalar integer) The number of bins currently in use

n_xx

(scalar integer) The length of a vector in the sequence being averaged

n_part

(scalar integer) The number of samples in the bins that are not being added to or deweighted

m_sample

(vector integer length - n_bin) The maximum number of samples allowed in each of the bins

n_sample

(vector integer length - n_bin) The number of samples currently in each bin

x_mean

(vector double length - n_xx) The current value of the MEW average (which is up-to-date only if know_mean == 1)

x_sum_part

(vector double length - n_xx) The sum in the bins not being added to or deweighted

xx

(matrix dimension - n_xx \times n_bin) The bin sums

ff

(scalar double) The fraction of samples to retain in the MEW average

ww

(scalar double) The factor of increase in the number of samples from one bin to the next

a_sample

(scalar double) The ideal number of samples in a bin (before rounding)


mewAvg documentation built on April 25, 2022, 5:07 p.m.