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

#include <DataNode.h>

Inheritance diagram for emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >:
emp::DataNodeModule< VAL_TYPE, MODS... >

Public Member Functions

 DataNodeModule ()
 
double GetTotal () const
 Get the sum of all values added to this DataNode since the last reset. More...
 
double GetMean () const
 Get the mean of all values added to this DataNode since the last reset. More...
 
double GetMin () const
 Get the min of all values added to this DataNode since the last reset. More...
 
double GetMax () const
 Get the max of all values added to this DataNode since the last reset. More...
 
void AddDatum (const VAL_TYPE &val)
 Add. More...
 
void Reset ()
 Reset DataNode, setting the running calucluations of total, min, mean, and max to 0. More...
 
void PrintDebug (std::ostream &os=std::cout)
 Print debug information (useful for figuring out which modifiers you included) More...
 

Protected Types

using this_t = DataNodeModule< VAL_TYPE, data::Range, MODS... >
 
using parent_t = DataNodeModule< VAL_TYPE, MODS... >
 
using base_t = DataNodeModule< VAL_TYPE >
 

Protected Attributes

double total
 Total of all data since last reset. More...
 
double min
 Smallest value passed in since last reset. More...
 
double max
 Largest value passed in since last reset. More...
 

Detailed Description

template<typename VAL_TYPE, emp::data... MODS>
class emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >

== data::Range == This module allows this DataNode to store information (min, max, mean, count, and total) about the distribution of the values that have been added since the last call to Reset().

Member Typedef Documentation

template<typename VAL_TYPE , emp::data... MODS>
using emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::base_t = DataNodeModule<VAL_TYPE>
protected
template<typename VAL_TYPE , emp::data... MODS>
using emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::parent_t = DataNodeModule<VAL_TYPE, MODS...>
protected
template<typename VAL_TYPE , emp::data... MODS>
using emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::this_t = DataNodeModule<VAL_TYPE, data::Range, MODS...>
protected

Constructor & Destructor Documentation

template<typename VAL_TYPE , emp::data... MODS>
emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::DataNodeModule ( )
inline

Member Function Documentation

template<typename VAL_TYPE , emp::data... MODS>
void emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::AddDatum ( const VAL_TYPE &  val)
inline

Add.

Parameters
valto this DataNode
template<typename VAL_TYPE , emp::data... MODS>
double emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::GetMax ( ) const
inline

Get the max of all values added to this DataNode since the last reset.

template<typename VAL_TYPE , emp::data... MODS>
double emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::GetMean ( ) const
inline

Get the mean of all values added to this DataNode since the last reset.

template<typename VAL_TYPE , emp::data... MODS>
double emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::GetMin ( ) const
inline

Get the min of all values added to this DataNode since the last reset.

template<typename VAL_TYPE , emp::data... MODS>
double emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::GetTotal ( ) const
inline

Get the sum of all values added to this DataNode since the last reset.

template<typename VAL_TYPE , emp::data... MODS>
void emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::PrintDebug ( std::ostream &  os = std::cout)
inline

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

template<typename VAL_TYPE , emp::data... MODS>
void emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::Reset ( )
inline

Reset DataNode, setting the running calucluations of total, min, mean, and max to 0.

Member Data Documentation

template<typename VAL_TYPE , emp::data... MODS>
double emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::max
protected

Largest value passed in since last reset.

template<typename VAL_TYPE , emp::data... MODS>
double emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::min
protected

Smallest value passed in since last reset.

template<typename VAL_TYPE , emp::data... MODS>
double emp::DataNodeModule< VAL_TYPE, data::Range, MODS... >::total
protected

Total of all data since last reset.


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