Cosan::SummaryStatistics< NumericType > Class Template Reference

Class for statistics results. More...

#include <statistics.h>

Inheritance diagram for Cosan::SummaryStatistics< NumericType >:

Public Member Functions
	SummaryStatistics ()
CosanMatrix< NumericType > &	GetSampleCovariance (const CosanMatrix< NumericType > &X)
NumericType	GetMean (const CosanMatrix< NumericType > &X)
NumericType	GetVar (const CosanMatrix< NumericType > &X)
NumericType	GetMedian (const CosanMatrix< NumericType > &X)
NumericType	GetMax (const CosanMatrix< NumericType > &X)
NumericType	GetMin (const CosanMatrix< NumericType > &X)
Public Member Functions inherited from Cosan::Evaluation
	Evaluation ()
Public Member Functions inherited from Cosan::CosanBO
	CosanBO ()
	Default constructor. More...
virtual const std::string	GetName () const
	Get the name of the objects. More...

Public Attributes
CosanMatrix< NumericType >	SampleCovariance
NumericType	mean
NumericType	variance
NumericType	median
NumericType	maxNum
NumericType	minNum

Detailed Description

template<Numeric NumericType>
class Cosan::SummaryStatistics< NumericType >

Class for statistics results.

calculate SampleCovariance, mean, variance, median, maxNum, minNum;

CosanMatrix<NumericType> & GetSampleCovariance(const CosanMatrix<NumericType> & X) 

NumericType GetMean(const CosanMatrix<NumericType> & X) 

NumericType GetVar(const CosanMatrix<NumericType> & X) 

NumericType GetMedian(const CosanMatrix<NumericType> & X) 

NumericType GetMax(const CosanMatrix<NumericType> & X) 

NumericType GetMin(const CosanMatrix<NumericType> & X) 

Definition at line 21 of file statistics.h.

Constructor & Destructor Documentation

SummaryStatistics()

template<Numeric NumericType>

Cosan::SummaryStatistics< NumericType >::SummaryStatistics ( )

inline

Definition at line 23 of file statistics.h.

:Evaluation(){}

Member Function Documentation

GetMax()

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::GetMax ( const CosanMatrix< NumericType > &  X )

inline

Definition at line 64 of file statistics.h.

                                                                  {
                if (X.rows()>1 && X.cols()>1){
                    fmt::print("Variance is not defined in matrix! Calculate the minimum of all entries!");
                }
                maxNum = X.maxCoeff();
                return maxNum;
            }

GetMean()

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::GetMean ( const CosanMatrix< NumericType > &  X )

inline

Definition at line 32 of file statistics.h.

                                                                   {
                if (X.rows()>1 && X.cols()>1){
                    fmt::print("Mean is not defined in matrix! Calculate the mean of all entries!");
                }
                mean = X.mean();
                return mean;
            }

GetMedian()

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::GetMedian ( const CosanMatrix< NumericType > &  X )

inline

Definition at line 47 of file statistics.h.

                                                                     {
                if (X.rows()>1 && X.cols()>1){
                    fmt::print("Median is not defined in matrix! Calculate the median of all entries!");
                }
                std::vector<NumericType> X_copy(X.data(),X.data()+X.size());
                if(X_copy.size()%2==0){
                    std::nth_element(X_copy.data(), X_copy.data() + X_copy.size()/2, X_copy.data()+X_copy.size());
                    std::nth_element(X_copy.data(), X_copy.data() + X_copy.size()/2-1, X_copy.data()+X_copy.size());
                    median = (*(X_copy.data()+X_copy.size()/2)+*(X_copy.data()+X_copy.size()/2-1))/2;
                }
                else{
                    std::nth_element(X_copy.data(), X_copy.data() + (X_copy.size()-1)/2, X_copy.data()+X_copy.size());
                    median = *(X_copy.data() + (X_copy.size()-1)/2);
                }
                return median;
            }

GetMin()

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::GetMin ( const CosanMatrix< NumericType > &  X )

inline

Definition at line 71 of file statistics.h.

                                                                  {
                if (X.rows()>1 && X.cols()>1){
                    fmt::print("Variance is not defined in matrix! Calculate the minimum of all entries!");
                }
                minNum = X.minCoeff();
                return minNum;
            }

GetSampleCovariance()

template<Numeric NumericType>

CosanMatrix<NumericType>& Cosan::SummaryStatistics< NumericType >::GetSampleCovariance ( const CosanMatrix< NumericType > &  X )

inline

Definition at line 24 of file statistics.h.

                                                                                              :{
                if (X.rows()<=1){
                    fmt::print("Input must have more than 1 row!")
                    throw SmallRows;
                }
                CosanMatrix<NumericType> centered = X.rowwise() - X.colwise().mean();
                SampleCovariance = (centered.adjoint() * centered) / double(X.rows() - 1);
                return SampleCovariance}

GetVar()

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::GetVar ( const CosanMatrix< NumericType > &  X )

inline

Definition at line 39 of file statistics.h.

                                                                  {
                if (X.rows()>1 && X.cols()>1){
                    fmt::print("Variance is not defined in matrix! Calculate the variance of all entries!");
                }
                variance = std::sqrt((X.array() - X.mean()).square().sum()/(X.size()-1));
                return variance;
            }

Member Data Documentation

maxNum

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::maxNum

Definition at line 83 of file statistics.h.

mean

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::mean

Definition at line 80 of file statistics.h.

median

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::median

Definition at line 82 of file statistics.h.

minNum

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::minNum

Definition at line 84 of file statistics.h.

SampleCovariance

template<Numeric NumericType>

CosanMatrix<NumericType> Cosan::SummaryStatistics< NumericType >::SampleCovariance

Definition at line 79 of file statistics.h.

variance

template<Numeric NumericType>

NumericType Cosan::SummaryStatistics< NumericType >::variance

Definition at line 81 of file statistics.h.

---

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

• cosan/evaluation/statistics.h