emergent 8.2.2 Average Class Reference
emergent 8.2.2   Home · Wiki Docs For: Average · Emergent Help Browser 

Average Class Reference

encapsulates the sum and count values for computing an average value in an incremental fashion over time

See for more info: Wiki Docs For: Average

 #include <Average>

defined at: /mnt/ssd/grey/local/include/Emergent/Average.h :28-71

Inherits From: taOBase, taBase

Inherited By: Average*, Average&, const Average

Index: SubTypes, Members, Methods, Static Members, Static Methods, Expert Members, Expert Methods

Sub Types


SubType Documentation


Regular (preferred) Member and Method Documentation

Members

Member Category: _NoCategory

Methods

Method Category: Average

Method Category: UserData

Method Category: _NoCategory


Member Documentation

Member Category: _NoCategory

Average::avg : float

the computed average value that was last computed, as sum / n -- this may not reflect current sum, n values -- just depends on when GetAvg was computed -- see UpdtAvg versions of increment methods

Average::n : int

the number of values accumulated since last reset

Average::sum : float

overall sum of values accumulated since last reset


Method Documentation

Method Category: Average

float Average::GetAvg ( )

compute the average as sum / n, update the avg member to store this value, and return it

Show Source Code

float Average::GetAvg_Reset ( )

compute the average as sum / n, update the avg member to store this value, and return it -- also reset sum, n counters for next time

Show Source Code

void Average::Increment ( float val )

increment the sum by given value, and n by one count

Show Source Code

float Average::IncrementAvg ( float val )

increment the sum by given value, and n by one count, and return new average value (updates avg field)

Show Source Code

void Average::IncrementN ( float val, int n_new )

increment the sum by given value, and n by given count -- for a batch update of multiple items

Show Source Code

float Average::IncrementNAvg ( float val, int n_new )

increment the sum by given value, and n by given count, and return new average value (updates avg field)

Show Source Code

void Average::ResetAvg ( )

reset the sum and n accumulation variables, and the computed average value

Show Source Code

void Average::ResetSum ( )

reset the sum and n accumulation variables

Show Source Code

Method Category: UserData

void taOBase::RemoveAllUserData ( )

get rid of our user data list entirely -- this is done automatically when saving something that has no user data items, but you can also force it with this method -- deletes the whole list

Show Source Code

Method Category: _NoCategory

taBase* taOBase::GetOwner ( )

Show Source Code

TypeDef* Average::GetTypeDef ( )

Show Source Code

taSigLink** taOBase::addr_sig_link ( )

Show Source Code

Static Member and Method Documentation

Static Members

Static Methods


Static Method Documentation


Expert Member and Method Documentation

Expert Members

Expert Member Category: taBase

Expert Methods

Expert Method Category: UserData


Expert Member Documentation

Expert Member Category: taBase

taOBase::owner : taBase*

pointer to owner

taOBase::user_data_ : UserDataItem_List*

storage for user data (created if needed) DO NOT ACCESS this list directly -- use the GetUserData / SetUserData etc interface!


Expert Method Documentation

Expert Method Category: UserData

UserDataItem_List* taOBase::GetUserDataList ( bool force = false )

gets the userdatalist for this class

Show Source Code


Copyright © 2017Regents of the University of Colorado, Carnegie Mellon University, Princeton University.
emergent 8.2.2