Empirical
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
emp::DataNodeModule< VAL_TYPE > Class Template Reference

Base form of DataNodeModule (available in ALL data nodes.) More...

#include <DataNode.h>

Public Types

using value_t = VAL_TYPE
 

Public Member Functions

 DataNodeModule ()
 
size_t GetCount () const
 Return the number of values that have been added to this node since the last reset. More...
 
size_t GetResetCount () const
 
double GetTotal () const
 
double GetMean () const
 
double GetMin () const
 
double GetMax () const
 
double GetVariance () const
 
double GetStandardDeviation () const
 
double GetSkew () const
 
double GetKurtosis () const
 
const std::string & GetName () const
 
const std::string & GetDescription () const
 
const std::string & GetKeyword () const
 
void SetName (const std::string &)
 
void SetDescription (const std::string &)
 
void SetKeyword (const std::string &)
 
void SetInfo (const std::string &, const std::string &_d="", const std::string &_k="")
 
void AddDatum (const VAL_TYPE &val)
 
void Reset ()
 
void PrintDebug (std::ostream &os=std::cout)
 Print debug information (useful for figuring out which modifiers you included) More...
 

Protected Member Functions

void PullData_impl ()
 

Protected Attributes

size_t val_count
 How many values have been loaded? More...
 
emp::vector< VAL_TYPE > in_vals
 What values are waiting to be included? More...
 

Detailed Description

template<typename VAL_TYPE>
class emp::DataNodeModule< VAL_TYPE >

Base form of DataNodeModule (available in ALL data nodes.)

Member Typedef Documentation

template<typename VAL_TYPE >
using emp::DataNodeModule< VAL_TYPE >::value_t = VAL_TYPE

Constructor & Destructor Documentation

template<typename VAL_TYPE >
emp::DataNodeModule< VAL_TYPE >::DataNodeModule ( )
inline

Member Function Documentation

template<typename VAL_TYPE >
void emp::DataNodeModule< VAL_TYPE >::AddDatum ( const VAL_TYPE &  val)
inline
template<typename VAL_TYPE >
size_t emp::DataNodeModule< VAL_TYPE >::GetCount ( ) const
inline

Return the number of values that have been added to this node since the last reset.

template<typename VAL_TYPE >
const std::string& emp::DataNodeModule< VAL_TYPE >::GetDescription ( ) const
inline
template<typename VAL_TYPE >
const std::string& emp::DataNodeModule< VAL_TYPE >::GetKeyword ( ) const
inline
template<typename VAL_TYPE >
double emp::DataNodeModule< VAL_TYPE >::GetKurtosis ( ) const
inline
template<typename VAL_TYPE >
double emp::DataNodeModule< VAL_TYPE >::GetMax ( ) const
inline
template<typename VAL_TYPE >
double emp::DataNodeModule< VAL_TYPE >::GetMean ( ) const
inline
template<typename VAL_TYPE >
double emp::DataNodeModule< VAL_TYPE >::GetMin ( ) const
inline
template<typename VAL_TYPE >
const std::string& emp::DataNodeModule< VAL_TYPE >::GetName ( ) const
inline
template<typename VAL_TYPE >
size_t emp::DataNodeModule< VAL_TYPE >::GetResetCount ( ) const
inline

If reset count not tracked, always return 0. If any modifier causes history to be saved, it will override this function and indicate how much history is stored.

template<typename VAL_TYPE >
double emp::DataNodeModule< VAL_TYPE >::GetSkew ( ) const
inline
template<typename VAL_TYPE >
double emp::DataNodeModule< VAL_TYPE >::GetStandardDeviation ( ) const
inline
template<typename VAL_TYPE >
double emp::DataNodeModule< VAL_TYPE >::GetTotal ( ) const
inline
template<typename VAL_TYPE >
double emp::DataNodeModule< VAL_TYPE >::GetVariance ( ) const
inline
template<typename VAL_TYPE >
void emp::DataNodeModule< VAL_TYPE >::PrintDebug ( std::ostream &  os = std::cout)
inline

Print debug information (useful for figuring out which modifiers you included)

template<typename VAL_TYPE >
void emp::DataNodeModule< VAL_TYPE >::PullData_impl ( )
inlineprotected
template<typename VAL_TYPE >
void emp::DataNodeModule< VAL_TYPE >::Reset ( )
inline
template<typename VAL_TYPE >
void emp::DataNodeModule< VAL_TYPE >::SetDescription ( const std::string &  )
inline
template<typename VAL_TYPE >
void emp::DataNodeModule< VAL_TYPE >::SetInfo ( const std::string &  ,
const std::string &  _d = "",
const std::string &  _k = "" 
)
inline
template<typename VAL_TYPE >
void emp::DataNodeModule< VAL_TYPE >::SetKeyword ( const std::string &  )
inline
template<typename VAL_TYPE >
void emp::DataNodeModule< VAL_TYPE >::SetName ( const std::string &  )
inline

Member Data Documentation

template<typename VAL_TYPE >
emp::vector<VAL_TYPE> emp::DataNodeModule< VAL_TYPE >::in_vals
protected

What values are waiting to be included?

template<typename VAL_TYPE >
size_t emp::DataNodeModule< VAL_TYPE >::val_count
protected

How many values have been loaded?


The documentation for this class was generated from the following file: