Modigliani  2.0
A stochastic simulator for axons, neurons, and networks
Public Member Functions | Friends | List of all members
modigliani_base::Sequential_statistics Class Reference

Sequential_statistics class. More...

+ Inheritance diagram for modigliani_base::Sequential_statistics:

Public Member Functions

 Sequential_statistics ()
 Create a Sequential_statistics.
 
virtual ~Sequential_statistics ()
 Desctructor.
 
void Reset ()
 Resets all values.
 
void Add (Real val)
 Adds a value and update all statistics. More...
 
Size counter () const
 Returns number of samples. More...
 
Real average () const
 Returns the average. More...
 
Real val_square_average () const
 Returns the sqaure average. More...
 
Real variance () const
 Returns the variance. More...
 
Real min () const
 Returns the minimum value. More...
 
Real max () const
 Returns the maximum value. More...
 

Friends

std::ostream & operator<< (std::ostream &str, const Sequential_statistics &self)
 Prints statistics. More...
 

Detailed Description

Sequential_statistics class.

Member Function Documentation

void modigliani_base::Sequential_statistics::Add ( Real  val)

Adds a value and update all statistics.

Parameters
valValue to add
Real modigliani_base::Sequential_statistics::average ( ) const
inline

Returns the average.

Returns
Average
Size modigliani_base::Sequential_statistics::counter ( ) const
inline

Returns number of samples.

Returns
Number of sample
Real modigliani_base::Sequential_statistics::max ( ) const
inline

Returns the maximum value.

Returns
Maximum value
Real modigliani_base::Sequential_statistics::min ( ) const
inline

Returns the minimum value.

Returns
Minimum value
Real modigliani_base::Sequential_statistics::val_square_average ( ) const
inline

Returns the sqaure average.

Returns
Square average
Real modigliani_base::Sequential_statistics::variance ( ) const
inline

Returns the variance.

Returns
Variance

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  str,
const Sequential_statistics self 
)
friend

Prints statistics.

Parameters
strostream to output into
self
Returns
ostream

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