OpenNN  2.2
Open Neural Networks Library
Public Member Functions | Public Attributes | List of all members
OpenNN::Statistics< T > Struct Template Reference

#include <vector.h>

Public Member Functions

 Statistics (const T &, const T &, const T &, const T &)
 
virtual ~Statistics (void)
 
void set_minimum (const double &)
 
void set_maximum (const double &)
 
void set_mean (const double &)
 
void set_standard_deviation (const double &)
 
Vector< T > to_vector (void) const
 
void initialize_random (void)
 
bool has_minimum_minus_one_maximum_one (void)
 
bool has_mean_zero_standard_deviation_one (void)
 
void save (const std::string &file_name) const
 

Public Attributes

minimum
 
maximum
 
mean
 
standard_deviation
 

Detailed Description

template<class T>
struct OpenNN::Statistics< T >

This structure contains the simplest statistics for a set, variable, etc. It includes the minimum, maximum, mean and standard deviation variables.

Definition at line 57 of file vector.h.

Member Function Documentation

◆ has_mean_zero_standard_deviation_one()

template<class T >
bool OpenNN::Statistics< T >::has_mean_zero_standard_deviation_one ( void  )

Returns true if the mean value is 0 and the standard deviation value is 1, and false otherwise.

Definition at line 6414 of file vector.h.

◆ has_minimum_minus_one_maximum_one()

template<class T >
bool OpenNN::Statistics< T >::has_minimum_minus_one_maximum_one ( void  )

Returns true if the minimum value is -1 and the maximum value is +1, and false otherwise.

Definition at line 6401 of file vector.h.

◆ initialize_random()

template<class T >
void OpenNN::Statistics< T >::initialize_random ( void  )

Initializes the statistics structure with a random minimum (between -1 and 1), maximum (between 0 and 1), mean (between -1 and 1), standard deviation (between 0 and 1).

Definition at line 6391 of file vector.h.

◆ save()

template<class T >
void OpenNN::Statistics< T >::save ( const std::string &  file_name) const

Saves to a file the minimum, maximum, standard deviation, asymmetry and kurtosis values of the statistics structure.

Parameters
file_nameName of statistics data file.

Definition at line 6429 of file vector.h.

◆ set_maximum()

template<class T >
void OpenNN::Statistics< T >::set_maximum ( const double &  new_maximum)

Sets a new maximum value in the statistics structure.

Parameters
new_maximumMaximum value.

Definition at line 6352 of file vector.h.

◆ set_mean()

template<class T >
void OpenNN::Statistics< T >::set_mean ( const double &  new_mean)

Sets a new mean value in the statistics structure.

Parameters
new_meanMean value.

Definition at line 6359 of file vector.h.

◆ set_minimum()

template<class T >
void OpenNN::Statistics< T >::set_minimum ( const double &  new_minimum)

Sets a new minimum value in the statistics structure.

Parameters
new_minimumMinimum value.

Definition at line 6345 of file vector.h.

◆ set_standard_deviation()

template<class T >
void OpenNN::Statistics< T >::set_standard_deviation ( const double &  new_standard_deviation)

Sets a new standard deviation value in the statistics structure.

Parameters
new_standard_deviationStandard deviation value.

Definition at line 6368 of file vector.h.

◆ to_vector()

template<class T >
Vector< T > OpenNN::Statistics< T >::to_vector ( void  ) const

Returns all the statistical parameters contained in a single vector. The size of that vector is seven. The elements correspond to the minimum, maximum, mean and standard deviation values respectively.

Definition at line 6377 of file vector.h.


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